diff options
Diffstat (limited to 'docs/lab-description')
| -rw-r--r-- | docs/lab-description/lab_description.rst | 17 | ||||
| -rw-r--r-- | docs/lab-description/pod_description.rst | 95 | ||||
| -rw-r--r-- | docs/lab-description/templates.rst | 2 |
3 files changed, 57 insertions, 57 deletions
diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst index da84aa11..d36e8c6f 100644 --- a/docs/lab-description/lab_description.rst +++ b/docs/lab-description/lab_description.rst @@ -17,11 +17,11 @@ Add an summary of what your lab hosts, its focus areas and purpose Lab Resources ------------- -+----------------+----------------+----------------+----------------+----------------+----------------+----------------+ -| POD Name | Project(s) | Project Lead(s)| Email(s) | POD Role | Status | Notes | -+----------------+----------------+----------------+----------------+----------------+----------------+----------------+ -| POD1 | project name | John Doe | john@abc.com | CI: stable | Active | | -+----------------+----------------+----------------+----------------+----------------+----------------+----------------+ ++----------+--------------+-----------------+--------------+-------------+---------+-------+ +| POD Name | Project(s) | Project Lead(s) | Email(s) | POD Role | Status | Notes | ++----------+--------------+-----------------+--------------+-------------+---------+-------+ +| POD1 | Project Name | John Doe | john@abc.com | CI: stable | Active | | ++----------+--------------+-----------------+--------------+-------------+---------+-------+ * **POD Name:** Use consistent naming / numbering to avoid confusion. Hyperlinked to POD description. * **POD Role:** CI stable, CI latest, Dev/test, Stand-alone, Virtual, ... @@ -43,7 +43,8 @@ Describe lab remote access setup (typically VPN, also link speed, any known rest Remote Access Procedure ----------------------- -Define lab process for requesting access to the lab (e.g. VPN guide, how to modify BIOS settings, etc.) +Define lab process for requesting access to the lab (e.g. VPN guide, +how to modify BIOS settings, etc.) Lab Documentation @@ -55,8 +56,8 @@ List lab specific documents here Lab Topology ------------ -Provide a diagram showing the network topology of lab including lights-out network. Any security sensitive details should -not be exposed publically. The following diagram is an example only. +Provide a diagram showing the network topology of lab including lights-out network. Any security +sensitive details should not be exposed publically. The following diagram is an example only. .. image:: ./images/lab_topology_example.jpg :alt: Lab diagram not found diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst index 2d4047a8..856d5c22 100644 --- a/docs/lab-description/pod_description.rst +++ b/docs/lab-description/pod_description.rst @@ -26,67 +26,66 @@ Server Specifications **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 | | -+--------------+---------+-------+---------------+--------------+--------+-----------+---------------------+-------------------+-------------------+-------+ ++----------+--------+-------+---------------+-----------+--------+-----------+---------------------+-------------------+-------------------+-------+ +| | | | | | | 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 | ++----------+--------+-------+---------------+-----------+--------+-----------+---------------------+-------------------+-------------------+-------+ +| jump | Dell | R730 | ABCDEF007 | E5-2699x2 | 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 | | ++----------+--------+-------+---------------+-----------+--------+-----------+---------------------+-------------------+-------------------+-------+ **Compute 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 | | | | | | | | | | | -| | | | | | | | | | | | -| | | | | | | | | | | | -+---------------+---------+-------+---------------+-------+--------+---------+---------------------+------------------+------------------+-------+ ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ +| | | | | | | 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 | ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ +| node1 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ +| node2 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ +| node3 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ +| node4 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ +| node5 | | | | | | | | | | | +| | | | | | | | | | | | +| | | | | | | | | | | | ++----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+ VPN Users --------- -+--------------+--------------+--------------+--------------+--------------+ -| Name | Email | Project | Role | Notes | -+--------------+--------------+--------------+--------------+--------------+ -| joe user | ju@gmail.com | Pharos | contributer | CI support | -+--------------+--------------+--------------+--------------+--------------+ ++----------+--------------+---------+-------------+------------+ +| 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 | | -+--------------+--------------+--------------+ ++------------+------------+-------+ +| Port(s) | Service | Notes | ++------------+------------+-------+ +| 22, 43, 80 | Jenkins CI | | ++------------+------------+-------+ POD Topology diff --git a/docs/lab-description/templates.rst b/docs/lab-description/templates.rst index c207cfa7..33cc5559 100644 --- a/docs/lab-description/templates.rst +++ b/docs/lab-description/templates.rst @@ -9,7 +9,7 @@ Pharos Templates and Configuration Files **************************************** Lab and POD templates are provided to help lab owners document capabilities, configurations and -network topologies. Compute, network and storage specifications with network topology details are +network topologies. Compute, network and storage specifications with network topology details are required to help developers use lab resources efficiently while minimizing support needs. This also greatly assists with troubleshhoting. It is the responsibility of the lab owner to keep individual lab documents updated and determine appropriate level of detail that is exposed publically through |