summaryrefslogtreecommitdiffstats
path: root/docs/lab-description/pod_description.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/lab-description/pod_description.rst')
-rw-r--r--docs/lab-description/pod_description.rst90
1 files changed, 90 insertions, 0 deletions
diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst
new file mode 100644
index 00000000..a3fed8c3
--- /dev/null
+++ b/docs/lab-description/pod_description.rst
@@ -0,0 +1,90 @@
+Pharos Lab POD description Template
+===================================
+
+Introduction
+------------
+
+Add an summary of the POD usage (Project, CI stable, CI latest, dev/test, stand-alone servers, etc.)
+
+
+Additional Requirements
+-----------------------
+
+Describe any addional POD requirements beyond a standard Pharos compliant POD e.g. test equipment,
+shared usage, ...
+
+
+Systems
+-------
+
+Jump Host
+^^^^^^^^^
+
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | |
+| Hostname | Vendor | Model | Serial Number| CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| pod2-jp-jump | Dell | R730 | ABCDEF007 | 2 x E5-2699 | 64 GB | 240GB SSD | 10.10.10.10 | IF0: 10.2.117.36 | IF2: 10.2.12.1 | |
+| | | | | | | 1 TB SATA | 00:1E:67:D4:36:9A | 00:1E:67:4F:B7:B1 | 00:1E:67:4F:B7:B4 | |
+| | | | | | | | root/root | VLAN 984 | VLAN 202 | |
+| | | | | | | | | Public | Private | |
+| | | | | | | | | IF1: 10.2.1.1 | IF3: 10.2.13.1 | |
+| | | | | | | | | 00:1E:67:4F:B7:B2 | 00:1E:67:4F:B7:B5 | |
+| | | | | | | | | VLAN 201 | VLAN 203 | |
+| | | | | | | | | Admin | Storage | |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+
+
+Nodes
+^^^^^
+
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | |
+| Hostname | Vendor | Model | Serial Number| CPUs | Memory | storage | (IPMI): IP/MAC, U/P | MAC/VLAN/Network | MAC/VLAN/Network | Notes |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| pod2-jp-node1| | | | | | | | | | |
+| | | | | | | | | | | |
+| | | | | | | | | | | |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| pod2-jp-node2| | | | | | | | | | |
+| | | | | | | | | | | |
+| | | | | | | | | | | |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| pod2-jp-node3| | | | | | | | | | |
+| | | | | | | | | | | |
+| | | | | | | | | | | |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| pod2-jp-node4| | | | | | | | | | |
+| | | | | | | | | | | |
+| | | | | | | | | | | |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+| pod2-jp-node5| | | | | | | | | | |
+| | | | | | | | | | | |
+| | | | | | | | | | | |
++--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
+
+VPN Users
+---------
+
++--------------+--------------+--------------+--------------+--------------+
+| Name | Email | Project | Role | Notes |
++--------------+--------------+--------------+--------------+--------------+
+| joe user | ju@gmail.com | Pharos | contributer | CI support |
++--------------+--------------+--------------+--------------+--------------+
+
+
+Firewall Rules
+--------------
+
++--------------+--------------+--------------+
+| Port(s) | Service | Note |
++--------------+--------------+--------------+
+| 22, 43, 80 | Jenkins CI | |
++--------------+--------------+--------------+
+
+
+POD Topology
+------------
+
+.. image:: images/<lab-name>_<diagram-name>.png|.jpg
+ :alt: Name of the diagram