docs/lab-description/lab_description.rst

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