Transcription
Configuration Management PlanCONFIGURATION MANAGEMENTPLANVersion 5-00Document Control Number 1000-000002018-09-11Woods Hole Oceanographic InstitutionWoods Hole Road, Woods Hole, MA.www.whoi.eduin Cooperation withUniversity of WashingtonOregon State UniversityRutgers University1
Configuration Management PlanDocument Control -712-732-742-75DateJun 16, 2006Oct 15, 2007Oct 30, 2007Oct 30, 2007Nov 13, 2007Nov 16, 2007Jan – 2008Apr 29, 2008May 28, 2008May 28, 2008Jun 9, 2008Jun 20, 2008Jun 27, 2008Aug 11, 2008Aug 25, 20082-762-77Sep 22, 2008Oct 6, 20082-782-79Oct 9, 2008Oct 10, 20082-81Oct 22, 20082-82Jan 22, 20092-83Jan 26, 20092-84Jan 30, 20092-85Oct 29, 20092-86Nov 15, 20092-87Nov 19, 20092-882-89Nov 20, 2009May 25, 2010DescriptionInitial integrationComplete RevisionThreshold UpdateThreshold UpdateTerminologyComment UpdatesMajor updateRevisionRevision Chapters 5-6Clerical CorrectionsFormal Review Comment UpdateSection 2.6 ChangesFormattingDocument PropertiesVersion formatting, section 1-7change to conventionClerical CorrectionCollaboration Tools, update ofnaming conventions, inclusion ofattachment B2, correction to CCBFormatting, clerical correctionsMike Harrington directed RCAexample changes, Section 11.8.2 graphic, 1.8.4, 5.3.1, 5.3.3textSection 6.5, Appendix A-2:Change OOI CCB Chairperson toOOI Program Director. Move OOIProject Director to OOI CCBMembers list.1.5, 1.6, 3.4.5, 3.4.10, 3.5.2.1,3.5.2.2, 3.5.2.3: copy editsSection 7.3.2 text added re: RiskManagement BoardAppendix A-1, minor titledescription edits.Updated pre baselineNSF Directed changes to CCBmembership and address changein OL management structure.Update of tools referencesincluding Alfresco structure.Variant impact changes.1.2 R&RA Scope, Scope innaming conventionCCB Lien updateSection 1.9 updatescorresponding to B2 tableOriginatorS. WilliamsA. FerlainoA. FerlainoS. WilliamsA. FerlainoA. FerlainoSE groupA. FerlainoA. FerlainoA. FerlainoA. FerlainoA. FerlainoA. FerlainoA. FerlainoA. FerlainoA. FerlainoA. Ferlaino, P. YeungL. SnowA. FerlainoA. FerlainoE. GriffinL. BrasseurA. FerlainoA. Ferlaino, B. Bergen, M.GoodnightA. FerlainoA. FerlainoA. Ferlaino, ECR # 1300-00030K. Carr, ECR # 1300-000752
2-902-91Sept 2, 2010Oct 10, 20102-923-00Feb 7, 2011Feb. 18, 20113-01June 9, 20113-02June 15, 20113-03July 14, 20113-04August 5,20113-05Oct. 20, 20113-06Oct. 21, 20113-07Oct 21, 20113-083-093-103-113-123-13Nov 15, 2011Nov 29, 2011Dec 1, 2011Dec 6, 2011Dec 9, 2011Dec 23, 20113-143-15Mar 9, 2012Mar 13, 20123-163-173-18Mar 28, 2012Mar 30, 2012Dec 14, 20123-193-20Dec 21, 2012Mar 19, 20133-213-22April 3, 2013April 9, 20133-23Aug 8, 20133-24Oct 28, 2013Configuration Management PlanupdatesMajor Update for CCBE. Chapman, ECR#1300-00090Edits to Sec 6.3, 6.4, and 7.2E. Chapman, ECR#1300-00090based on CCB feedback.Edits to 3.4.10 and Section 5.E. ChapmanMajor Update, edits to SectionsE. Griffin, ECR #1300-001261.7.1, 1.7.2, 1.9, 2.11.2, 3.0,3.5.2.2, 4.2.1, 7.0, 7.1,AppendicesEdits and clarifications toE. Griffin, E. ChapmanSections 1.6, 1.7, 1.8, 2.7, 6.2.3,6.4, 6.5, 7.3.2, 7.4, 7.5, andAppendix A-1Clarified drawing title blockE. Chapmanstatement in 2.7Updates to Sections 1.8.1, 7.4,E. Griffin, ECR #1300-00179removal of Appendix A-1,administrative changes.Updates to Sections 6.4, 7.2, 7.3, G. Settle and E. Griffin, ECR7.5, and 7.6; changed position#1300-00192titles to reflect actuals used in thePMO throughout the document.Edits to sections 1.8, 3.5, 6.2, 7.2, E. Griffin7.5Addition to 1.4; minor wordG. Settlechanges, copy editsSection 6.2.4; additional edits toE. Griffin, A. Ferlaino, E.sections 6.2.1, 6.2.2, 6.4, 7.1,Chapman7.1.3, 7.3.1, 7.5Resolving liens ECR 1300-00192 E. GriffinResolving liens ECR 1300-00192 E. GriffinEdits to Sections 2.9, 2.10, 2.11E. GriffinResolving liens ECR 1300-00192 E. GriffinFormattingE. Griffin, ECR #1300-00192Administrative edit on DocumentE. GriffinControl SheetUpdates to Sections 1.5, 1.10E. GriffinUpdates to Sections 3.4, 3.5, 6.3, E. Griffin6.4Working off liensE. Griffin, ECR #1300-00237Completion of liensE. Griffin, ECR #1300-00237Completion of NSF LiensE. Chapman, ECR #130000237Formatting, copy editsE. GriffinAdministrative updates,E. Griffincorrections to Sections 1.7.2,1.8.1, 6.2.1, 6.4, 6.5, 7.3.1.Updates to Sections 4.5.1.3, 7.3.1 K. Carr, ECR #1300-00356Changed language in 7.3.1 perK. Carr, ECR #1300-00356comment on ECR 1300-00356Administrative change. As-BuildE. ChapmanTDP due as part ofCommissioning not Acceptance.Updates to CI CM section.T. Cowles3
3-25Jan 7, 20144-01Oct. 15, 20144-024-03May 12, 2015May 19, 20154-04May 19, 20154-05Oct 02, 20154-05Dec 11, 20154-05April 1, 20165-00Sept. 11, 2018Configuration Management PlanAdmin Change- clarify languageE. Chapmanin 6.2.1.e and 6.2.2.dMajor Update for Transition toP. Matthias, S. WhiteO&MFinalize for End of ConstructionD. PennAddition of CGSN and CabledS. BanahanArray CMP documentationAddition of Cabled ArrayS. Banahandocument and softwareinstructions.Various Updates needed for theJ. PisciottaO & M phase.Various Updates needed for theJ. PisciottaO & M Redmine.Additional Updates needed for the J. PisciottaO & M Redmine changes.Refresh for OOI 2.0, with inputP. Matthiasfrom all IOs.4
Configuration Management PlanTable of Contents:1Configuration Management System Structure . 81.1Purpose . 81.2Scope . 81.3Configuration Process . 81.3.1Drawing Standard . 81.3.2Software Versioning and Configuration Process . 81.3.3Implementing Organization Documentation Assurance Process . 91.3.4Implementing Organization Configuration Management Process . 91.4Responsibility & Authority . 91.5Configuration Controlled Documents. 111.6File Formats and Applications . 111.7File Naming Conventions (Non-Controlled) . 121.7.11.8Terms and Definitions . 12File Numbering Conventions (Controlled) . 121.8.1Series Number . 121.8.2Sequence Number . 131.8.3Control Assignment Validation Criteria . 141.8.4Controlled Files Outside of the DMS . 141.9Other Naming Conventions . 141.9.11.102Observatory - Instrument Name . 14Technical Data Baselines . 14Document and Information Types . 152.1Hardware and Software Documentation. 152.2Document (Drawing) List . 152.3Procurement Documentation . 162.4Source Control Document / Vendor Item Drawing . 162.5Specifications . 162.6Hardware Parts Lists and Bills of Material . 162.7Hardware Assembly Drawings . 162.8Hardware Assembly Procedures . 162.9Hardware Configuration Database . 172.10Software Configuration Database . 172.11Program Management Support Information . 172.11.1Work Breakdown Structure . 185
3Configuration Management PlanDocument Management . 183.1Document Style and Format . 183.2Document Change Control . 183.3Change Request Process and Numbering Convention . 183.4Document Terms / Information Fields . 183.4.1Controlled Document . 183.4.2Draft (preliminary) Documents . 193.4.3Released Documents . 193.4.4Approval . 193.4.5Author . 193.4.6Release Date . 193.4.7Version Number . 193.4.8Version Date . 193.54Document Management Application, Alfresco . 193.5.1General Overview . 193.5.2OOI Configuration . 203.5.3Attributes in Microsoft Excel and Word Documents . 22Collaboration Applications . 234.1Overview . 234.2Confluence . 234.2.1OOI Configuration . 234.3Redmine . 244.4Git . 274.4.1CI Software Repositories . 274.4.1.1Repository Tagging . 274.4.1.2External Dependencies of the CI Software. 284.4.1.3Backup Policy for OOI CI Repositories . 284.4.1.4Backup Recovery Testing . 284.5Ansible . 284.6Gerrit . 284.7Jenkins . 294.8Program Management Portal (SAF) . 295Design Reviews . 296Configuration Control Structure . 296.1Baselines . 296.2Engineering Change Classes . 296.2.1Class I Changes . 296.2.2Class II Changes . 306
76.2.3Configuration Management PlanAdministrative Changes . 306.2.4Engineering Change Content . 306.3PMO / IO Change Control Boards . 316.4System Level Change Control Board . 326.5NSF Program Manager Review . 32Change Control Process . 337.1Requests for Engineering Changes. 337.1.1Assessing the Impact of Requested Changes. 337.1.2Change Control Documentation . 337.1.3Budget for Changes . 337.2Change Control Board Operation . 337.2.1Records of Meetings . 347.2.2Timing of Meetings . 347.2.3Submitting and Scheduling of ECRs . 347.3Change Control Board Authority. 347.3.1PMO / IO CCBs . 347.3.2System Level Change Control Board . 347.4Review Authority . 357.5ECR Closeout . 35Appendix I – CI Pre-Commissioning SW Repositories. 36Appendix II – External Dependencies of SW Repository Code . 38Appendix III – Repository Backup and Recovery . 39Repository Backup . 39Repository Recovery . 39Appendix IV – Repository Recovery Test Plan . 407
Configuration Management Plan1 Configuration Management System Structure1.1PurposeThe Configuration Management Plan (CMP) establishes the activities, responsibilities, processes,and methods used to document and maintain the design of the Ocean Observatories Initiative (OOI)program and to manage changes to the design and scope of the system of systems.1.2ScopeThe CMP is applicable to all OOI systems and subsystems hardware and software technical data,designs and software code and hardware developed or delivered as part of the OOI program. TheOOI "Program" now includes all of the National Science Foundation (NSF) funded resources andmaterials to be addressed as part of the Operations & Management (O&M) agreements with theWoods Hole Oceanographic Institution and sub-awardees.The CMP defines the roles, responsibilities, and authorities of the OOI team members in theconfiguration management of the OOI Operations and Management (O&M) phase.1.3Configuration ProcessThe OOI Program Management Office (PMO) and Implementing Organizations (IOs) shall have thefollowing standards and processes in place and follow the standards and processes in theperformance of the contract:a) Drawing Standard / Software Coding Standardsb) Software Versioning and Configuration Processc) PMO / IO Documentation Assurance Processd) PMO / IO Configuration Management Process1.3.1Drawing StandardThe IOs have the option of utilizing their own drawing standards if it is similar to or exceeds theAmerican Society of Mechanical Engineers (ASME) Y14.100 (Engineering Drawing Practices)requirements, otherwise ASME Y14.100 shall be used as the drawing standard. The standard mustprovide engineering definition to assure the functional interchangeability of parts when procured fromoriginal or alternate sources.1.3.2Software Versioning and Configuration ProcessThe IOs have configuration management processes in place to manage software versioning andconfiguration. The IO systems have been appropriately tailored to reflect the nature of the softwareefforts they manage.The Cyberinfrastructure (CI) uses GitHub and Git Version Control Systems, with internal organizationappropriate to efficient collaboration and management of the software.The Coastal Global Scale Nodes (CGSN) and Regional Cabled Array (RCA) use GitHub and Git astheir source code repositories to maintain version control and allow collaborative development. ForRCA platforms, version control applies to all Platform Controller software modules and all firmwarerunning in microcontrollers on CGSN-designed processor elements. In addition, distribution files,installation scripts, and release notes are version controlled.8
Configuration Management PlanCGSN uses Vault as their source code repository to maintain version control and allow collaborativedevelopment. For CGSN platforms, version control applies to all Platform Controller softwaremodules and all firmware running in microcontrollers on CGSN-designed processor elements. Inaddition, distribution files, installation scripts, and release notes are version controlled.1.3.3Implementing Organization Documentation Assurance ProcessThe IOs shall have a process in place that assures that the Technical Data Package delivered hasundergone a thorough and structured creation, check, and approval cycle. Changes to the contentsof the TDP go through IO and/or System Level CCB as appropriate and as described in the rest ofthis document.1.3.4Implementing Organization Configuration Management ProcessThe IOs have a Configuration Management Process in place that describes the IO’s configurationcontrol processes, a Configuration Manager (CM), and an IO Change Control Board (CCB) processcompliant with OOI policies and procedures.The Coastal Global Scale Nodes (CGSN) IO’s Configuration Management Plan (Document ControlNumber [DCN] 3101-00047) is incorporated by reference. The CGSN Configuration ManagementPlan supports the OOI CMP’s goals and defines the roles, responsibilities and authorities of theCGSN team members in the configuration management process. The CG CMP establishes theactivities, processes, and methods used to document and maintain the design of the CGSN, whichincludes but is not limited to infrastructure elements such as: moorings, surface buoys, autonomousunderwater vehicles, multifunction nodes, platform controllers, power systems, profilers, gliders,telemetry, operations and management center, and instrument packages.The Regional Cabled Array (RCA) IO (formerly known as the Regional Scale Nodes [RSN] codifies itsconfiguration management approach in its Project Execution Plan (DNC 4021-00001, Section 2.2.1).The Cabled Array has established processes and procedures for the hardware and softwarerequirements, versions, documents, and drawings. This process includes a formal change controlboard to process Engineering Change Proposals through a structured review process. Changesaddressed include any new sensors, secondary, primary equipment, or software prior toimplementation and ensures that adequate pre-implementation testing has been completed and thata detailed Method of Procedure for the change is in place, inclusive of recovery or fall-backprocedures. All changes are implemented and approved in strict accordance with the OOI CMP. Allapproved changes will be incorporated into the appropriate document(s) and will be reflected in thesystem inventory database by the Cabled Array Systems Engineer.Rutgers IO has defined the CI Software Configuration Management section to establish processesand procedures for the CI software. These processes include the transition of the CI software to a setof repositories residing at Rutgers. It includes establishing software configuration management toolsand processes, and formal backup and recovery procedures for the CI software.1.4Responsibility & AuthorityThe responsibilities and authority of the members of the OOI project teams are defined by thecooperative agreement between the National Science Foundation (NSF) and the Woods HoleOceanographic Institution (WHOI), and the subaward contracts between WHOI and the IOs. Theroles of the Configuration Management Process leadership members are outlined below.NSF Program Director: The NSF Program Director is the program sponsor and has the sole authorityto revise any program baselines. Program Baselines are defined as: the milestone point-in-timescope and "state" of the related programmatic metrics. Specifically, at the NSF level, these are theprogram technical scope, cost and schedule.9
Configuration Management PlanOOI Program Principal Investigator: The OOI Program Principal Investigator (PI) has the authorityand responsibility to carry out the policies and activities described herein, and may delegate suchauthority as required.OOI Senior Project Manager: The OOI Senior Project Manager (SPM) at the PMO has primaryresponsibility for all system of system and system level issues. The OOI SPM will work with the OOIProgram Engineer to implement the Configuration Management Process as described herein acrossthe OOI to ensure that requirements, designs and interfaces are fully defined, documented andmaintained.OOI Program Engineer: The OOI Program Engineer is the OOI Configuration Manager, and hasprimary responsibility for all OOI system of system and system level issues. The OOI ProgramEngineer is responsible for implementation of the Configuration Management Process as describedIO Project Managers: The IO Project Managers (PMs) have primary responsibility for all system ofsystem and system level issues within their IOs. The IO PMs will work with their IO PrincipalInvestigators, Chief/Lead System Engineers and IO Configuration Managers to implement theConfiguration Management Process as described herein across the collaboration to ensure thatdesigns, requirements and interfaces are fully defined, documented and maintained.OOI and IO Configuration Managers: The OOI and IO Configuration Managers manage the CCBprocess, assure changes are completed correctly, and supervise distribution (posting) of newrevisions and the recall of obsolete documents. The OOI Program Engineer serves as theConfiguration Manager, reporting to the OOI Senior Project Manager or delegate. Each IO PM shallassign the duties of configuration management to a member of the IO project office.10
Configuration Management Plan1.5Configuration Controlled DocumentsDocuments and records will be maintained as described in this plan, including the following keyproducts:: Science Prospectus and Traceability MatrixScience RequirementsFinal Network DesignTechnical Data Packages (TDP) – including by not limited to:o Engineering Requirements Documentso Interface Agreement/Control Documentso Engineering Design Documents (e.g., drawings, specifications)o Test Plans and ProceduresNetwork Design (documents and drawings)Program Plans and Policies (e.g., System Engineering Management Plan Final, CostEstimating Plan)Work Breakdown Structure (WBS) and related support documentsCost Books1.6File Formats and ApplicationsThe following shall be used to create and exchange information between IOs and the OOI PMO andin preparation of any technical data package.TypeRequirements DatabaseDocument AuthoringDocument DistributionScheduling and Project ManagementTechnical Data DistributionFile Format /ApplicationExcel SpreadsheetsWord 2010Portable Document Format (PDF)Inventor 2018 and AutoCAD Electrical2018.Note: vector formEnterprise Architect(Visio Omni / Graffle optional)MSProject Project 2010Excel 2010Collaborative ApplicationConfluenceAlfrescoRedmineGIT and GitHubDescriptionWeb collaborative environment / WikiDocument Management SystemAction Item / Issue TrackingSoftware Code CMProgram Management Portal (SAF)Change Control, Risk/OpportunityManagement, Instrument ApplicationEngineering DrawingsGeneral GraphicsNetwork or Diagram GraphicsNote: See Collaborative Applications Section 4 for details.11
Configuration Management Plan1.7File Naming Conventions (Non-Controlled)The following naming convention shall be used to exchange information between IOs and the OOIPMO and in preparation of any technical data package of non-controlled documents/drawings.This naming convention is also used for documents prior to their submittal to the DocumentManagement System (DMS), prior to the issuance of a control number, or for controlled documentsduring the revision process.File Name: Short Descriptive Name Scope Level YYYY-MM-DD ver #-##.extShort Descriptive Name: relative to the subject or name of the documentScope Level: identifying the scope of the document, from a sensor, platform, location,observatory, or top level, (e.g.: OOI, Irminger, RCA)Date: in four digit year, dash, two digit month, dash, two digit day, representing thecompletion date, release date, or current version of the document, incremented as changesare made. The date displayed in the file name should be the date of the last change.Version: "ver" indicating the major release number followed by the minor working level,number dash number. A required element if a released version of a configuration controlleddocument. Used for version tracking in non-configuration controlled documents. (e.g.: ver 000 for the first version or ver 2-05 for a later version designating the second major revisionand fifth minor working level revision following the last major change) Use a leading zero for"dash" 0 through "dash" 9 (e.g. -00, -01, -02, -09)Note: Underscores are used as separators, no spaces permitted in file names. Dashes are to beused only for the date string and version number string. For example: 1.7.1CMP OOI 2008-01-21 ver 2-05.doc [Configuration Management Plan]Preliminary Design Document CI 2007-07-24 ver 3-01.docTerms and DefinitionsThe OOI Program Terms and Definitions list is maintained by the OOI Systems Engineering (SE)group.1.8File Numbering Conventions (Controlled)All controlled and released level documents shall have a unique OOI / IO document numberassigned and added as a prefix to the document file name.The document number sha
Configuration Management Plan 1 CONFIGURATION MANAGEMENT PLAN Version 5-00 Document Control Number 1000-00000 2018-09-11 Woods Hole Oceanographic Institution Woods Hole Road, Woods Hole, MA. www.whoi.edu in Cooperation with University of Washington Oregon State University Rutgers University
