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/configguide/index.rst | 25 +++++++++++++++++++++++++ docs/configguide/pharosconfig.rst | 25 ------------------------- docs/index.rst | 17 +++++------------ docs/information/index.rst | 14 ++++++++++++++ docs/information/pharos.rst | 7 ------- docs/lab-description/index.rst | 28 ++++++++++++++++++++++++++++ docs/lab-description/templates.rst | 27 --------------------------- docs/labs/index.rst | 20 ++++++++++++++++++++ docs/labs/ool/index.rst | 16 ++++++++++++++++ docs/labs/ool/ool.rst | 16 ---------------- docs/labs/orange-paris-lab/index.rst | 15 +++++++++++++++ docs/labs/orange-paris-lab/orange_paris.rst | 15 --------------- docs/labs/zte-nj-lab/index.rst | 16 ++++++++++++++++ docs/labs/zte-nj-lab/zte-nj.rst | 16 ---------------- docs/labs/zte-sh-lab/index.rst | 15 +++++++++++++++ docs/labs/zte-sh-lab/zte-sh.rst | 15 --------------- 16 files changed, 154 insertions(+), 133 deletions(-) create mode 100644 docs/configguide/index.rst delete mode 100644 docs/configguide/pharosconfig.rst create mode 100644 docs/information/index.rst create mode 100644 docs/lab-description/index.rst delete mode 100644 docs/lab-description/templates.rst create mode 100755 docs/labs/index.rst create mode 100644 docs/labs/ool/index.rst delete mode 100644 docs/labs/ool/ool.rst create mode 100644 docs/labs/orange-paris-lab/index.rst delete mode 100644 docs/labs/orange-paris-lab/orange_paris.rst create mode 100644 docs/labs/zte-nj-lab/index.rst delete mode 100644 docs/labs/zte-nj-lab/zte-nj.rst create mode 100644 docs/labs/zte-sh-lab/index.rst delete mode 100644 docs/labs/zte-sh-lab/zte-sh.rst (limited to 'docs') diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst new file mode 100644 index 00000000..6b48100a --- /dev/null +++ b/docs/configguide/index.rst @@ -0,0 +1,25 @@ +.. 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 configuration documents. + +******************** +Pharos Configuration +******************** + +OPNFV development, test and production activities rely on Pharos resources and support from the +Pharos community. Lab owners and Pharos project committers/contributors will evolve the vision for +Pharos as well as expand lab capabilities that are needed to help OPNFV be highly successful. + +Pharos configuration documents provide information on how to setup hardware and networks in a Pharos +compliant lab. Jira is used to track Pharos activities including lab operations. PODs are connected +to Jenkins and generally available 24/7 other than scheduled maintenance and troubleshooting. Lab +resources are declared as either for *Development (bare-metal or virtual)*, *Production latest +(bare-metal)* or *Production stable (bare-metal)* + +.. toctree:: + + ./configguide.rst + ./lab_update_guide.rst + ./jumpserverinstall.rst diff --git a/docs/configguide/pharosconfig.rst b/docs/configguide/pharosconfig.rst deleted file mode 100644 index 6b48100a..00000000 --- a/docs/configguide/pharosconfig.rst +++ /dev/null @@ -1,25 +0,0 @@ -.. 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 configuration documents. - -******************** -Pharos Configuration -******************** - -OPNFV development, test and production activities rely on Pharos resources and support from the -Pharos community. Lab owners and Pharos project committers/contributors will evolve the vision for -Pharos as well as expand lab capabilities that are needed to help OPNFV be highly successful. - -Pharos configuration documents provide information on how to setup hardware and networks in a Pharos -compliant lab. Jira is used to track Pharos activities including lab operations. PODs are connected -to Jenkins and generally available 24/7 other than scheduled maintenance and troubleshooting. Lab -resources are declared as either for *Development (bare-metal or virtual)*, *Production latest -(bare-metal)* or *Production stable (bare-metal)* - -.. toctree:: - - ./configguide.rst - ./lab_update_guide.rst - ./jumpserverinstall.rst diff --git a/docs/index.rst b/docs/index.rst index 36b48f52..94844fa9 100755 --- a/docs/index.rst +++ b/docs/index.rst @@ -17,19 +17,12 @@ OPNFV Community Lab Infrastructure :maxdepth: 3 :numbered: 3 - ./information/pharos.rst - ./specification/pharosspec.rst - ./lab-description/templates.rst - ./configguide/pharosconfig.rst - ./labs/Dell.rst - ./labs/huawei-us-lab/huawei-us-lab.rst - ./labs/ool/ool.rst - ./labs/orange-paris-lab/orange_paris.rst - ./labs/spirent.rst - ./labs/zte-nj-lab/zte-nj.rst - ./labs/zte-sh-lab/zte-sh.rst + ./information/index.rst + ./specification/index.rst + ./lab-description/index.rst + ./configguide/index.rst + ./labs/index.rst Indices ======= * :ref:`search` - diff --git a/docs/information/index.rst b/docs/information/index.rst new file mode 100644 index 00000000..0311526a --- /dev/null +++ b/docs/information/index.rst @@ -0,0 +1,14 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +************************** +Pharos Project Information +************************** + + +.. toctree:: + :maxdepth: 2 + + ./pharos.rst diff --git a/docs/information/pharos.rst b/docs/information/pharos.rst index 24e46d97..3a250c5c 100644 --- a/docs/information/pharos.rst +++ b/docs/information/pharos.rst @@ -2,13 +2,6 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2016 OPNFV. -.. OPNFV Pharos Project Information file. - -.. _pharos_information: - -************************** -Pharos Project Information -************************** Introduction ------------ 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 diff --git a/docs/lab-description/templates.rst b/docs/lab-description/templates.rst deleted file mode 100644 index 33cc5559..00000000 --- a/docs/lab-description/templates.rst +++ /dev/null @@ -1,27 +0,0 @@ -.. 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 diff --git a/docs/labs/index.rst b/docs/labs/index.rst new file mode 100755 index 00000000..2d6ece49 --- /dev/null +++ b/docs/labs/index.rst @@ -0,0 +1,20 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 +.. (c) 2016 OPNFV. + + +===================== +PHAROS Community Labs +===================== + + +.. toctree:: + :maxdepth: 2 + + ./Dell.rst + ./huawei-us-lab/huawei-us-lab.rst + ./ool/index.rst + ./orange-paris-lab/index.rst + ./spirent.rst + ./zte-nj-lab/index.rst + ./zte-sh-lab/index.rst diff --git a/docs/labs/ool/index.rst b/docs/labs/ool/index.rst new file mode 100644 index 00000000..6be3f1be --- /dev/null +++ b/docs/labs/ool/index.rst @@ -0,0 +1,16 @@ +.. 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 + +***************** +OOL OPNFV Testbed +***************** + +.. toctree:: + + ./lab_description.rst + ./pod1_description.rst + ./virtual1_description.rst + ./inventory.rst diff --git a/docs/labs/ool/ool.rst b/docs/labs/ool/ool.rst deleted file mode 100644 index 6be3f1be..00000000 --- a/docs/labs/ool/ool.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. 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 - -***************** -OOL OPNFV Testbed -***************** - -.. toctree:: - - ./lab_description.rst - ./pod1_description.rst - ./virtual1_description.rst - ./inventory.rst diff --git a/docs/labs/orange-paris-lab/index.rst b/docs/labs/orange-paris-lab/index.rst new file mode 100644 index 00000000..113d5815 --- /dev/null +++ b/docs/labs/orange-paris-lab/index.rst @@ -0,0 +1,15 @@ +.. 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 + +*********************************************** +Orange Paris Pharos Lab and Configuration Files +*********************************************** + + +.. toctree:: + + ./orange_paris_lab_description.rst + ./orange_paris_pod1_description.rst diff --git a/docs/labs/orange-paris-lab/orange_paris.rst b/docs/labs/orange-paris-lab/orange_paris.rst deleted file mode 100644 index 113d5815..00000000 --- a/docs/labs/orange-paris-lab/orange_paris.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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 - -*********************************************** -Orange Paris Pharos Lab and Configuration Files -*********************************************** - - -.. toctree:: - - ./orange_paris_lab_description.rst - ./orange_paris_pod1_description.rst diff --git a/docs/labs/zte-nj-lab/index.rst b/docs/labs/zte-nj-lab/index.rst new file mode 100644 index 00000000..94fb322f --- /dev/null +++ b/docs/labs/zte-nj-lab/index.rst @@ -0,0 +1,16 @@ +.. 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 + +***************************************** +ZTE NJ Pharos Lab and Configuration Files +***************************************** + + +.. toctree:: + + ./lab_description.rst + ./pod1_description.rst + ./pod2_description.rst diff --git a/docs/labs/zte-nj-lab/zte-nj.rst b/docs/labs/zte-nj-lab/zte-nj.rst deleted file mode 100644 index 94fb322f..00000000 --- a/docs/labs/zte-nj-lab/zte-nj.rst +++ /dev/null @@ -1,16 +0,0 @@ -.. 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 - -***************************************** -ZTE NJ Pharos Lab and Configuration Files -***************************************** - - -.. toctree:: - - ./lab_description.rst - ./pod1_description.rst - ./pod2_description.rst diff --git a/docs/labs/zte-sh-lab/index.rst b/docs/labs/zte-sh-lab/index.rst new file mode 100644 index 00000000..e48c21d4 --- /dev/null +++ b/docs/labs/zte-sh-lab/index.rst @@ -0,0 +1,15 @@ +.. 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 + +************************************* +ZTE SH Pharos Lab Configuration Files +************************************* + + +.. toctree:: + + ./lab_description.rst + ./pod3_description.rst diff --git a/docs/labs/zte-sh-lab/zte-sh.rst b/docs/labs/zte-sh-lab/zte-sh.rst deleted file mode 100644 index e48c21d4..00000000 --- a/docs/labs/zte-sh-lab/zte-sh.rst +++ /dev/null @@ -1,15 +0,0 @@ -.. 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 - -************************************* -ZTE SH Pharos Lab Configuration Files -************************************* - - -.. toctree:: - - ./lab_description.rst - ./pod3_description.rst -- cgit 1.2.3-korg