summaryrefslogtreecommitdiffstats
path: root/docs/lab-description/lab_description.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/lab-description/lab_description.rst')
-rw-r--r--docs/lab-description/lab_description.rst51
1 files changed, 51 insertions, 0 deletions
diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst
new file mode 100644
index 00000000..4ea0b124
--- /dev/null
+++ b/docs/lab-description/lab_description.rst
@@ -0,0 +1,51 @@
+Pharos Lab Description Template
+===============================
+
+Introduction
+------------
+
+Add an summary of what your lab hosts, its focus areas and purpose
+
+
+Lab Resources
+=============
+
++----------------+----------------+----------------+----------------+----------------+----------------+----------------+
+| Resource | Project(s) | Project Lead | Email(s) | POD Role* | Status** | Notes |
++----------------+----------------+----------------+----------------+----------------+----------------+----------------+
+| POD1 | example | John Doe | john@intel.com | CI: stable | Active | |
++----------------+----------------+----------------+----------------+----------------+----------------+----------------+
+
+* POD Role: CI stable, CI latest, Dev/test, Stand-alone, ...
+** Status: Assigned, Configuration in progress, Active, Troubleshooting, Can be re-purposed, ...
+
+
+Code of Conduct
+===============
+
+Define your lab's policies and expectations here
+
+
+Remote Access Infrastructure
+============================
+
+Describe your lab remote access setup (type of access (VPN?), link speed, any restrictions, etc.)
+
+
+Remote Access Process
+=====================
+
+Define your lab's process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.)
+
+
+Documentation
+=============
+
+List your lab specific documents here
+
+
+Lab Topology
+============
+
+.. image:: images/<lab-name>_<diagram-name>.png|.jpg
+ :alt: Name of the diagram