| Version 3 (modified by , 11 years ago) (diff) |
|---|
OG-ADM-7: Documentation Review Test
This page captures status for the test case OG-ADM-7. For additional information see the Acceptance Test Status - December 2013 page overall status, or the OpenGENI Acceptance Test Plan for details about the planned evaluation.
Last Update: 2013/12/18"
Test Status
This section captures the status for each step in the acceptance test plan.
| Documentation | State | Tickets | Notes |
| 1. OpenGENI Rack Installation Documentation | Pass: most criteria | #74 | |
| 2. OpenGENI Rack Part List Documentation | Pass: most criteria | #75 | |
| 3. OpenGENI Software Components Identification Documentation | Pass | #76 | |
| 4. OpenGENI and OS Upgrade Plans | In Progress | #77 | |
| 5. OpenGENI Software Components Functional Description and Access to Source code | Pass | #78 | |
| 6. OpenGENI Rack Resources Usage and Policy Documentation | Fail | #79 | |
| 7. OpenGENI Rack Resources Administration | Pass: most criteria | #80 | |
| 8. OpenGENI Rack Administrative procedure for user accounts | Pass: most criteria | #81 | |
| 9. OpenGENI Rack Administrative procedure for rack operations | Fail | #82 | |
| 10. OpenGENI Rack Administrative procedure for rack scheduled shutdown | In Progress | #83 | |
| 11. OpenGENI Rack Administrative procedure for Emergency Stop. | In Progress | #84 | |
| 12. OpenGENI Rack Administrative procedure for health status | Fail | #85 | |
| 13. OpenGENI Rack Site Operations documentation | Fail | #86 | |
| 14. Site Specific OpenGENI Deployment Data | Fail | #87 |
| State Legend | Description |
| Pass | Documentation review completed and met all criteria |
| Pass: most criteria | Documentation review completed and met most criteria. Exceptions documented |
| Fail | Documentation review completed and failed to meet criteria . |
| Complete | Documentation review completed but will require re-execution due to expected changes |
| Partial | Minimal Documentation was found |
| In Progress | Currently under review |
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:
- OpenGENI Administration Guide - No changes were made to this page in since the last evaluation.
- OpenGENI Installation Guide with Grizzly !OpenStack Significant changes where made to this guide.
- OpenGENI Network and Software Architecture Description - Minimal changes were made to this document since last evaluation.
- OpenGENI Testing Guide - No changes were made to this page in since the last evaluation.
- OpenGENI Users Guide - Changes have been made to this guide to capture new features.
- 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: Pass: most criteria
The page 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: Pass: most criteria
A parts list was found in the page Details on BBN-CAM OpenGENI Rack Installation and Configuration. 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: Pass
Found:
- Clearly defined components in OpenGENI Network and Software Architecture Description.
- Information for system configurations used in OpenGENI rack in the OpenGENI Installation Guide - Revised.
- Software Configuration versioning for components installed on the BBN-CAM rack.
- 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: In Progress
Found software update information in:
- 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
- OpenGENI Installation Guide - Revised includes instructions for installing OpenStack and OpenGENI on the control and compute nodes.
In Progress
- Updates being implemented for package update, only first time install available at this time
Not Found:
- Notification process for updates
- Security updates plans
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: Pass
Found:
- Clearly defined components in OpenGENI Network and Software Architecture Description.
- Installation Instructions for OpenStack Grizzly package and OpenGENI installation.
- Software Repository page with instructions for getting account.
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: Fail
Did not find any Resources Usage and Policy documents.
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: Pass: most criteria
Found:
- Installation Instructions for OpenStack Grizzly package and OpenGENI installation.
- OpenGENI Users Guide give minimal insight into node roles in OpenGENI
- 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.
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: Pass: most criteria
Found:
- The Administration Procedures section in the BBN-CAM rack details page includes a link to the Rack Admin Accounts page.
- Rack Admin Accounts page includes instructions for adding and removing administrative users on the control and compute nodes.
Not Found:
- Rack Admin Accounts page does not includes instructions for Administrative access to switches and to the dRAC console.
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: Fail
No procedure was found for changing IP addresses for all rack components.
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: In Progress
Found:
- Skeleton outline for Rack Shutdown and Rack Power up.
Was not able to verify, expect to execute OG-ADM-3: Full Rack Reboot Test which will allow verification of 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: In Progress
Found:
- Skeleton outline for Emergency Stop Procedure.
Was unable to verify, expect to execute 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: Fail
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: Fail
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:
- Part numbers and quantities of PDUs, with NEMA input power connector types, and an inventory of which equipment connects to which PDU.
- 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)
- 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.
- 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: Fail
- Found a part list, but no part numbers. Power requirements are available here, there are no inventory of which equipment connects to which PDU.
- Items in item 2 not found.
- Items in item 3 not found
- Items in item 4 not found
