docs/lab-description/templates.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. (c) 2016 OPNFV.
   4
   5 .. Top level of Pharos templates and configuration files
   6
   7 ****************************************
   8 Pharos Templates and Configuration Files
   9 ****************************************
  10
  11 Lab and POD templates are provided to help lab owners document capabilities, configurations and network topologies.
  12 Compute, network and storage specifications with network topology details are required to help developers use lab
  13 resources efficiently while minimizing support needs. This also greatly assists with troubleshhoting. It is the
  14 responsibility of the lab owner to keep individual lab documents updated and determine appropriate level of detail
  15 that is exposed publically through the Wiki or maintained in a secure Pharos repo with controlled access.
  16
  17 While human readable configuration files are needed, the goal is for full automation of deployments. This requires
  18 a common machine readable format for POD configurations as input to every installer. This is the "POD inventory"
  19 common format file.
  20
  21
  22 .. toctree::
  23
  24    ./lab_description.rst
  25    ./pod_description.rst
  26    ./inventory.rst