summaryrefslogtreecommitdiffstats
path: root/docs/lab-description
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-01-22 13:27:04 -0800
committerChristopherPrice <christopher.price@ericsson.com>2016-01-28 18:31:24 +0100
commit6a28ba866d3c0cd05041d9196c3bb0e2340bd2e7 (patch)
treea765c18b6975e5d6fc19bcd226ca7c28a8915095 /docs/lab-description
parentc4e926c285db44a5ec5ba4a895c8d3889e3358c0 (diff)
Removed old lab description template and replaced with new template.
Updates for ... 1) Lab description 2) POD description 3) Examples of lab tolpology and POD topology diagrams. These files were created using ideas from existing lab/POD descriptions and lab experience for rls B. (cp) provided some tidying up and random spelling fixes for the toolchain. Change-Id: I72a34be9e1c1509fd310b43562bf6d5aa1c459e7 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/lab-description')
-rw-r--r--docs/lab-description/images/lab_topology_example.jpgbin0 -> 54609 bytes
-rw-r--r--docs/lab-description/images/pod_topology_example.pngbin0 -> 45640 bytes
-rw-r--r--docs/lab-description/lab_description.rst51
-rw-r--r--docs/lab-description/lab_details_template.rst71
-rw-r--r--docs/lab-description/pod_description.rst90
5 files changed, 141 insertions, 71 deletions
diff --git a/docs/lab-description/images/lab_topology_example.jpg b/docs/lab-description/images/lab_topology_example.jpg
new file mode 100644
index 0000000..d151e9b
--- /dev/null
+++ b/docs/lab-description/images/lab_topology_example.jpg
Binary files differ
diff --git a/docs/lab-description/images/pod_topology_example.png b/docs/lab-description/images/pod_topology_example.png
new file mode 100644
index 0000000..11d0997
--- /dev/null
+++ b/docs/lab-description/images/pod_topology_example.png
Binary files differ
diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst
new file mode 100644
index 0000000..4ea0b12
--- /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
diff --git a/docs/lab-description/lab_details_template.rst b/docs/lab-description/lab_details_template.rst
deleted file mode 100644
index bcc909a..0000000
--- a/docs/lab-description/lab_details_template.rst
+++ /dev/null
@@ -1,71 +0,0 @@
-Pharos Lab Details Template
-============================
-
-Hardware details
------------------
-
-**General details**
-
-+----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+
-| Hostname | Node type | HW model | Storage | CPU model | # Sockets | Memory [GB] | # NIC [MAC / IP / VLAN id] | BW |
-+----------------+------------------+----------------------+-----------------------+------------------+-----------+-------------+----------------------------------------------+---------+
-| galileo | network | Dell R730 | 3 x 1TB (raid 5) | IntelE5-2690 v2 | 2 | 64 | 1 # 00:ae:ff:cc:dd:12 / 192.168.22.10 / 1003 | 10 Gbps |
-| | | | | | | | 2 # 00:11:22:33:44:55 / 10.7.8.10 / 1 | 1 Gbps |
-+----------------+------------------+----------------------+-----------------------+--------------+-----------+-------------+-------------------------------------------+------+---------+
-
-**Lights-out**
-
-+----------------+-------------------------------+------------------+---------------------+
-| Hostname | Lights-out address | Username | Password |
------------------+-------------------------------+------------------+---------------------+
-| | | | |
-+----------------+-------------------------------+------------------+---------------------+
-
-
-Software
----------
-
-**OS**
-
-
-**Pre-provisioned software**
-
-
-Network
---------
-
-**Subnet allocations**
-
-+--------------+-------------------+-------------------+---------------+---------+
-| Net name | Address | Mask | Gateway | VLAN id |
-+--------------+-------------------+-------------------+---------------+---------+
-| | | | | |
-+--------------+-------------------+-------------------+---------------+---------+
-
-
-**Firewall rules**
-
-
-**Diagrams**
-
-.. image:: images/<lab-name>_<diagram-name>.png|.jpg
- :alt: Name of the diagram
-
-Remote access infrastructure
------------------------------
-
-**Explanations**
-
-**Diagrams**
-
-.. image:: images/<lab-name>_<diagram-name>.png|.jpg
- :alt: Name of the diagram
-
-
-Documentation tracking
------------------------
-
-Revision: _sha1_
-
-Build date: _date_
-
diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst
new file mode 100644
index 0000000..a3fed8c
--- /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