summaryrefslogtreecommitdiffstats
path: root/docs/lab-description
diff options
context:
space:
mode:
authorJulien <zhang.jun3g@zte.com.cn>2017-08-17 21:32:10 +0800
committerJulien <zhang.jun3g@zte.com.cn>2017-08-17 21:32:10 +0800
commitaa88673c38be12368dead5e8241fb915d790c431 (patch)
tree38b2de3e04a7d14aa1f9aa73034e36d0c9d3357d /docs/lab-description
parent34f15a071a9df12986654593193235a21a774fc8 (diff)
restruct documents according to opnfvdocs
Use only development and release for we don't have test codes for now. JIRA: PHAROS-311 Change-Id: Iacfcaba81a7a52e09cf999b8603cc9dc2f8f2b97 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'docs/lab-description')
-rw-r--r--docs/lab-description/images/lab_topology_example.jpgbin54609 -> 0 bytes
-rw-r--r--docs/lab-description/images/pod_topology_example.pngbin45640 -> 0 bytes
-rw-r--r--docs/lab-description/index.rst27
-rw-r--r--docs/lab-description/inventory.rst11
-rw-r--r--docs/lab-description/lab_description.rst63
-rw-r--r--docs/lab-description/pod_description.rst99
6 files changed, 0 insertions, 200 deletions
diff --git a/docs/lab-description/images/lab_topology_example.jpg b/docs/lab-description/images/lab_topology_example.jpg
deleted file mode 100644
index d151e9b..0000000
--- a/docs/lab-description/images/lab_topology_example.jpg
+++ /dev/null
Binary files differ
diff --git a/docs/lab-description/images/pod_topology_example.png b/docs/lab-description/images/pod_topology_example.png
deleted file mode 100644
index 11d0997..0000000
--- a/docs/lab-description/images/pod_topology_example.png
+++ /dev/null
Binary files differ
diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst
deleted file mode 100644
index 23b675a..0000000
--- a/docs/lab-description/index.rst
+++ /dev/null
@@ -1,27 +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.
-
-.. 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 troubleshoting. It is the responsibility of the lab owner to keep individual
-lab documents updated and determine appropriate level of detail that is exposed publicly through
-the Wiki or maintained in a secure Pharos repo with controlled access.
-
-The goal of the Pharos Project is automation of resource provisioning. This requires machine
-readable inventory and network configuration files that follow common format.
-
-
-.. toctree::
- :maxdepth: 2
-
- ./lab_description.rst
- ./pod_description.rst
- ./inventory.rst
diff --git a/docs/lab-description/inventory.rst b/docs/lab-description/inventory.rst
deleted file mode 100644
index 81c0dd5..0000000
--- a/docs/lab-description/inventory.rst
+++ /dev/null
@@ -1,11 +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.
-
-******************
-POD Inventory File
-******************
-
-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.
diff --git a/docs/lab-description/lab_description.rst b/docs/lab-description/lab_description.rst
deleted file mode 100644
index d36e8c6..0000000
--- a/docs/lab-description/lab_description.rst
+++ /dev/null
@@ -1,63 +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_lab:
-
-**************************
-Lab Specification Template
-**************************
-
-Introduction
-------------
-
-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:** 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, ...
-
-
-Acceptable Usage Policy
------------------------
-
-Define lab user policies and expectations
-
-
-Remote Access Infrastructure
-----------------------------
-
-Describe lab remote access setup (typically VPN, also link speed, any known restrictions, etc.)
-
-
-Remote Access Procedure
------------------------
-
-Define lab process for requesting access to the lab (e.g. VPN guide,
-how to modify BIOS settings, etc.)
-
-
-Lab Documentation
------------------
-
-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_topology_example.jpg
- :alt: Lab diagram not found
diff --git a/docs/lab-description/pod_description.rst b/docs/lab-description/pod_description.rst
deleted file mode 100644
index 856d5c2..0000000
--- a/docs/lab-description/pod_description.rst
+++ /dev/null
@@ -1,99 +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_pod:
-
-**************************
-POD Specification 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, ...
-
-
-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 |
-+----------+--------+-------+---------------+-----------+--------+-----------+---------------------+-------------------+-------------------+-------+
-| 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 |
-+----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+
-| node1 | | | | | | | | | | |
-| | | | | | | | | | | |
-| | | | | | | | | | | |
-+----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+
-| node2 | | | | | | | | | | |
-| | | | | | | | | | | |
-| | | | | | | | | | | |
-+----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+
-| node3 | | | | | | | | | | |
-| | | | | | | | | | | |
-| | | | | | | | | | | |
-+----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+
-| node4 | | | | | | | | | | |
-| | | | | | | | | | | |
-| | | | | | | | | | | |
-+----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+
-| node5 | | | | | | | | | | |
-| | | | | | | | | | | |
-| | | | | | | | | | | |
-+----------+--------+-------+---------------+------+--------+---------+---------------------+------------------+------------------+-------+
-
-VPN Users
----------
-
-+----------+--------------+---------+-------------+------------+
-| Name | Email | Project | Role | Notes |
-+----------+--------------+---------+-------------+------------+
-| joe user | ju@gmail.com | Pharos | contributer | CI support |
-+----------+--------------+---------+-------------+------------+
-
-
-Firewall Rules
---------------
-
-+------------+------------+-------+
-| Port(s) | Service | Notes |
-+------------+------------+-------+
-| 22, 43, 80 | Jenkins CI | |
-+------------+------------+-------+
-
-
-POD Topology
-------------
-
-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