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
   6 ===============================
   7 Pharos Lab Description Template
   8 ===============================
   9
  10 Introduction
  11 ------------
  12
  13 Add an summary of what your lab hosts, its focus areas and purpose
  14
  15
  16 Lab Resources
  17 =============
  18
  19 +----------------+----------------+----------------+----------------+----------------+----------------+----------------+
  20 | Resource       | Project(s)     | Project Lead   | Email(s)       |  POD Role*     |  Status**      | Notes          |
  21 +----------------+----------------+----------------+----------------+----------------+----------------+----------------+
  22 | POD1           |  example       | John Doe       | john@intel.com |  CI: stable    |  Active        |                |
  23 +----------------+----------------+----------------+----------------+----------------+----------------+----------------+
  24
  25 * POD Role: CI stable, CI latest, Dev/test, Stand-alone, ...
  26 ** Status: Assigned, Configuration in progress, Active, Troubleshooting, Can be re-purposed, ...
  27
  28
  29 Code of Conduct
  30 ===============
  31
  32 Define your lab's  policies and expectations here
  33
  34
  35 Remote Access Infrastructure
  36 ============================
  37
  38 Describe your lab remote access setup (type of access (VPN?), link speed, any restrictions, etc.)
  39
  40
  41 Remote Access Process
  42 =====================
  43
  44 Define your lab's process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.)
  45
  46
  47 Documentation
  48 =============
  49
  50 List your lab specific documents here
  51
  52
  53 Lab Topology
  54 ============
  55
  56 .. image:: images/<lab-name>_<diagram-name>.png|.jpg
  57    :alt: Name of the diagram