docs/lab-description/lab_description.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2016 OPNFV.
   4
   5 .. _pharos_lab:
   6
   7 **************************
   8 Lab Specification Template
   9 **************************
  10
  11 Introduction
  12 ------------
  13
  14 Add an summary of what your lab hosts, its focus areas and purpose
  15
  16
  17 Lab Resources
  18 -------------
  19
  20 +----------+--------------+-----------------+--------------+-------------+---------+-------+
  21 | POD Name | Project(s)   | Project Lead(s) | Email(s)     |  POD Role   |  Status | Notes |
  22 +----------+--------------+-----------------+--------------+-------------+---------+-------+
  23 | POD1     | Project Name | John Doe        | john@abc.com |  CI: stable |  Active |       |
  24 +----------+--------------+-----------------+--------------+-------------+---------+-------+
  25
  26 * **POD Name:** Use consistent naming / numbering to avoid confusion. Hyperlinked to POD description.
  27 * **POD Role:** CI stable, CI latest, Dev/test, Stand-alone, Virtual, ...
  28 * **Status:** Assigned, Configuring, Active, Troubleshooting, Available, ...
  29
  30
  31 Acceptable Usage Policy
  32 -----------------------
  33
  34 Define lab user policies and expectations
  35
  36
  37 Remote Access Infrastructure
  38 ----------------------------
  39
  40 Describe lab remote access setup (typically VPN, also link speed, any known restrictions, etc.)
  41
  42
  43 Remote Access Procedure
  44 -----------------------
  45
  46 Define lab process for requesting access to the lab (e.g. VPN guide,
  47 how to modify BIOS settings, etc.)
  48
  49
  50 Lab Documentation
  51 -----------------
  52
  53 List lab specific documents here
  54
  55
  56 Lab Topology
  57 ------------
  58
  59 Provide a diagram showing the network topology of lab including lights-out network. Any security
  60 sensitive details should not be exposed publically. The following diagram is an example only.
  61
  62 .. image:: ./images/lab_topology_example.jpg
  63    :alt: Lab diagram not found