summaryrefslogtreecommitdiffstats
path: root/docs/lab-description/index.rst
diff options
context:
space:
mode:
authorJulien <zhang.jun3g@zte.com.cn>2016-08-17 22:59:18 +0800
committerJulien <zhang.jun3g@zte.com.cn>2016-08-22 10:37:24 +0800
commitdc98986c0cacfdf10e8f22ad9c3fb804cc2c37d3 (patch)
treea3eba3d30223fe10d306dde251662a40424c1f56 /docs/lab-description/index.rst
parente556a63cc5f78598e890346889948765906a6411 (diff)
Update according DOCS
Each path use a index.rst file to include all the rst files: 1). Add missing index.rst 2). Rename some file to index.rst 3). Ude a index.rst to include all the community labs(currently all the labs are at the top level) Change-Id: I9bb6903328a8d445121982dd662df9eeceb23ff5 Signed-off-by: Julien <zhang.jun3g@zte.com.cn>
Diffstat (limited to 'docs/lab-description/index.rst')
-rw-r--r--docs/lab-description/index.rst28
1 files changed, 28 insertions, 0 deletions
diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst
new file mode 100644
index 0000000..1dfacc8
--- /dev/null
+++ b/docs/lab-description/index.rst
@@ -0,0 +1,28 @@
+.. 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::
+ :maxdepth: 2
+
+ ./lab_description.rst
+ ./pod_description.rst
+ ./inventory.rst