|
Date |
Version |
Comments |
|---|---|---|
|
11/6/07 |
0.5 |
Paul Kasper. Initial Draft |
|
11/28/07 |
0.6 |
Paul Kasper. Added Gregor's comments. |
|
02/06/08 |
0.7 |
Barbara Higgins. Added schedule for delivering documents. |
|
02/19/08 |
0.8 |
Barbara Higgins. Combined Config Guide and API Guide, added part number, removed BUI deliverable |
|
02/27/08 |
1.0 |
Barbara Higgins. Added screencast and manpage info and contacts |
|
04/06/08 |
1.1 |
Barbara Higgins. Revised to add specific information about deliverables. Removed API risk. |
Please send comments on this plan to barbara.e.higgins@sun.com
The Sun Media Management System (MMS) is based on IEEE standard 1244, Media Management System (MMS) which defines a set of commands for managing media, the Media Management Protocol (MMP). MMS is software that manages removable media and drives in robotic libraries.
The principal function of Sun's MMS implementation is to be a mounting service and a uniform interface for client applications in a distributed environment. Client applications interact with MMS, which in turn, interacts with the removable media archive. Client applications do not have to have different code to use different types of drives. One version of tape processing code will work for all device types.
Sun's MMS simplifies the MMP commands, presenting their functions through two interfaces: a management interface consisting of two Solaris commands whose options provide the most frequently-used MMP operations and an API consisting of 30+ commands that package the MMP commands with support for connection protocols.
The first client application is intended to be ADM. The MMS 1.0 will interface to the Sun Library Manager (formerly StorageTek ACSLS), through which it manages the tape archive as the removable media. Users of ADM can manage tapes in the tape archive through the intermediary, MMS 1.0.
The MMS documentation is written assuming that the reader has a good understanding of Solaris and storage administration. Potential audience members for MMS documentation:
Sun external customers:
System administrators who are configuring a client application such as Sun's ADM or are installing MMS for use by a custom client application.
Sun internal customers who need to connect ADM to MMS or to connect MMS to the Storage Library Manager:
Trained service providers
SSEs
Professional Services
System Administrators
The following tables contain contact details for people in the extended product release team.
|
Contact |
Role |
|---|---|
|
Kelly Silverthorne |
Product Program Manager |
|
Gregory Matthews |
SAM-QFS PDE Engineering Manager |
|
Paul Cheng |
Lead Engineer |
|
Ken Davis |
GUI Development |
|
Diana Flury |
PDE RE Engineering |
|
John Hilgers |
FVT Manager |
|
Elisa Heffernan |
FVT Test Lead |
|
Margaret Hamburger |
Product Marketing Manager |
|
Cindy Cuevas |
L10N Project Manager |
|
Melinda Paterson |
Sun Services |
|
file:///C:/Documents%20and%20Settings/Barbara/My%20Documents/ADM_Pteam@sun.com |
ADM/MMS Product Team |
The following tables list the documentation/training deliverables for MMS release. These deliverables were derived from the following specification documents:
MMS Management CLI spec - version 0.5
MMS FSD, version 0.8
Note: This section provides as much information as is available when this document is submitted for approval by the Product team (or equivalent).
|
Document |
Description |
Delivery |
Resource |
|---|---|---|---|
|
mms_init man page mms_adm man page mms_client man page mmsexplorer man page |
The man pages for the management commands:
|
Type: New Section: 1 and 1M Est. Page Count: 10 Format: SGML (Epic) Published: Build 92 |
Terry Gibson RFE 6668524 |
|
Man pages for C library functions |
Developers use C library functions as an API so that they can customize a client application for operations not supported in the management commands. |
Type: New Section: 3 Est. Page Count: 30 Format: SGML (Epic) Published: Build 92 |
Doug Stevenson RFE 6668537 |
|
MMS Configuration and Administration Guide |
This document describes the MMS architecture and how to install, configure, and manage MMS using both the management CLI and the MMS_API. |
Type: New Est. Page Count: 150 Format: SGML (Epic) for HTML and PDF Published: Administration collection of Developers Express |
Barbara Higgins |
|
MMS Troubleshooting Guide Part #: tbd |
This document describes how to diagnose and resolve issues with MMS, including disaster recovery issues as described in the FSD. |
Type: New Format: wiki via wikis.sun.com |
Barbara Higgins with Engineering |
|
Rich media demo |
Convert the existing demo to a rich media format (screencast):
|
Type: New Est. Screen count: 10 Format: Comtasia |
Barbara Higgins Damon Kujawa ArtQuest TI8723 |
|
OpenSolaris Project Page |
Contribute to updated and relevant information on the project page to promote community awareness, adoption, and participation of MMS. Add content to the Documentation subpage of the project page. |
http://www.opensolaris.org/os/project/mms/ |
Barbara Higgins |
The following estimates are subject to a number of factors, but it's a broad estimate of the work that is required. This estimate is only for the Administration Guide, which is the bulk of the work.
Approx. 40 tasks x 2 pages per task = 80 pages
Approx. 5 conceptual (Component) areas x 10 pages per area = 50 pages
130 pages X 4 Hours/Page = 600 hours = 13 weeks = 3-4 months
This project does require a beta delivery.
On the MM:
Start, stop, or restart MM
Modify MM configurations
Establish passwords for LM/DM, establish connections to LM/DM
Client and Application registration
Password management and access to Postgres Database, Set up database parameters
On other hosts:
Enable daemon process
Set up communication with the MM
Add client
Add/Delete/Modify library
Add/Delete/Modify drive (share, change drive physical mappings etc.)
Change state of a drive - Set the drive or library to be in-operational
Create/Delete a media pool, Manage media in a pool
Mount media - load a media into a drive
Unmount media - unload a media from a drive
Export media - remove a media from MM
Accept request
Cancel request
List libraries
List drives
List pools
List outstanding requests
List media by filter criteria (usage, status, media type, library, pool)
List MM status
List resources used by current application
List messages
This section highlights the measures taken to ensure the quality of the content delivered as part of this project.
The information quality is tied to the following requirements from engineering:
Timely notification to technical writer of new RFEs or information for the release
Updated wikis and specs
Timely and thorough reviews
The content created in this project will be tested by the test group during the FVT testing. Draft documentation will be made available at the start of the FVT.
The content created in this project will be reviewed. It is important that the review is not the first contact that the contact creator has with the reviewers. To reach the review stage, the content creator has to receive information from all the information sources.
The content created in this project will be edited by IPG production team.
Content bugs and bugs affecting content will be tracked in Bugster, using the mms/software/* categories.
This section provides a high-level view of the production process used to create the deliverables of this project.
Composition Tools: The content is created using text editors and Epic's Framemaker+SGML editor. The screencast will be created in Comtasia.
Editorial Guidelines: The content created as part of this project will comply with Sun's editorial guidelines.
Illustration Guidelines: The illustrations and graphics created as part of this project will comply with Sun's graphic guidelines.
Trademarks: All Sun and third-party trademarks will be documented in accordance with the information provided by the TMARK tool.
Archiving: After revenue release, writers and content-developers will archive content files in pubstool2.
508 Requirements
[x] The content
delivered in this project will comply with the Sun's current
guidelines for 508 requirements.
[ ] The content delivered in
this project does not apply Sun's current guidelines for 508
requirements.
This section provides high-level information about the Information Product resources required for this project.
|
Role |
Resource Estimate |
Resource Assigned |
|---|---|---|
|
Doc Lead |
This project will require a part-time lead, 10% |
Paul Kasper |
|
Writer |
This project will require a 1/2 writer. |
Barbara Higgins |
|
Media Designer |
This project will required a part-time media designer |
Damon Kujawa |
All documentation deliverables for this project will be translated after the RR date, including the help files saved as a book. The Help book may be sent to L10N earlier since it must be delivered to the code earlier than RR.
Since the troubleshooting information is being moved to a wiki, the information cannot be translated using the typical process. However, the current L10N big rules states that troubleshooting information does not need to be translated. So, a waiver should not be needed.
Wiki - The product team needs to decide on which wiki to use for the troubleshooting information.
Engineering Time - Beyond the standard reviews, the engineering, RPE, and PTS teams will be responsible for writing and updating the troubleshooting information on the wiki. The engineering team is also responsible for updating the man pages. In both cases, the writer will be responsible for reviewing this work as needed, but the writer is not the main contributor.
Translated Troubleshooting Information - If we move the troubleshooting information to the wiki, it falls outside the current L10N process for translation. If the P-team decides that the troubleshooting information must be translated, we need to resolve this issue.
General Issues/Risks
Design/Functional Specs - These documents must be provided by the engineering development team and maintained to reflect design changes that occur as the development cycle evolves. Any changes to the product design might have an impact on the schedule of deliverables.
Prototype Availability - Stable prototypes must be available in time for the Information Products team to test their deliverables.
Timely Reviews - Reviewers must return comments in a timely fashion. Members of the Information Products team will contact individual reviewers to schedule focused reviews and notify reviewers of upcoming reviews.
UI/Functionality Freeze - At a point, all user interfaces, APIs, configuration files, and command-line utilities, must be frozen, and the freeze date must be adhered to. This freeze point must be early enough in the project schedule to give writers and content developers time to accurately capture the state of the product at time of freeze.
Product Release Schedule - If the product release schedule changes, this change will have an impact on the schedule for Information Product deliverables.
Hardware/Software- Availability of system on which to test content created.
|
Event |
Date |
|---|---|
|
Review of Information Plan |
NOV 07 – FEB 08 |
|
Request part numbers |
Done 2/11/08 |
|
Create man page RFE |
Done 2/27/08 |
|
Create storyboard for screencast |
14-15 FEB Done 2/27/08 |
|
Code Freeze for CLI |
23 APR |
|
Deliver alpha drafts of man pages Submit What'sNew form to Solaris doc Revise screencast storyboard Post information plan to OpenSolaris project page |
11 APR |
|
Deliver alpha drafts of Config Guide |
23 APR |
|
Produce screencast |
TBD |
|
Deliver final drafts of Config Guide and man pages Publish to OpenSolaris project page |
9 MAY |
|
Beta |
18 APR -> 5 JUN |
|
Final approval for man pages, configuration guide |
5 JUN |
|
Integration |
19 MAY |
|
Go/NoGo |
5 JUN |
|
Delivery to Build 92 |
9 JUN |
|
Post documents to docs.sun.com |
|
|
Publish to OpenSolaris project page |
JUNE |
|
Troubleshooting topics |
ongoing |