From ff9708c9ce539b2d742db00ff2ac6e92e4ee3681 Mon Sep 17 00:00:00 2001 From: Trevor Cooper Date: Tue, 23 Feb 2016 23:12:24 -0800 Subject: Removed index files from all doc directories, rearranged headings, fixed broken links and doc formatting issues, created platform overview file, edited content. Change-Id: I08113c732dc6bc5967fe263aecfa8734e4c98ee5 Signed-off-by: Trevor Cooper (cherry picked from commit c8f8facec439fbc4fced0854845070caf9db38a5) --- docs/lab-description/templates.rst | 26 ++++++++++++++++++++++++++ 1 file changed, 26 insertions(+) create mode 100644 docs/lab-description/templates.rst (limited to 'docs/lab-description/templates.rst') diff --git a/docs/lab-description/templates.rst b/docs/lab-description/templates.rst new file mode 100644 index 00000000..f845457d --- /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 -- cgit 1.2.3-korg