summaryrefslogtreecommitdiffstats
path: root/docs/lab-description
diff options
context:
space:
mode:
authorTrevor Cooper <trevor.cooper@intel.com>2016-02-23 23:12:24 -0800
committerTrevor Cooper <trevor.cooper@intel.com>2016-02-24 15:02:42 -0800
commitc8f8facec439fbc4fced0854845070caf9db38a5 (patch)
tree63e82faa04f6ded59b869838240b803718418445 /docs/lab-description
parentb2231a970fb73f4f5df72b59ed9d58a039644ac3 (diff)
Removed index files from all doc directories, rearranged headings, fixed broken links and doc formatting issues, created platform overview file, edited content.brahmaputra.1.0
Change-Id: I08113c732dc6bc5967fe263aecfa8734e4c98ee5 Signed-off-by: Trevor Cooper <trevor.cooper@intel.com>
Diffstat (limited to 'docs/lab-description')
-rw-r--r--docs/lab-description/index.rst18
-rw-r--r--docs/lab-description/inventory.rst13
-rw-r--r--docs/lab-description/lab_description.rst49
-rw-r--r--docs/lab-description/pod_description.rst25
-rw-r--r--docs/lab-description/templates.rst26
5 files changed, 72 insertions, 59 deletions
diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst
deleted file mode 100644
index 0184b02..0000000
--- a/docs/lab-description/index.rst
+++ /dev/null
@@ -1,18 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) 2016 OPNFV.
-
-****************************************
-Pharos Templates and Configuration Files
-****************************************
-
-.. toctree::
- :maxdepth: 2
-
- ./lab_description.rst
- ./pod_description.rst
- ./inventory.rst
-
-Revision: _sha1_
-
-Build date: |today|
diff --git a/docs/lab-description/inventory.rst b/docs/lab-description/inventory.rst
index e3f3e05..db1ea54 100644
--- a/docs/lab-description/inventory.rst
+++ b/docs/lab-description/inventory.rst
@@ -2,13 +2,10 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
-=========================
-Pharos POD Inventory File
-=========================
+******************
+POD Inventory File
+******************
-Introduction
-------------
-
-The Common Inventory File provides for a machine reabable format to input into every installer. For convenience the
+The Common Inventory File provides a template for machine reabable input into every installer. For convenience the
YAML file template currently resides in the Genesis Project repo. Refer to the following patch for further infomation
-https://gerrit.opnfv.org/gerrit/#/c/4079
+https://gerrit.opnfv.org/gerrit/#/c/4079.
diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst
index 5b52baf..da84aa1 100644
--- a/docs/lab-description/lab_description.rst
+++ b/docs/lab-description/lab_description.rst
@@ -2,10 +2,11 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
+.. _pharos_lab:
-===============================
-Pharos Lab Description Template
-===============================
+**************************
+Lab Specification Template
+**************************
Introduction
------------
@@ -14,44 +15,48 @@ 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 |
+| POD Name | Project(s) | Project Lead(s)| Email(s) | POD Role | Status | Notes |
+----------------+----------------+----------------+----------------+----------------+----------------+----------------+
-| POD1 | example | John Doe | john@intel.com | CI: stable | Active | |
+| POD1 | project name | John Doe | john@abc.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, ...
+* **POD Name:** Use consistent naming / numbering to avoid confusion. Hyperlinked to POD description.
+* **POD Role:** CI stable, CI latest, Dev/test, Stand-alone, Virtual, ...
+* **Status:** Assigned, Configuring, Active, Troubleshooting, Available, ...
-Code of Conduct
-===============
+Acceptable Usage Policy
+-----------------------
-Define your lab's policies and expectations here
+Define lab user policies and expectations
Remote Access Infrastructure
-============================
+----------------------------
-Describe your lab remote access setup (type of access (VPN?), link speed, any restrictions, etc.)
+Describe lab remote access setup (typically VPN, also link speed, any known restrictions, etc.)
-Remote Access Process
-=====================
+Remote Access Procedure
+-----------------------
-Define your lab's 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.)
-Documentation
-=============
+Lab Documentation
+-----------------
-List your lab specific documents here
+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.
-.. image:: images/<lab-name>_<diagram-name>.png|.jpg
- :alt: Name of the diagram
+.. 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 c44f116..b63097d 100644
--- a/docs/lab-description/pod_description.rst
+++ b/docs/lab-description/pod_description.rst
@@ -2,10 +2,11 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) 2016 OPNFV.
+.. _pharos_pod:
-===================================
-Pharos Lab POD description Template
-===================================
+**************************
+POD Specification Template
+**************************
Introduction
------------
@@ -20,11 +21,10 @@ Describe any addional POD requirements beyond a standard Pharos compliant POD e.
shared usage, ...
-Systems
--------
+Server Specifications
+---------------------
-Jump Host
-^^^^^^^^^
+**Jump Host**
+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | |
@@ -41,8 +41,8 @@ Jump Host
+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
-Nodes
-^^^^^
+**Compute Nodes**
+
+--------------+--------------+--------------+--------------+--------------+--------------+--------------+------------------------+------------------------+------------------------+--------------+
| | | | | | | Local | Lights-out network | 1GbE: NIC#/IP | 10GbE: NIC#/IP | |
@@ -92,5 +92,8 @@ Firewall Rules
POD Topology
------------
-.. image:: images/<lab-name>_<diagram-name>.png|.jpg
- :alt: Name of the diagram
+Provide a diagram showing the network topology of the POD. Any security sensitive details should
+not be exposed publically and can be stored in the secure Pharos repo. The following diagram is an example only.
+
+.. image:: ./images/pod_topology_example.png
+ :alt: POD diagram not found
diff --git a/docs/lab-description/templates.rst b/docs/lab-description/templates.rst
new file mode 100644
index 0000000..f845457
--- /dev/null
+++ b/docs/lab-description/templates.rst
@@ -0,0 +1,26 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 OPNFV.
+
+.. Top level of Pharos templates and configuration files
+
+****************************************
+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 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 the Wiki or maintained in a secure Pharos repo with controlled access.
+
+While human readable configuration files are needed, the goal is for full automation of deployments. This requires
+a common machine readable format for POD configurations as input to every installer. This is the "POD inventory"
+common format file.
+
+
+.. toctree::
+
+ ./lab_description.rst
+ ./pod_description.rst
+ ./inventory.rst