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
  12 network topologies.  Compute, network and storage specifications with network topology details are
  13 required to help developers use lab resources efficiently while minimizing support needs. This also
  14 greatly assists with troubleshhoting. It is the responsibility of the lab owner to keep individual
  15 lab documents updated and determine appropriate level of detail that is exposed publically through
  16 the Wiki or maintained in a secure Pharos repo with controlled access.
  17
  18 While human readable configuration files are needed, the goal is for full automation of deployments.
  19 This requires a common machine readable format for POD configurations as input to every installer.
  20 This is the "POD inventory" common format file.
  21
  22
  23 .. toctree::
  24
  25    ./lab_description.rst
  26    ./pod_description.rst
  27    ./inventory.rst