wiki:GENIRacksHome/InstageniRacks/AcceptanceTestStatus/IG-ADM-7

Version 36 (modified by lnevers@bbn.com, 7 years ago) (diff)

--

IG-ADM-7: Documentation Review Test

This page captures status for the test case IG-ADM-7, which verifies the availability of Documentation for the InstaGENI racks. For overall status see the InstaGENI Acceptance Test Status page.

Test Status

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

Docuementation State Tickets Notes
1. InstaGENI Rack Installation Documentation Color(#98FB98,Pass: most criteria)?
2. InstaGENI Rack Part List Documentation Color(#98FB98,Pass: most criteria)?
3. InstaGENI Software Components Identification Documentation Color(red,Fail)?
4. InstaGENI and OS Upgrade Plans Color(green,Pass)?
5. InstaGENI Software Components Functional Description and Access to Source code Color(red,Fail)?
6. InstaGENI Rack Resources Usage and Policy Documentation Color(red,Fail)?
7. InstaGENI Rack Resources Administration Color(red,Fail)?
8. InstaGENI Rack Administrative procedure for user accountsColor(green,Pass)?
9. InstaGENI Rack Administrative procedure for rack operationsColor(red,Fail)?
10. InstaGENI Rack Administrative procedure for rack scheduled shutdownColor(green,Pass)? IG-ADM-3 procedure executed
11. InstaGENI Rack Administrative procedure for Emergency Stop. Color(green,Pass)? IG-ADM-4 procedure executed
12. InstaGENI Rack Administrative procedure for health status Color(red,Fail)?
13. InstaGENI Rack Site Operations documentation Color(red,Fail)?
14. Site Specific InstaGENI Deployment Data Color(red,Fail)?


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


InstaGENI Documentation Tests

The InstaGENI Documentation Tests focus on documentation review, and apply the following criteria for each document:

  • The document has been provided in a public location, which is http://www.protogeni.net/wiki/ for the InstaGENI project.
  • The document contains the required information.
  • The documented information appears to be accurate.

Rack documentation available and reviewed to find required information:

1. InstaGENI 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: Color(#98FB98,Pass: most criteria)?

The Rack Deployment page touches on some site requirements, but overall power and cooling requirements are not specified. The Rack Deployment page does spell up-link requirements. Rack addresses requirements are defined in the Rack Setup Questionnaire.

Some other helpful rack layout information is found in the Rack Connection page which captures the mapping of ports and required cable length. There is a Back of Rack diagram to further clarify rack connections.

2. InstaGENI Rack Part List Documentation

The goal of this evaluation:

To find a summary InstaGENI 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: Color(#98FB98,Pass: most criteria)?

No parts list was found at the http://www.protogeni.net/wiki. A Bill of materials, rack drawings, and diagrams can be found at GPO InstaGENI Manufacturing Documentation page. Should also be available at http://www.protogeni.net/wiki.

3. InstaGENI 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: Color(red,Fail)?

No document of procedure was found that details software versions and system configurations used in an InstaGENI rack. Pointers to the Google group emulab-admins was found in the Rack Deployment page, which leads users to some unstructured information about the subject.

4. InstaGENI and OS Upgrade Plans

The goal of this evaluation:

Find documentation that explains how and when InstaGENI 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: Color(green,Pass)?

Information is found about InstaGENI software and OS updates at the http://www.protogeni.net/wiki/instageni/software-update-process. There is mention of the expected handling of upgrades in the InstaGENI Design Document that InstaGENI Personnel will provide limited maintenance assistance to local administrators, but no further information was found.

5. InstaGENI Software Components Functional Description and Access to Source code

The goal of this evaluation:

Find documentation that provides a description of the InstaGENI 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: Color(red,Fail)?

No documentation was found at http://www.protogeni.net/wiki detailing the InstaGENI software and how to access its source code.

6. InstaGENI Rack Resources Usage and Policy Documentation

The goal of this evaluation: Color(red,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:

No documentation was found which provided an overview of resources and the existing policy for each.

7. InstaGENI 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: Color(red,Fail)?

No information was found about InstaGENI rack resource administration.

8. InstaGENI 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: Color(green,Pass)?

The Administrator Account page provides guidelines for creating administrative accounts.

9. InstaGENI 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: Color(red,Fail)?

No information was found about InstaGENI rack operations.

10. InstaGENI 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: Color(green,Pass)?

11. InstaGENI 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: Color(green,Pass)? The following documents are available:

12. InstaGENI 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: Color(red,Fail)?

No InstaGENI Rack Administrative procedure for health status was found.

13. InstaGENI 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: Color(red,Fail)?

NO plan found defining hand off plan for racks.

14. Site Specific InstaGENI 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: Color(red,Fail)?

No Site specific deployment data is available. Only a list of sites to be deployed is available at the GPO GENI Racks Deployment page.

Attachments (1)

Download all attachments as: .zip