diff options
| author |   Sofia Wallin <sofia.wallin@ericsson.com> | 2016-11-23 14:49:15 +0100 |
|---|---|---|
| committer | Sofia Wallin <sofia.wallin@ericsson.com> | 2016-11-24 16:21:30 +0100 |
| commit | d438301ca7244e66d5082312e3e84fcfb219f11b (patch) | |
| tree | 858fc757706d451ac52e17ba75e4c0d7b4a2ef6d | |
| parent | 978b48ae0117c80d3dc7cced5e09e08e9efe929b (diff) | |
Adjusted the docs repo structure for D release work
Change-Id: I9befe06c424c726e17d754bc480413b2430549ba
Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com>
| -rw-r--r-- | docs/configurationguide/abstract.rst | 19 | ||||
| -rw-r--r-- | docs/configurationguide/configuration.options.render.rst | 27 | ||||
| -rw-r--r-- | docs/configurationguide/feature.configuration.description.rst | 22 | ||||
| -rw-r--r-- | docs/configurationguide/index.rst | 18 | ||||
| -rw-r--r-- | docs/configurationguide/scenario.description.rst | 10 | ||||
| -rw-r--r-- | docs/development/feature.templates/scenarios/scenario.name/index.rst (renamed from docs/feature.templates/scenarios/scenario.name/index.rst) | 0 | ||||
| -rw-r--r-- | docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst (renamed from docs/feature.templates/scenarios/scenario.name/scenario.description.rst) | 0 | ||||
| -rw-r--r-- | docs/development/feature.templates/userguide/feature.userguide.rst (renamed from docs/feature.templates/userguide/feature.userguide.rst) | 0 | ||||
| -rw-r--r-- | docs/development/feature.templates/userguide/index.rst (renamed from docs/feature.templates/userguide/index.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/_static/temp (renamed from docs/opnfvsecguide/_static/temp) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/_templates/temp (renamed from docs/opnfvsecguide/_templates/temp) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/audit.rst (renamed from docs/opnfvsecguide/audit.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/audit/audit_reqs.rst (renamed from docs/opnfvsecguide/audit/audit_reqs.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/compute.rst (renamed from docs/opnfvsecguide/compute.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/compute/dacmaccontrols.rst (renamed from docs/opnfvsecguide/compute/dacmaccontrols.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/compute/trust.rst (renamed from docs/opnfvsecguide/compute/trust.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/contribution.rst (renamed from docs/opnfvsecguide/contribution.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/getting_started.rst (renamed from docs/opnfvsecguide/getting_started.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/index.rst (renamed from docs/opnfvsecguide/index.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/introduction.rst (renamed from docs/opnfvsecguide/introduction.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/introduction/acknowledgements.rst (renamed from docs/opnfvsecguide/introduction/acknowledgements.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/introduction/background.rst (renamed from docs/opnfvsecguide/introduction/background.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/network.rst (renamed from docs/opnfvsecguide/network.rst) | 0 | ||||
| -rw-r--r-- | docs/development/opnfvsecguide/network/neutron.rst (renamed from docs/opnfvsecguide/network/neutron.rst) | 0 | ||||
| -rw-r--r-- | docs/development/scenario/featurematrix.rst (renamed from docs/scenario/featurematrix.rst) | 0 | ||||
| -rw-r--r-- | docs/development/scenario/scenariointro.rst (renamed from docs/scenario/scenariointro.rst) | 0 | ||||
| -rw-r--r-- | docs/development/scenario/scenariomatrix.rst (renamed from docs/scenario/scenariomatrix.rst) | 0 | ||||
| -rw-r--r-- | docs/development/scenario/scenariovalidation.rst (renamed from docs/scenario/scenariovalidation.rst) | 0 | ||||
| -rw-r--r-- | docs/images/brahmaputrafeaturematrix.jpg | bin | 62966 -> 0 bytes | |||
| -rw-r--r-- | docs/images/brahmaputrascenariomatrix.jpg | bin | 51071 -> 0 bytes | |||
| -rw-r--r-- | docs/images/opnfvplatformgraphic.png | bin | 136767 -> 0 bytes | |||
| -rw-r--r-- | docs/images/weather-clear.jpg | bin | 1286 -> 0 bytes | |||
| -rw-r--r-- | docs/images/weather-dash.jpg | bin | 1010 -> 0 bytes | |||
| -rw-r--r-- | docs/images/weather-few-clouds.jpg | bin | 1348 -> 0 bytes | |||
| -rw-r--r-- | docs/images/weather-overcast.jpg | bin | 1215 -> 0 bytes | |||
| -rw-r--r-- | docs/index.rst | 37 | ||||
| -rw-r--r-- | docs/installationprocedure/index.rst | 14 | ||||
| -rw-r--r-- | docs/overview/index.rst | 12 | ||||
| -rw-r--r-- | docs/release/index.rst (renamed from docs/documentation/index.rst) | 0 | ||||
| -rw-r--r-- | docs/release/installation.introduction.rst (renamed from docs/installationprocedure/installation.introduction.rst) | 0 | ||||
| -rw-r--r-- | docs/release/overview.rst (renamed from docs/overview/overview.rst) | 0 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst (renamed from docs/userguide/userguide.introduction.rst) | 0 | ||||
| -rw-r--r-- | docs/templates/LICENSE.rst | 43 | ||||
| -rw-r--r-- | docs/templates/build-instructions.rst | 207 | ||||
| -rw-r--r-- | docs/templates/index.rst | 38 | ||||
| -rw-r--r-- | docs/templates/installation-instructions.rst | 239 | ||||
| -rw-r--r-- | docs/templates/release-notes.rst | 261 | ||||
| -rw-r--r-- | docs/testing/testframework/framework.installation.procedure.render.rst (renamed from docs/testframework/framework.installation.procedure.render.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/testframework/framework.userguide.render.rst (renamed from docs/testframework/framework.userguide.render.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/testframework/index.rst (renamed from docs/testframework/index.rst) | 0 | ||||
| -rw-r--r-- | docs/testing/testframework/opnfv.testframework.overview.rst (renamed from docs/testframework/opnfv.testframework.overview.rst) | 0 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 14 |
52 files changed, 37 insertions, 924 deletions
diff --git a/docs/configurationguide/abstract.rst b/docs/configurationguide/abstract.rst deleted file mode 100644 index 1263dfa56..000000000 --- a/docs/configurationguide/abstract.rst +++ /dev/null @@ -1,19 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -======== -Abstract -======== - -This document provides guidance for the configurations available in the -Colorado release of OPNFV. - -The release includes four installer tools leveraging different -technologies; Apex, Compass4nfv, Fuel and JOID, which deploy -components of the platform. - -This document also includes the selection of tools and -components including guidelines for how to deploy and configure -the platform to an operational state. - diff --git a/docs/configurationguide/configuration.options.render.rst b/docs/configurationguide/configuration.options.render.rst deleted file mode 100644 index f8f16ff54..000000000 --- a/docs/configurationguide/configuration.options.render.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) Christopher Price (Ericsson AB) - -===================== -Configuration Options -===================== - -OPNFV provides a variety of virtual infrastructure deployments called scenarios designed to -host virtualised network functions (VNF's). Each scenario provide specific capabilities and/or -components aimed to solve specific problems for the deployment of VNF's. A scenario may include -components such as OpenStack, OpenDaylight, OVS, KVM etc. where each scenario will -include different source components or configurations. - -OPNFV Scenarios -=============== - -Each OPNFV scenario provides unique features and capabilities, it is important to understand -your target platform capabilities before installing and configuring your target scenario. -This configuration guide outlines how to install and configure components in order to enable -the features you require. - -.. include:: ../scenario/scenariomatrix.rst - -This document will describe how to install and configure your target OPNFV scenarios. -Remember to check the associated validation procedures section following your installation for -details of the use cases and tests that have been run. diff --git a/docs/configurationguide/feature.configuration.description.rst b/docs/configurationguide/feature.configuration.description.rst deleted file mode 100644 index 717cd0fa2..000000000 --- a/docs/configurationguide/feature.configuration.description.rst +++ /dev/null @@ -1,22 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Sofia Wallin (Ericsson AB) - -Configuration of <feature> -========================== - -Add a brief introduction to configure OPNFV with this specific feature including -dependancies on platform components, this description should be at a level that -will apply to any installer providing the pre-requisite components. - -Pre-configuration activities ----------------------------- -Describe specific pre-configuration activities. This should include ensuring the -right components are installed by the installation tools as required for your -feature to function. Refer to the previous installer configuration chapters, -installations guide and release notes - -Hardware configuration ----------------------- -Describe the hardware configuration needed for this specific feature - diff --git a/docs/configurationguide/index.rst b/docs/configurationguide/index.rst deleted file mode 100644 index 9bf442a42..000000000 --- a/docs/configurationguide/index.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -************************* -OPNFV Configuration Guide -************************* -Colorado 1.0 ------------- - -.. toctree:: - :maxdepth: 2 - - ./abstract.rst - ./configuration.options.render.rst - ./feature.configuration.description.rst - ./scenario.description.rst - diff --git a/docs/configurationguide/scenario.description.rst b/docs/configurationguide/scenario.description.rst deleted file mode 100644 index c318e6f59..000000000 --- a/docs/configurationguide/scenario.description.rst +++ /dev/null @@ -1,10 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Sofia Wallin (Ericsson AB) - -==================== -Scenario description -==================== - -This document will describe and link to the scenario installation instructions. - diff --git a/docs/feature.templates/scenarios/scenario.name/index.rst b/docs/development/feature.templates/scenarios/scenario.name/index.rst index 59ada34e9..59ada34e9 100644 --- a/docs/feature.templates/scenarios/scenario.name/index.rst +++ b/docs/development/feature.templates/scenarios/scenario.name/index.rst diff --git a/docs/feature.templates/scenarios/scenario.name/scenario.description.rst b/docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst index afd587915..afd587915 100644 --- a/docs/feature.templates/scenarios/scenario.name/scenario.description.rst +++ b/docs/development/feature.templates/scenarios/scenario.name/scenario.description.rst diff --git a/docs/feature.templates/userguide/feature.userguide.rst b/docs/development/feature.templates/userguide/feature.userguide.rst index b8adfa592..b8adfa592 100644 --- a/docs/feature.templates/userguide/feature.userguide.rst +++ b/docs/development/feature.templates/userguide/feature.userguide.rst diff --git a/docs/feature.templates/userguide/index.rst b/docs/development/feature.templates/userguide/index.rst index cc84670fc..cc84670fc 100644 --- a/docs/feature.templates/userguide/index.rst +++ b/docs/development/feature.templates/userguide/index.rst diff --git a/docs/opnfvsecguide/_static/temp b/docs/development/opnfvsecguide/_static/temp index e69de29bb..e69de29bb 100644 --- a/docs/opnfvsecguide/_static/temp +++ b/docs/development/opnfvsecguide/_static/temp diff --git a/docs/opnfvsecguide/_templates/temp b/docs/development/opnfvsecguide/_templates/temp index e69de29bb..e69de29bb 100644 --- a/docs/opnfvsecguide/_templates/temp +++ b/docs/development/opnfvsecguide/_templates/temp diff --git a/docs/opnfvsecguide/audit.rst b/docs/development/opnfvsecguide/audit.rst index cdeecba60..cdeecba60 100644 --- a/docs/opnfvsecguide/audit.rst +++ b/docs/development/opnfvsecguide/audit.rst diff --git a/docs/opnfvsecguide/audit/audit_reqs.rst b/docs/development/opnfvsecguide/audit/audit_reqs.rst index ce76d016b..ce76d016b 100644 --- a/docs/opnfvsecguide/audit/audit_reqs.rst +++ b/docs/development/opnfvsecguide/audit/audit_reqs.rst diff --git a/docs/opnfvsecguide/compute.rst b/docs/development/opnfvsecguide/compute.rst index d6c1a0159..d6c1a0159 100644 --- a/docs/opnfvsecguide/compute.rst +++ b/docs/development/opnfvsecguide/compute.rst diff --git a/docs/opnfvsecguide/compute/dacmaccontrols.rst b/docs/development/opnfvsecguide/compute/dacmaccontrols.rst index 08cd7ee89..08cd7ee89 100644 --- a/docs/opnfvsecguide/compute/dacmaccontrols.rst +++ b/docs/development/opnfvsecguide/compute/dacmaccontrols.rst diff --git a/docs/opnfvsecguide/compute/trust.rst b/docs/development/opnfvsecguide/compute/trust.rst index 3022e59c0..3022e59c0 100644 --- a/docs/opnfvsecguide/compute/trust.rst +++ b/docs/development/opnfvsecguide/compute/trust.rst diff --git a/docs/opnfvsecguide/contribution.rst b/docs/development/opnfvsecguide/contribution.rst index 683aa2d14..683aa2d14 100644 --- a/docs/opnfvsecguide/contribution.rst +++ b/docs/development/opnfvsecguide/contribution.rst diff --git a/docs/opnfvsecguide/getting_started.rst b/docs/development/opnfvsecguide/getting_started.rst index e09507dd2..e09507dd2 100644 --- a/docs/opnfvsecguide/getting_started.rst +++ b/docs/development/opnfvsecguide/getting_started.rst diff --git a/docs/opnfvsecguide/index.rst b/docs/development/opnfvsecguide/index.rst index ecefd61ce..ecefd61ce 100644 --- a/docs/opnfvsecguide/index.rst +++ b/docs/development/opnfvsecguide/index.rst diff --git a/docs/opnfvsecguide/introduction.rst b/docs/development/opnfvsecguide/introduction.rst index ad8083197..ad8083197 100644 --- a/docs/opnfvsecguide/introduction.rst +++ b/docs/development/opnfvsecguide/introduction.rst diff --git a/docs/opnfvsecguide/introduction/acknowledgements.rst b/docs/development/opnfvsecguide/introduction/acknowledgements.rst index 60c687d05..60c687d05 100644 --- a/docs/opnfvsecguide/introduction/acknowledgements.rst +++ b/docs/development/opnfvsecguide/introduction/acknowledgements.rst diff --git a/docs/opnfvsecguide/introduction/background.rst b/docs/development/opnfvsecguide/introduction/background.rst index bd7e44d01..bd7e44d01 100644 --- a/docs/opnfvsecguide/introduction/background.rst +++ b/docs/development/opnfvsecguide/introduction/background.rst diff --git a/docs/opnfvsecguide/network.rst b/docs/development/opnfvsecguide/network.rst index b1744796c..b1744796c 100644 --- a/docs/opnfvsecguide/network.rst +++ b/docs/development/opnfvsecguide/network.rst diff --git a/docs/opnfvsecguide/network/neutron.rst b/docs/development/opnfvsecguide/network/neutron.rst index e7ca06075..e7ca06075 100644 --- a/docs/opnfvsecguide/network/neutron.rst +++ b/docs/development/opnfvsecguide/network/neutron.rst diff --git a/docs/scenario/featurematrix.rst b/docs/development/scenario/featurematrix.rst index 2d00a4097..2d00a4097 100644 --- a/docs/scenario/featurematrix.rst +++ b/docs/development/scenario/featurematrix.rst diff --git a/docs/scenario/scenariointro.rst b/docs/development/scenario/scenariointro.rst index dd808432b..dd808432b 100644 --- a/docs/scenario/scenariointro.rst +++ b/docs/development/scenario/scenariointro.rst diff --git a/docs/scenario/scenariomatrix.rst b/docs/development/scenario/scenariomatrix.rst index 64e115015..64e115015 100644 --- a/docs/scenario/scenariomatrix.rst +++ b/docs/development/scenario/scenariomatrix.rst diff --git a/docs/scenario/scenariovalidation.rst b/docs/development/scenario/scenariovalidation.rst index e69de29bb..e69de29bb 100644 --- a/docs/scenario/scenariovalidation.rst +++ b/docs/development/scenario/scenariovalidation.rst diff --git a/docs/images/brahmaputrafeaturematrix.jpg b/docs/images/brahmaputrafeaturematrix.jpg Binary files differdeleted file mode 100644 index 0d2a12279..000000000 --- a/docs/images/brahmaputrafeaturematrix.jpg +++ /dev/null diff --git a/docs/images/brahmaputrascenariomatrix.jpg b/docs/images/brahmaputrascenariomatrix.jpg Binary files differdeleted file mode 100644 index 84fc87a76..000000000 --- a/docs/images/brahmaputrascenariomatrix.jpg +++ /dev/null diff --git a/docs/images/opnfvplatformgraphic.png b/docs/images/opnfvplatformgraphic.png Binary files differdeleted file mode 100644 index 9d6074f02..000000000 --- a/docs/images/opnfvplatformgraphic.png +++ /dev/null diff --git a/docs/images/weather-clear.jpg b/docs/images/weather-clear.jpg Binary files differdeleted file mode 100644 index 011ad52e9..000000000 --- a/docs/images/weather-clear.jpg +++ /dev/null diff --git a/docs/images/weather-dash.jpg b/docs/images/weather-dash.jpg Binary files differdeleted file mode 100644 index 3bf98dd27..000000000 --- a/docs/images/weather-dash.jpg +++ /dev/null diff --git a/docs/images/weather-few-clouds.jpg b/docs/images/weather-few-clouds.jpg Binary files differdeleted file mode 100644 index 51994ee84..000000000 --- a/docs/images/weather-few-clouds.jpg +++ /dev/null diff --git a/docs/images/weather-overcast.jpg b/docs/images/weather-overcast.jpg Binary files differdeleted file mode 100644 index bdc1e0487..000000000 --- a/docs/images/weather-overcast.jpg +++ /dev/null diff --git a/docs/index.rst b/docs/index.rst index b69aa3980..ed06ecc9e 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -8,3 +8,40 @@ OPNFV Docs placeholder landing page This will be extended to include all the sub pages and to provide the docs.opnfv.org landing page for Danube. +===================== +Release Documentation +===================== + +Just pointing to the index.rst file here, but we need to break that out and have +sub-directories for each of the projects documents to be copied into. + +.. toctree:: + :maxdepth: 1 + + release/index + +.. need to figure out the correct URL to use here so readthedocs does it for us. + +======= +Testing +======= + +Just pointing to the index.rst file here, but we need to break that out and have +sub-directories for each of the projects documents to be copied into. + +.. toctree:: + :maxdepth: 1 + + testing/index + +========= +Developer +========= + +Just pointing to the index.rst file here, but we need to break that out and have +sub-directories for each of the projects documents to be copied into. + +.. toctree:: + :maxdepth: 1 + + developer/index diff --git a/docs/installationprocedure/index.rst b/docs/installationprocedure/index.rst deleted file mode 100644 index 3d02f310b..000000000 --- a/docs/installationprocedure/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Sofia Wallin Ericsson AB - -****************************** -OPNFV Installation Instruction -****************************** - -.. toctree:: - :numbered: - :maxdepth: 3 - - installation.introduction.rst - diff --git a/docs/overview/index.rst b/docs/overview/index.rst deleted file mode 100644 index 6b7b66846..000000000 --- a/docs/overview/index.rst +++ /dev/null @@ -1,12 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Open Platform for NFV Project, Inc. and its contributors - -******************************** -OPNFV Platform Overview Document -******************************** - -.. toctree:: - :maxdepth: 2 - - ./overview.rst diff --git a/docs/documentation/index.rst b/docs/release/index.rst index 6f3ee54b8..6f3ee54b8 100644 --- a/docs/documentation/index.rst +++ b/docs/release/index.rst diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/release/installation.introduction.rst index 201112cad..201112cad 100644 --- a/docs/installationprocedure/installation.introduction.rst +++ b/docs/release/installation.introduction.rst diff --git a/docs/overview/overview.rst b/docs/release/overview.rst index cd1b5d0f9..cd1b5d0f9 100644 --- a/docs/overview/overview.rst +++ b/docs/release/overview.rst diff --git a/docs/userguide/userguide.introduction.rst b/docs/release/userguide.introduction.rst index 48112e78e..48112e78e 100644 --- a/docs/userguide/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst diff --git a/docs/templates/LICENSE.rst b/docs/templates/LICENSE.rst deleted file mode 100644 index ed7a4a22b..000000000 --- a/docs/templates/LICENSE.rst +++ /dev/null @@ -1,43 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -Copyright 2015 Open Platform for NFV Project, Inc. and its contributors - -Open Platform for NFV Project Software Licence -============================================== -Any software developed by the "Open Platform for NFV" Project is licenced under the -Apache License, Version 2.0 (the "License"); -you may not use the content of this software bundle except in compliance with the License. -You may obtain a copy of the License at <http://www.apache.org/licenses/LICENSE-2.0> - -Unless required by applicable law or agreed to in writing, software -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - -Open Platform for NFV Project Documentation Licence -=================================================== -Any documentation developed by the "Open Platform for NFV Project" -is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. If not, -see <http://creativecommons.org/licenses/by/4.0/>. - -Unless required by applicable law or agreed to in writing, documentation -distributed under the License is distributed on an "AS IS" BASIS, -WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -See the License for the specific language governing permissions and -limitations under the License. - -Other applicable upstream project Licenses relevant for <Component> -=================================================================== -You may not use the content of this software bundle except in compliance with the -Licenses as listed below: -+----------------+----------------------------+ -| **Component** | **Licence** | -+----------------+----------------------------+ -| OpenStack | Apache License 2.0 | -+----------------+----------------------------+ -| OpenDaylight | Eclipse Public License 1.0 | -+----------------+----------------------------+ -| ++ | | -+----------------+----------------------------+ diff --git a/docs/templates/build-instructions.rst b/docs/templates/build-instructions.rst deleted file mode 100644 index 3c7a9b8f1..000000000 --- a/docs/templates/build-instructions.rst +++ /dev/null @@ -1,207 +0,0 @@ -:Authors: Jonas Bjurel (Ericsson) -:Version: 0.1 - -================================================================ -OPNFV Build instructions for - < Component denomination > -================================================================ - -Abstract -======== - -This document describes how to build <Component>, build system dependencies and required system resources. - -License -======= -<WORK'S NAME> (c) by <AUTHOR'S NAME> - -<WORK'S NAME> is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. -If not, see <http://creativecommons.org/licenses/by/4.0/>. - - -**Contents** - -1 Version history - -2 Introduction - -3 Requirements - -4 Building - -5 Artifacts - - -1 Version history -=================== - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - -2 Introduction -================ -<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT> - -<EXAMPLE>: - -This document describes build system used to build Fuel@OPNFV, -required dependencies and minimum requirements on the host to be used for the buildsystem. - -The Fuel build system is desigened around Docker containers such that dependencies -outside of the build system can be kept to a minimum. -It also shields the host from any potential dangerous operations performed by the build system. - -The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. - -3 Requirements -================ -<PROVIDE A LIST OF MINIMUM HARDWARE AND SOFTWARE REQUIREMENTS FOR THE BUILD> - -3.1 Minimum Hardware Requirements ---------------------------------- -<EXAMPLE>: - -- An x86_64 host (Bare-metal or VM) with Ubuntu 14.04 LTS installed - -- ~30 GB available disc - -- 4 GB RAM - -3.2 Minimum Software Requirements ---------------------------------- -<EXAMPLE>: -The build host should run Ubuntu 14.04 operating system. - -On the host, the following packages must be installed: - -- docker - see https://docs.docker.com/installation/ubuntulinux/ for installation notes for Ubuntu 14.04. - Note: only use the Ubuntu stock distro of Docker (docker.io) - -- git (simply available through sudo apt-get install git) - -- make (simply available through sudo apt-get install make) - -- curl (simply available through sudo apt-get install curl) - -3.3 Preparations ----------------- -<EXAMPLE>: - -3.3.1 Setting up the Docker build container -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -After having installed Docker, add yourself to the docker group: - -<usermod -a -G docker [userid]> - -Also make sure to define relevant DNS servers part of the global dns chain in -in your </etc/default/docker> configuration file, eg. - -<DOCKER_OPTS=" --dns=8.8.8.8 --dns=8.8.8.4"> - -Then restart docker: - -<sudo service docker.io restart> - -3.3.2 Setting up OPNFV Gerrit in order to being able to clone the code -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -- Start setting up OPNFV gerrit by creating a SSH key (unless you don't already have one), - create one with ssh-keygen - -- Add your generated public key in OPNFV Gerrit <https://gerrit.opnfv.org/> - (this requires a linuxfoundation account, create one if you do not already have one) - -- Select "SSH Public Keys" to the left and then "Add Key" and paste your public key in. - -3.3.3 Clone the OPNFV code git repository -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Now it is time to clone the code repository: - -<git clone ssh://Linux foundation user@gerrit.opnfv.org:29418/genesis> - -Now you should have the OPNFV genesis repository with Fuel@OPNFV stored locally on your build host. - -4 Building -============ -<DESCRIBE THE FULL PROCEDURES FOR THE BUILD OF THE OPNFV COMPONENT ARTIFACTS> - -<EXAMPLE>: - -There are two methods available for building Fuel@OPNFV: - -- A low level method using Make - -- An abstracted method using build.sh - -4.1 Configure your build environment -------------------------------------- - -Select the versions of the components you want to build by editing the fuel/build/config.mk file. -Note if you want to build with OpenDaylight SDN controller you need to uncomment the lines starting -with odl-main and java-main - -4.2 Low level build method using make --------------------------------------- - -The low level method is based on Make: - -From the <fuel/build directory> invoke <make [target]> - -Following targets exist: - -- none/all - this will: - - - If not allready existing, initialize the docker build environment - - - If not already done, build OpenDaylight from upstream (as defined by fuel-build config-spec) - - - If not already done, build fuel from upstream (as defined by fuel-build/config-spec) - - - Build the defined additions to fuel (as defined by the structure of this framework) - - - Apply changes and patches to fuel (as defined by the structure of this framework) - - - Reconstruct a fuel .iso image - -- clean - this will remove all artifacts from earlier builds. - -If the build is successful, you will find the generated ISO file in the <fuel/build/release> subdirectory! - -4.3 Abstracted build method using build.sh -=========================================== -The abstracted build method useses the <fuel/ci/build.sh> script which allows you to: - -- Create and use a build cache - significantly speeding up the buildtime if upstream repositories have not changed. - -- push/pull cache and artifacts to an arbitrary URI (http(s):, file:, ftp:) - -For more info type <fuel/ci/build.sh -h>. - -5 Artifacts -============= -<DESCRIBE WHAT ARE THE PRODUCED ARTIFACTS AND WHERE THOSE CAN BE FOUND> - -<EXAMPLES>: - -The artifacts produced are: - -- <OPNFV_XXXX.iso> - Which represents the bootable Fuel@OPNFV image, - XXXX is replaced with the build identity provided to the build system - -- <OPNFV_XXXX.iso.txt> - Which holds version metadata. - -6 References -============= -<PROVIDE NEEDED/USEFUL REFERENCES> diff --git a/docs/templates/index.rst b/docs/templates/index.rst deleted file mode 100644 index 2f124e5c0..000000000 --- a/docs/templates/index.rst +++ /dev/null @@ -1,38 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) <optionally add copywriters name> - -.. OPNFV Release Engineering documentation, created by - sphinx-quickstart on Tue Jun 9 19:12:31 2015. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - -.. image:: opnfv-logo.png - :height: 40 - :width: 200 - :alt: OPNFV - :align: left - -Example Documentation table of contents -======================================= - -Contents: - -.. toctree:: - :numbered: - :maxdepth: 4 - - build-instructions.rst - installation-instructions.rst - LICENSE.rst - release-notes.rst - - -Indices and tables -================== - -* :ref:`search` - -Revision: _sha1_ - -Build date: |today| diff --git a/docs/templates/installation-instructions.rst b/docs/templates/installation-instructions.rst deleted file mode 100644 index 8c46fe9ba..000000000 --- a/docs/templates/installation-instructions.rst +++ /dev/null @@ -1,239 +0,0 @@ -:Authors: Jonas Bjurel (Ericsson) -:Version: 0.1 - -Revision: _sha1_ - -Build date: _date_ - - -================================================================ -OPNFV Installation instructions for - < Component denomination > -================================================================ - -Abstract -======== - -This document describes how to install <Component>, it's dependencies and required system resources. - -License -======= -<WORK'S NAME> (c) by <AUTHOR'S NAME> - -<WORK'S NAME> is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. -If not, see <http://creativecommons.org/licenses/by/4.0/>. - - -**Contents** - -1 Version history - -2 Introduction - -3 Preface - -4 Hardware requirements - -5 Top of the rack (TOR) Configuration requirements - -6 OPNFV Software installation and deployment - -7 Installation health-check - -8 Post installation and deployment actions - -9 References - -1 Version history -=================== - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - -2 Introduction -================ -<INTRODUCTION TO THE SCOPE AND INTENTION OF THIS DOCUMENT AS WELL AS TO THE SYSTEM TO BE INSTALLED> - -<EXAMPLE>: - -This document describes the supported software and hardware configurations for the -Fuel OPNFV reference platform as well as providing guidelines on how to install and -configure such reference system. - -Although the available installation options gives a high degree of freedom in how the system is set-up, -with what architecture, services and features, etc., not nearly all of those permutations provides -a OPNFV compliant reference architecture. Following the guidelines in this document ensures -a result that is OPNFV compliant. - -The audience of this document is assumed to have good knowledge in network and Unix/Linux administration. - -3 Preface -=========== -<DESCRIBE NEEDED PREREQUISITES, PLANNING, ETC.> - -<EXAMPLE>: - -Before starting the installation of Fuel@OPNFV, some planning must preceed. - -First of all, the Fuel@OPNFV .iso image needs to be retrieved, -the Latest stable Arno release of Fuel@OPNFV can be found here: <www.opnfv.org/abc/def> - -Alternatively, you may build the .iso from source by cloning the opnfv/genesis git repository: -<git clone https://<linux foundation uid>@gerrit.opnf.org/gerrit/genesis> -Check-out the Arno release: -<cd genesis; git checkout arno> -Goto the fuel directory and build the .iso -<cd fuel/build; make all> - -Familiarize yourself with the Fuel 6.0.1 version by reading the following documents: -- abc <http://wiki.openstack.org/abc> -- def <http://wiki.openstack.org/def> -- ghi <http://wiki.openstack.org/ghi> - -Secondly, a number of deployment specific parameters must be collected, those are: - -1. Provider sub-net and gateway information - -2. Provider VLAN information - -3. Provider DNS addresses - -4. Provider NTP addresses - -This information will be needed for the configuration procedures provided in this document. - -4 Hardware requirements -========================= -<PROVIDE A LIST OF MINIMUM HARDWARE REQUIREMENTS NEEDED FOR THE INSTALL> - -<EXAMPLE>: - -Following minimum hardware requirements must be met for installation of Fuel@OPNFV: - -+--------------------+----------------------------------------------------+ -| **HW Aspect** | **Requirement** | -| | | -+--------------------+----------------------------------------------------+ -| **# of servers** | Minimum 5 (3 for non redundant deployment) | -| | 1 Fuel deployment master (may be virtualized) | -| | 3(1) Controllers | -| | 1 Compute | -+--------------------+----------------------------------------------------+ -| **CPU** | Minimum 1 socket x86_AMD64 Ivy bridge 1.6 GHz | -| | | -+--------------------+----------------------------------------------------+ -| **RAM** | Minimum 16GB/server (Depending on VNF work load) | -| | | -+--------------------+----------------------------------------------------+ -| **Disk** | Minimum 256GB 10kRPM spinning disks | -| | | -+--------------------+----------------------------------------------------+ -| **NICs** | 2(1)x10GE Niantec for Private/Public (Redundant) | -| | | -| | 2(1)x10GE Niantec for SAN (Redundant) | -| | | -| | 2(1)x1GE for admin (PXE) and control (RabitMQ,etc) | -| | | -+--------------------+----------------------------------------------------+ - -5 Top of the rack (TOR) Configuration requirements -==================================================== -<DESCRIBE NEEDED NETWORK TOPOLOGY SETUP IN THE TORs> - -<EXAMPLE>: - -The switching infrastructure provides connectivity for the OPNFV infra-structure operations as well as -for the tenant networks (East/West) and provider connectivity (North/South bound connectivity). -The switching connectivity can (but does not need to) be fully redundant, -in case it and comprises a redundant 10GE switch pair for "Traffic/Payload/SAN" purposes as well as -a 1GE switch pair for "infrastructure control-, management and administration" - -The switches are **not** automatically configured from the OPNFV reference platform. -All the networks involved in the OPNFV infra-structure as well as the provider networks -and the private tenant VLANs needs to be manually configured. - -This following sections guides through required black-box switch configurations. - -5.1 VLAN considerations and blue-print --------------------------------------- - -5.2 IP Address plan considerations and blue-print -------------------------------------------------- - -6 OPNFV Software installation and deployment -============================================== -<DESCRIBE THE FULL PROCEDURES FOR THE INSTALLATION OF THE OPNFV COMPONENT INSTALLATION AND DEPLOYMENT> - -<EXAMPLE>: - -This section describes the installation of the Fuel@OPNFV installation server (Fuel master) -as well as the deployment of the full OPNFV reference platform stack across a server cluster. -Etc. - -6.1 Install Fuel master ------------------------ - -6.2 Create an OPNV (Fuel Environment) -------------------------------------- - -6.3 Configure the OPNFV environment ------------------------------------ - -6.4 Deploy the OPNFV environment --------------------------------- - -7 Installation health-check -============================= -<DESCRIBE ANY MEANS TO DO VERIFY THE INTEGRITY AND HEALTHYNESS OF THE INSTALL> - -<EXAMPLE>: - -Now that the OPNFV environment has been created, and before the post installation configurations is started, -perform a system health check from the Fuel GUI: - -- Select the "Health check" TAB. -- Select all test-cases -- And click "Run tests" - -All test cases except the following should pass: - -8 Post installation and deployment actions -============================================ -<DESCRIBE ANY POST INSTALLATION ACTIONS/CONFIGURATIONS NEEDED> - -<EXAMPLE>: -After the OPNFV deployment is completed, the following manual changes needs to be performed in order -for the system to work according OPNFV standards. - -**Change host OS password:** -Change the Host OS password by...... - -9 References -============= -<PROVIDE NEEDED/USEFUL REFERENCES> - -<EXAMPLES>: - -9.1 OPNFV -------------- - -9.2 OpenStack ------------------ - -9.3 OpenDaylight --------------------- - -9.4 Fuel ------------- diff --git a/docs/templates/release-notes.rst b/docs/templates/release-notes.rst deleted file mode 100644 index 6941f181f..000000000 --- a/docs/templates/release-notes.rst +++ /dev/null @@ -1,261 +0,0 @@ -:Authors: Jonas Bjurel (Ericsson) -:Version: 0.1 - -Revision: _sha1_ - -Build date: _date_ - - -====================================================================== -OPNFV Release Note for "Arno-SRx release" - < Component denomination > -====================================================================== - -Abstract -======== - -This document provides the release notes for <RELEASE> of <COMPONENT>. - -License -======= -<WORK'S NAME> (c) by <AUTHOR'S NAME> - -<WORK'S NAME> is licensed under a Creative Commons Attribution 4.0 International License. -You should have received a copy of the license along with this. If not, -see <http://creativecommons.org/licenses/by/4.0/>. - - -**Contents** - -1 Version History - -2 Important notes - -3 Summary - -4 Delivery Data - -5 Known Limitations, Issues and Workarounds - -6 Test Result - -7 References - -1 Version history -=================== - -+--------------------+--------------------+--------------------+--------------------+ -| **Date** | **Ver.** | **Author** | **Comment** | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| 2015-04-14 | 0.1.0 | Jonas Bjurel | First draft | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 0.1.1 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ -| | 1.0 | | | -| | | | | -+--------------------+--------------------+--------------------+--------------------+ - -2 Important notes -=================== - -<STATE IMPORTANT NOTES/DEVIATIONS SINCE PREVIOUS ITERATIVE RELEASE AND OTHER IMPORTANT NOTES FOR THIS RELEASE> - -<EXAMPLE>: - -**Attention:** Please be aware that since LSV3 a pre-deploy script must be ran on the Fuel master - -see the OPNFV@Fuel SW installation instructions - -3 Summary -=========== - -<SUMMARIZE THE RELEASE - THE CONTENT - AND OTHER IMPORTANT HIGH LEVEL PROPERTIES> - -<EXAMPLE>: - -Arno Fuel@OPNFV is based the OpenStack Fuel upstream project version 6.0.1, -but adds OPNFV unique components such as OpenDaylight version: Helium as well as other OPNFV unique configurations...... - -4 Release Data -================ -<STATE RELEVANT RELEASE DATA/RECORDS> - -<EXAMPLE>: - -+--------------------------------------+--------------------------------------+ -| **Project** | E.g. Arno/genesis/fuel@opnfv | -| | | -+--------------------------------------+--------------------------------------+ -| **Repo/commit-ID** | E.g. genesis/adf634a0d4..... | -| | | -+--------------------------------------+--------------------------------------+ -| **Release designation** | E.g. Arno RC2 | -| | | -+--------------------------------------+--------------------------------------+ -| **Release date** | E.g. 2015-04-16 | -| | | -+--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | E.g. OPNFV Internal quality assurance| -| | | -+--------------------------------------+--------------------------------------+ - -4.1 Version change ------------------- - -4.1.1 Module version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -<STATE WHAT UPSTREAM, - AS WELL AS OPNFV MODULE VERSIONS HAVE CHANGED> - -<EXAMPLE>: - -- Fuel have changed from 5.1 to 6.0.1 - -- OpenDaylight has changed from Helium-SR1 to Helium-SR2 - -4.1.2 Document version changes -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -<STATE WHAT RELATED DOCUMENTS THAT CHANGES WITH THIS RELEASE> - -<EXAMPLE>: - -- The Fuel@OPNFV installation guide version has changed from version 0.1 to to 0.2 - -4.2 Reason for version ----------------------- -4.2.1 Feature additions -~~~~~~~~~~~~~~~~~~~~~~~ -<STATE ADDED FEATURES BY REFERENCE TO JIRA> - -<EXAMPLE>: - -**JIRA BACK-LOG:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-123 | ADD OpenDaylight ml2 integration | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-456 | Add auto-deployment of Fuel@OPNFV | -| | | -+--------------------------------------+--------------------------------------+ - -4.2.2 Bug corrections -~~~~~~~~~~~~~~~~~~~~~ - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-888 | Fuel doesn't deploy | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-999 | Floating IP doesn't work | -| | | -+--------------------------------------+--------------------------------------+ - -4.3 Deliverables ----------------- - -4.3.1 Software deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -<STATE WHAT SOFTWARE DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED> - -<EXAMPLE>: - -4.3.2 Documentation deliverables -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ - -<STATE WHAT DOCUMENTATION DELIVERABLES THAT ARE RELATED TO THIS VERSION, AND WHERE THOSE CAN BE RETRIEVED> - -<EXAMPLE>: - -5 Known Limitations, Issues and Workarounds -============================================ - -5.1 System Limitations -------------------------- -<STATE ALL RELEVANT SYSTEM LIMITATIONS> - -<EXAMPLE>: - -**Max number of blades:** 1 Fuel master, 3 Controllers, 20 Compute blades - -**Min number of blades:** 1 Fuel master, 1 Controller, 1 Compute blade - -**Storage:** Ceph is the only supported storage configuration. - -**Max number of networks:** 3800 (Needs special switch config.) - -**L3Agent:** L3 agent and floating IPs is not supported. - -5.2 Known issues -------------------- -<STATE ALL KNOWN ISSUES WITH JIRA REFERENCE> - -<EXAMPLE>: - -**JIRA TICKETS:** - -+--------------------------------------+--------------------------------------+ -| **JIRA REFERENCE** | **SLOGAN** | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-987 | Nova-compute process does | -| | not re-spawn when killed | -| | | -+--------------------------------------+--------------------------------------+ -| BGS-654 | MOS 5.1 : neutron net-list returns | -| | "400 Bad request" | -| | | -+--------------------------------------+--------------------------------------+ - -5.3 Workarounds ------------------- - -<STATE ALL KNOWN WORKAROUNDS TO THE ISSUES STATED ABOVE> - -<EXAMPLE>: - -- In case the contact with a compute is lost - restart the compute host -- In case the disk is full on a controller - delete all files in /tmp - -6 Test Result -============== -<STATE THE QA COVERAGE AND RESULTS> - -<EXAMPLE>: - -Fuel@OPNFV Arno RC2 has undergone QA test runs with the following results: - -+--------------------------------------+--------------------------------------+ -| **TEST-SUITE** | **Results:** | -| | | -+--------------------------------------+--------------------------------------+ -| Tempest test suite 123 | Following tests failed: | -| | | -| | 1. Image resizing.... | -| | | -| | 2. Heat deploy.... | -+--------------------------------------+--------------------------------------+ -| Robot test suite 456 | Following tests failed: | -| | | -| | 1....... | -| | | -| | 2....... | -+--------------------------------------+--------------------------------------+ - -7 References -============= -<STATE RELEVANT REFERENCES FOR THIS RELEASE/VERSION> - -<EXAMPLE>: - -For more information on the OPNFV Arno release, please see: - -http://wiki.opnfv.org/release/arno diff --git a/docs/testframework/framework.installation.procedure.render.rst b/docs/testing/testframework/framework.installation.procedure.render.rst index 8eaa57d12..8eaa57d12 100644 --- a/docs/testframework/framework.installation.procedure.render.rst +++ b/docs/testing/testframework/framework.installation.procedure.render.rst diff --git a/docs/testframework/framework.userguide.render.rst b/docs/testing/testframework/framework.userguide.render.rst index 3f9993c13..3f9993c13 100644 --- a/docs/testframework/framework.userguide.render.rst +++ b/docs/testing/testframework/framework.userguide.render.rst diff --git a/docs/testframework/index.rst b/docs/testing/testframework/index.rst index 16521c141..16521c141 100644 --- a/docs/testframework/index.rst +++ b/docs/testing/testframework/index.rst diff --git a/docs/testframework/opnfv.testframework.overview.rst b/docs/testing/testframework/opnfv.testframework.overview.rst index 92cc88685..92cc88685 100644 --- a/docs/testframework/opnfv.testframework.overview.rst +++ b/docs/testing/testframework/opnfv.testframework.overview.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst deleted file mode 100644 index faa5dbd94..000000000 --- a/docs/userguide/index.rst +++ /dev/null @@ -1,14 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 -.. (c) Christopher Price (Ericsson AB) - -**************** -OPNFV User Guide -**************** - -.. toctree:: - :numbered: - :maxdepth: 2 - - ./userguide.introduction.rst - |
