[[PageOutline]] = EG-ADM-7: Documentation Review Test = This page captures status for the test case EG-ADM-7, which verifies the availability of Documentation for the ExoGENI rack. For overall status see the [wiki:GENIRacksHome/ExogeniRacks/AcceptanceTestStatus ExoGENI Acceptance Test Status] page. = Test Status = This section captures the status for each step in the acceptance test plan. || '''Step''' || '''State''' || ''' Ticket ''' || '''Comments''' || ||1. ExoGENI Rack Installation Documentation ||[[Color(orange,Partial)]] || || || ||2. ExoGENI Rack Part List Documentation ||[[Color(yellow,Complete)]] || || || ||3. ExoGENI Software Components Identification Documentation ||[[Color(red,Fail)]] || || || ||4. ExoGENI and OS Upgrade Plans ||[[Color(red,Fail)]] || || || ||5. ExoGENI Software Components Functional Description and Access to Source code ||[[Color(orange,Partial)]]|| || || ||6. ExoGENI Rack Resources Usage and Policy Documentation ||[[Color(red,Fail)]]|| || || ||7. ExoGENI Rack Resources Administration ||[[Color(red,Fail)]]|| || || ||8. ExoGENI Rack Administrative procedure for user accounts ||[[Color(red,Fail)]] || || || ||9. ExoGENI Rack Administrative procedure for rack operations ||[[Color(red,Fail)]]|| || || ||10. ExoGENI Rack Administrative procedure for rack scheduled shutdown ||[[Color(red,Fail)]]|| || || ||11. ExoGENI Rack Administrative procedure for Emergency Stop. ||[[Color(red,Fail)]]|| || || ||12. ExoGENI Rack Administrative procedure for health status ||[[Color(red,Fail)]]|| || || ||13. ExoGENI Rack Site Operations documentation ||[[Color(red,Fail)]]|| || || ||14. Site Specific ExoGENI Deployment Data ||[[Color(red,Fail)]]| || || [[BR]] || '''State Legend''' || '''Description''' || || [[Color(green,Pass)]] || Documentation review completed and met all criteria || || [[Color(#98FB98,Pass: most criteria)]] || Documentation review completed and met most criteria. Exceptions documented || || [[Color(red,Fail)]] || Documentation review completed and failed to meet criteria || || [[Color(yellow,Complete)]] || Documentation review completed but will require re-execution due to expected changes || || [[Color(orange,Partial)]] || Minimal Documentation was found || || [[Color(#63B8FF,In Progress)]] || Currently under review || [[BR]] = ExoGENI Documentation Tests = The ExoGENI Documentation Tests focus on documentation review, and apply the following criteria for each document: * The document has been provided in a public location, where public locations are https://wiki.exogeni.net, and https://geni-orca.renci.org * The document contains the required information. * The documented information appears to be accurate. Documents to be reviewed include: == 1. ExoGENI 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:''' No documentation is found in known public locations that contains the required physical information, thus unable to verify the content. == 2. ExoGENI Rack Part List Documentation == '''The goal of this evaluation:''' To find a summary ExoGENI 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:''' There is not one document, but a series of parts lists pages were found at the http://www.exogeni.net site: * [https://wiki.exogeni.net/doku.php?id=public:hardware:network:start ExoGENI Network] * [https://wiki.exogeni.net/doku.php?id=public:hardware:rack:start ExoGENI Rack] * [https://wiki.exogeni.net/doku.php?id=public:hardware:workernode:start Worker Node] * [https://wiki.exogeni.net/doku.php?id=public:hardware:headnode:start Head Node] * [https://wiki.exogeni.net/doku.php?id=public:hardware:iscsi:start ExoGENI iSCSI] Power requirements are listed in the [https://wiki.exogeni.net/doku.php?id=public:hardware:rack:start ExoGENI Rack], [https://wiki.exogeni.net/doku.php?id=public:hardware:workernode:start Worker Node], and [https://wiki.exogeni.net/doku.php?id=public:hardware:headnode:start Head Node] pages. PDU requirements are specified in the [https://wiki.exogeni.net/doku.php?id=public:hardware:rack:start ExoGENI Rack] page. Transceivers are defined as site specific. Readers are instructed to confirm their site needs before purchasing any equipment. A [https://svn.exogeni.net/repos/config/diagrams/ExoGENI_Cabling_Diagrams.pdf ExoGENI Connection diagram] is available on the [https://wiki.exogeni.net/doku.php?id=public:hardware:rack:start ExoGENI Rack] that documents node wiring. == 3. ExoGENI 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:''' No overall documentation was found that provided a list of software and versions. There is however the starting of a list from the [https://wiki.exogeni.net/doku.php?id=public:software:start ExoGENI Software] page, where information can be found about: xcat, orca, openstack, openflow and other auxiliary Infrastructure software. Although configuration and version information is not always consistently provided. More work is needed to ensure consistency and completeness. A [https://geni-orca.renci.org/trac/wiki/deploy-am Deploying an Authority (Aggregate Manager/AM)] page is available which provides configuration instructions for deploying an AM. == 4.ExoGENI and OS Upgrade Plans == '''The goal of this evaluation:''' Find documentation that explanations how and when ExoGENI 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:''' No documentation was found in known public locations that described ExoGENI and OS Upgrades. Unable to verify the content. == 5. ExoGENI Software Components Functional Description and Access to Source code == '''The goal of this evaluation:''' Find documentation that provides a description of the ExoGENI 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:''' Some component information and source can be found at the https://geni-orca.renci.org, but it is not obvious how to map it to the ExoGENI rack components. There is also is an overview of components in the wiki.exogeni.net location, but there is not any detailed list of ExoGENI software software and information about how to access the source for the components. There are some references to the location of the Kickstart node configurations and other base install settings. Not public, unable to review. == 6. ExoGENI 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:''' No documentation was found for usage and policy in the known public locations, thus unable to verify the content. == 7. ExoGENI 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:''' No documentation was found describing Rack Administration in the known public locations, thus unable to verify the content. == 8. ExoGENI 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:''' Various mentions of user accounts information was found, but none provided a procedure for creating site administrator and operator accounts, thus unable to verify the content. == 9. ExoGENI 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:''' Unable to find any procedure for modifying IP addresses for all rack components. == 10. ExoGENI 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:''' Unable to find any procedure for shutting down the rack. == 11. ExoGENI 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:''' Unable to find any procedure in support of Emergency Stop. == 12. ExoGENI 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:''' No health check procedures found. == 13. ExoGENI 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:''' None found. == 14. Site Specific ExoGENI 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:''' No site specific information was found at either site.