wiki:GENIRacksHome/OpenGENIRacks/AcceptanceTestStatusMay2013/OG-ADM-7

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 - May 2013 page overall status, or the OpenGENI Acceptance Test Plan for details about the planned evaluation.

Last Update: 2013/05/17"

Test Status

This section captures the status for each step in the acceptance test plan.

Documentation State Tickets Notes
1. OpenGENI Rack Installation Documentation Partial#74
2. OpenGENI Rack Part List Documentation Fail #75
3. OpenGENI Software Components Identification Documentation Pass: most criteria#76
4. OpenGENI and OS Upgrade Plans Fail #77
5. OpenGENI Software Components Functional Description and Access to Source codePartial#78
6. OpenGENI Rack Resources Usage and Policy Documentation Fail #79
7. OpenGENI Rack Resources Administration Fail #80
8. OpenGENI Rack Administrative procedure for user accounts Fail #81
9. OpenGENI Rack Administrative procedure for rack operations Fail #82
10. OpenGENI Rack Administrative procedure for rack scheduled shutdown Fail #83
11. OpenGENI Rack Administrative procedure for Emergency Stop. Fail #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 criteriaDocumentation 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:

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: Partial

Found: The page BBN OpenGENI Rack Details has:

  • mentions of Power Control Units, but no information was found about any power requirements, power plugs circuits, cooling requirements.
  • points the reader to the Starter Rack information, where device type information is found.
  • has address information for the rack.

Did not find:

  • pre-installation document that lists specific minimum requirements for all site-provided services.

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: Fail

Found:

Did not find:

  • There is no full parts list.
  • No information on headroom,or PDU power budget was found.

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: most criteria

Found:

Did not find:

  • No document detailing software versions for software components
  • No information about recent configuration and software changes

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: Fail

Found software update information in:

Did not find:

  • Update plans for software
  • 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: Partial

Found:

Did not find:

  • Instruction on how to get access to each piece of Software required.
  • Instruction on how to get git account.

6. OpenGENI Rack Resources Usage and Policy Documentation

The goal of this evaluation: Fail

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:

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: Fail

Found:

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: Fail

No document exists that defines how rack administrative and operator accounts are created.

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 document exists that defines how to change 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: Fail

No document exists that defines how to shutdown the entire rack for scheduled shutdowns.

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 St op request.

Evaluation Results: Fail

No document exists that defines Emergency Stop

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 document exists that defines health check procedures.

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 hand-off procedures are defined for OpenGENI

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: Fail

No document exists that defined deployments details described above

Last modified 10 years ago Last modified on 05/23/14 15:06:08