= OG-ADM-7: Documentation Review Test = This page captures status for the test case OG-ADM-7. For additional information see the [wiki:GENIRacksHome/OpenGENIRacks/AcceptanceTestStatusApr2014 Acceptance Test Status - April 2014] page overall status, or the [wiki:GENIRacksHome/AcceptanceTests/OpenGENIAcceptanceTestsPlan OpenGENI Acceptance Test Plan] for details about the planned evaluation. = Test Status = This section captures the status for each step in the acceptance test plan. || '''Documentation''' ||'''State''' || ''' Tickets ''' || '''Notes''' || ||1. OpenGENI Rack Installation Documentation ||[[span(Pass: most criteria, style=background-color: #98FB98)]]||74 || || ||2. OpenGENI Rack Part List Documentation ||[[span(Pass: most criteria, style=background-color: #98FB98)]]||75 || || ||3. OpenGENI Software Components Identification Documentation ||[[span(Pass, style=background-color: green )]] ||~~76~~ || || ||4. OpenGENI and OS Upgrade Plans ||[[span(Pass, style=background-color: green )]] ||~~77~~ || || ||5. OpenGENI Software Components Functional Description and Access to Source code||[[span(Pass, style=background-color: green )]] ||~~78~~ || ||6. OpenGENI Rack Resources Usage and Policy Documentation ||[[span(In Progress, style=background-color: #63B8FF)]] ||79 || || ||7. OpenGENI Rack Resources Administration ||[[span(Pass: most criteria, style=background-color: #98FB98)]]||80 || || ||8. OpenGENI Rack Administrative procedure for user accounts ||[[span(Pass, style=background-color: green )]] ||~~81~~ || || ||9. OpenGENI Rack Administrative procedure for rack operations ||[[span(Pass, style=background-color: green )]] ||~~82~~ || || ||10. OpenGENI Rack Administrative procedure for rack scheduled shutdown ||[[span(Pass, style=background-color: green )]] ||~~83~~ || || ||11. OpenGENI Rack Administrative procedure for Emergency Stop. ||[[span(In Progress, style=background-color: #63B8FF)]] ||84 || || ||12. OpenGENI Rack Administrative procedure for health status ||[[span(Pass, style=background-color: green )]] ||~~85~~ || || ||13. OpenGENI Rack Site Operations documentation ||[[span(Fail, style=background-color: red)]] ||86 || || ||14. Site Specific OpenGENI Deployment Data ||[[span(Pass, style=background-color: green )]] ||~~87~~ || || [[BR]] || '''State Legend''' || '''Description''' || ||[[span(Pass, style=background-color: green )]] ||Documentation review completed and met all criteria || ||[[span(Pass: most criteria, style=background-color: #98FB98)]]||Documentation review completed and met most criteria. Exceptions documented || ||[[span(Fail, style=background-color: red)]] ||Documentation review completed and failed to meet criteria . || ||[[span(Complete, style=background-color: yellow)]] ||Documentation review completed but will require re-execution due to expected changes || ||[[span(Partial, style=background-color: orange)]] ||Minimal Documentation was found || ||[[span(In Progress, style=background-color: #63B8FF)]] ||Currently under review || [[BR]] = OpenGENI Documentation Tests = The OpenGENI Documentation Tests focus on documentation review, and apply the following criteria for each document: * The document has been provided in a public location. This criteria failed to be met, all documentation is internal for initial evaluation. * The document contains the required information. * The documented information appears to be accurate. Rack documentation available and reviewed to find required information includes: * [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/AdministrationGuide OpenGENI Administration Guide] - No changes were made to this page in since the last evaluation. * [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/InstallationGuideGrizzly OpenGENI Installation Guide with Grizzly !OpenStack] Significant changes where made to this guide. * [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/ArchitectureDescription OpenGENI Network and Software Architecture Description] - Minimal changes were made to this document since last evaluation. * [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/TestGuide OpenGENI Testing Guide] - No changes were made to this page in since the last evaluation. * [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/UserGuide OpenGENI Users Guide] - Changes have been made to this guide to capture new features. * [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/DellRackDetails Details on BBN-CAM OpenGENI Rack Installation and Configuration] details pages. == 1. OpenGENI Rack Installation Documentation == '''The goal of this evaluation:''' To find pre-installation document that lists specific minimum requirements for all site-provided services for potential rack sites (e.g. space, number and type of power plugs, number and type of power circuits, cooling load, public addresses, NLR or Internet2 layer2 connections, etc.). This document should also list all standard expected rack interfaces (e.g. 10GBE links to at least one research network). '''Evaluation Results''': [[span(Pass: most criteria, style=background-color: #98FB98)]] The page [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/DellRackDetails Details on BBN-CAM OpenGENI Rack Installation and Configuration] and found: - Rack space requirements - Power requirements - Network and Hardware Configuration - Cooling requirements Not found: - Although public IP addresses are listed in the initial topology captured on this page, there is no indication of the minimum required number of public address for rack components and for experiment usage. - Core backbone connectivity requirements (layer2). == 2. OpenGENI Rack Part List Documentation == '''The goal of this evaluation:''' To find a summary OpenGENI Rack parts list, including vendor part numbers for "standard" equipment intended for all sites (e.g. a VM server) and per-site equipment options (e.g. transceivers, PDUs etc.), if any. This document should also indicate approximately how much headroom, if any, remains in the standard rack PDUs' power budget to support other equipment that sites may add to the rack. '''Evaluation Results''': [[span(Pass: most criteria, style=background-color: #98FB98)]] Not found: - Document that indicates approximately how much headroom, if any, remains in the standard rack PDUs' power budget to support additional equipment added by site to the rack. == 3. OpenGENI Software Components Identification Documentation == '''The goal of this evaluation:''' Find a procedure for identifying the software versions and system file configurations running on a rack, and how to get information about recent changes to the rack software and configuration. '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] Found: - Clearly defined components in [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/ArchitectureDescription OpenGENI Network and Software Architecture Description]. - Information for system configurations used in OpenGENI rack in the [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/InstallationGuideRevised OpenGENI Installation Guide - Revised]. - Software Configuration versioning for components installed on the [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/DellRackDetails#SoftwareConfiguration BBN-CAM] rack. - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/SoftwareRepository Software Repository] page provides a pointer to gram-dev@bbn.com for software help and for access to git repository, where recent configuration and software changes are captured. == 4. OpenGENI and OS Upgrade Plans == '''The goal of this evaluation:''' Find documentation that explains how and when OpenGENI software and OS updates can be performed on a rack, including plans for notification and update if important security vulnerabilities in rack software are discovered. '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] Found software update information in: - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/InstallationGuideGrizzly OpenGENI Installation Guide with OpenStack Grizzly] includes: * Configuration Overview * Network Configuration for !OpenFlow Switch for the Data Network and for Management Switch * OpenGENI and OpenStack Installation and Configuration * Testing OpenGENI installation * Debugging Notes - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/InstallationGuideRevised OpenGENI Installation Guide - Revised] includes instructions for installing !OpenStack and OpenGENI on the control and compute nodes. - Was able to verify package update instructions. Not Found: - Notification process for updates - Security updates plans Documentation is to be moved to external wiki. == 5. OpenGENI Software Components Functional Description and Access to Source code == '''The goal of this evaluation:''' Find documentation that provides a description of the OpenGENI software running on a standard rack, and explanation of how to get access to the source code of each piece of standard GENI software. '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] Found: - Clearly defined components in [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/ArchitectureDescription OpenGENI Network and Software Architecture Description]. - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/InstallationGuideGrizzly Installation Instructions] for OpenStack Grizzly package and OpenGENI installation. - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/SoftwareRepository Software Repository] page with instructions for getting account. Need to be moved to external wiki. == 6. OpenGENI Rack Resources Usage and Policy Documentation == '''The goal of this evaluation:''' Find documentation that provides a description of all the GENI experimental resources within the rack, and what policy options exist for each, including: how to configure rack nodes as bare metal vs. VM server, what options exist for configuring automated approval of compute and network resource requests and how to set them, how to configure rack aggregates to trust additional GENI slice authorities, and whether it is possible to trust local users within the rack. '''Evaluation Results:''' [[span(In Progress, style=background-color: #63B8FF)]] Document was being written, but requested changes were not implemented. == 7. OpenGENI Rack Resources Administration == '''The goal of this evaluation:''' Find documentation that provides a description of the expected state of all the GENI experimental resources in the rack, including how to determine the state of an experimental resource and what state is expected for an unallocated bare metal node. '''Evaluation Results:''' [[span(Pass: most criteria, style=background-color: #98FB98)]] Found: - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/InstallationGuideGrizzly Installation Instructions] for OpenStack Grizzly package and OpenGENI installation. - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/UserGuide OpenGENI Users Guide] give minimal insight into node roles in OpenGENI - [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/BOSRackDetails BBN OpenGENI Rack Details] which defines the actual node settings for the OpenGENI Rack. Did not find: - documentation that would give an administrator a description of the expected state of all the GENI experimental resources in the rack. All the above need to be moved to external location. == 8. OpenGENI Rack Administrative procedure for user accounts == '''The goal of this evaluation:''' Find documentation that provides a procedure for creating new site administrator and operator accounts. '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] Found: - The [http://groups.geni.net/geni/wiki/GENIRacksAdministration/OpenGENIRacksAdminAccounts OpenGENI Administrative Accounts] instructions were verified by having Local Site Admin add and remove administrative access to all rack components. == 9. OpenGENI Rack Administrative procedure for rack operations == '''The goal of this evaluation:''' Find documentation that provides a procedure for changing IP addresses for all rack components. '''Evaluation Results:'''[[span(Pass, style=background-color: green )]] Procedure verified. == 10. OpenGENI Rack Administrative procedure for rack scheduled shutdown == '''The goal of this evaluation:''' Find documentation that provides a procedure for cleanly shutting down an entire rack in case of a scheduled site outage. '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] Found: Was able to execute [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/AcceptanceTestStatusApr2014/OG-ADM-3 OG-ADM-3: Full Rack Reboot Test] and verify the procedure. == 11. OpenGENI Rack Administrative procedure for Emergency Stop. == '''The goal of this evaluation:''' Find documentation that provides a procedure for performing a shutdown operation on any type of sliver on a rack, in support of an Emergency Stop request. '''Evaluation Results:''' [[span(In Progress, style=background-color: #63B8FF)]] Found: - Skeleton outline for [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/EmergencyStop Emergency Stop Procedure]. Was unable to verify, expect to execute [http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/AcceptanceTestStatusDec2013/OG-ADM-4 OG-ADM-4: Emergency Stop Test] in order to verify content of procedure. == 12. OpenGENI Rack Administrative procedure for health status == '''The goal of this evaluation:''' Find documentation that provides a procedure for performing comprehensive health checks for a rack (or, if those health checks are being run automatically, how to view the current/recent results). '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] No documentation exist that defines how to monitor OpenGENI component health. Found healthcheck.py but there is no documentation for it.???? == 13. OpenGENI Rack Site Operations documentation == '''The goal of this evaluation:''' Find documentation that provides a Technical plan for handing off primary rack operations to site operators at all sites. '''Evaluation Results:''' [[span(Fail, style=background-color: red)]] No documentation found. == 14. Site Specific OpenGENI Deployment Data == '''The goal of this evaluation:''' Find documentation that provides Per-site deployment details/documentation. This documentation should be prepared before sites are installed and kept updated after installation to reflect any changes or upgrades after delivery. Text, network diagrams, wiring diagrams and labeled photos are all acceptable for site documents. Per-site documentation should include the following items for each site: 1. Part numbers and quantities of PDUs, with NEMA input power connector types, and an inventory of which equipment connects to which PDU. 2. Physical network interfaces for each control and data plane port that connects to the site's existing network(s), including type, part numbers, maximum speed etc. (eg. 10-GB-SR fiber) 3. Public IP addresses allocated to the rack, including: number of distinct IP ranges and size of each range, hostname to IP mappings which should be placed in site DNS, whether the last-hop routers for public IP ranges subnets sit within the rack or elsewhere on the site, and what firewall configuration is desired for the control network. 4. Data plane network connectivity and procedures for each rack, including core backbone connectivity and documentation, switch configuration options to set for compatibility with the L2 core, and the site and rack procedures for connecting non-rack-controlled VLANs and resources to the rack data plane. A network diagram is highly recommended (See existing !OpenFlow meso-scale network diagrams on the GENI wiki for examples.) '''Evaluation Results:''' [[span(Pass, style=background-color: green )]] The information required for the site specific information exists internally at this time at: http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/ClemsonRackDetails Additionally, there are new operator and experimenter pages that are being worked on at this time at: ​http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/ClemsonOpenGENI ​http://groups.geni.net/geni/wiki/GENIRacksHome/OpenGENIRacks/Operators