From dc98986c0cacfdf10e8f22ad9c3fb804cc2c37d3 Mon Sep 17 00:00:00 2001 From: Julien Date: Wed, 17 Aug 2016 22:59:18 +0800 Subject: 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 --- docs/lab-description/index.rst | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 docs/lab-description/index.rst (limited to 'docs/lab-description/index.rst') diff --git a/docs/lab-description/index.rst b/docs/lab-description/index.rst new file mode 100644 index 00000000..1dfacc8a --- /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 -- cgit 1.2.3-korg