diff options
Diffstat (limited to 'docs/configguide')
-rw-r--r-- | docs/configguide/abstract.rst | 18 | ||||
-rw-r--r-- | docs/configguide/configoptions.rst | 27 | ||||
-rw-r--r-- | docs/configguide/feature-config.rst | 12 | ||||
-rw-r--r-- | docs/configguide/featureconfig.rst | 28 | ||||
-rw-r--r-- | docs/configguide/index.rst | 17 | ||||
-rw-r--r-- | docs/configguide/installer-config.rst | 21 | ||||
-rw-r--r-- | docs/configguide/installerconfig.rst | 26 | ||||
-rw-r--r-- | docs/configguide/pharos-config.rst | 5 | ||||
-rw-r--r-- | docs/configguide/post-install.rst | 59 | ||||
-rw-r--r-- | docs/configguide/postinstall-copper.rst | 4 | ||||
-rw-r--r-- | docs/configguide/postinstall-fuel.rst | 4 | ||||
-rw-r--r-- | docs/configguide/postinstall-functest.rst | 5 | ||||
-rw-r--r-- | docs/configguide/postinstall-ipv6.rst | 4 | ||||
-rw-r--r-- | docs/configguide/postinstall-joid.rst | 4 | ||||
-rw-r--r-- | docs/configguide/postinstall-vswitchperf.rst | 4 | ||||
-rw-r--r-- | docs/configguide/postinstall-yardstick.rst | 6 | ||||
-rw-r--r-- | docs/configguide/postinstall.rst | 30 | ||||
-rw-r--r-- | docs/configguide/projects-configguide.rst | 6 |
18 files changed, 0 insertions, 280 deletions
diff --git a/docs/configguide/abstract.rst b/docs/configguide/abstract.rst deleted file mode 100644 index 95f7628b0..000000000 --- a/docs/configguide/abstract.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) - -======== -Abstract -======== - -This document provides guidance and instructions for the configuration -of the Brahmaputra 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 provides a guide for the selection of tools and -components including guidelines for how to deploy and configure -the platform to an operational state. diff --git a/docs/configguide/configoptions.rst b/docs/configguide/configoptions.rst deleted file mode 100644 index cb5774a41..000000000 --- a/docs/configguide/configoptions.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/configguide/feature-config.rst b/docs/configguide/feature-config.rst deleted file mode 100644 index f40bff22c..000000000 --- a/docs/configguide/feature-config.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) Christopher Price (Ericsson AB) - -===================== -Feature Configuration -===================== - -The following sections describe the configuration options for specific platform features provided in Brahmaputra. -Further details for each feature are captured in the referred project documentation. - -.. <project>/docs/configguide/featureconfig.rst files will be imported below by the build script. diff --git a/docs/configguide/featureconfig.rst b/docs/configguide/featureconfig.rst deleted file mode 100644 index 0fe70060e..000000000 --- a/docs/configguide/featureconfig.rst +++ /dev/null @@ -1,28 +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> - -<Project> configuration -======================= -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 - -Feature configuration ---------------------- -Describe the procedures to configure your feature on the platform in order -that it is ready to use according to the feature instructions in the platform -user guide. Where applicable you should add content in the postinstall.rst -to validate the feature is configured for use. -(checking components are installed correctly etc...) diff --git a/docs/configguide/index.rst b/docs/configguide/index.rst deleted file mode 100644 index 1559fab0a..000000000 --- a/docs/configguide/index.rst +++ /dev/null @@ -1,17 +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 -************************* - -.. toctree:: - :maxdepth: 2 - - ./abstract - ./configoptions - ./installer-config - ./feature-config - ./post-install - diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst deleted file mode 100644 index a88d1f50e..000000000 --- a/docs/configguide/installer-config.rst +++ /dev/null @@ -1,21 +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) - -======================= -Installer Configuration -======================= - -Installing the OPNFV platform requires either a physical environment as defined in the -Pharos lab specification, or a virtual infrastructure. When configuring a physical infrastructure -it is strongly advised to follow the Pharos configuration material. - -.. toctree:: - - pharos-config - - -The following sections describe the per installer configuration options. -Further details for each installer are captured in the referred project documentation. - -.. <project>/docs/configguide/installerconfig.rst files will be imported below by the build script. diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst deleted file mode 100644 index afb414bf5..000000000 --- a/docs/configguide/installerconfig.rst +++ /dev/null @@ -1,26 +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> - -<Project> configuration -======================= -Add a brief introduction to configure OPNFV with this specific installer - -Pre-configuration activities ------------------------------ -Describe specific pre-configuration activities. Refer to Installations guide and release notes - -Hardware configuration ------------------------ -Describe the hardware configuration needed for this specific installer - -Jumphost configuration ------------------------ -Describe intial Jumphost configuration (network and software)needed in order to deploy the installer - -Platform components configuration ---------------------------------- -Describe the configuration of each component in the installer - - - diff --git a/docs/configguide/pharos-config.rst b/docs/configguide/pharos-config.rst deleted file mode 100644 index 013e21b34..000000000 --- a/docs/configguide/pharos-config.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/pharos/configguide/configguide.rst -.. include:: ../projects/pharos/configguide/jumpserverinstall.rst diff --git a/docs/configguide/post-install.rst b/docs/configguide/post-install.rst deleted file mode 100644 index c7bc27ea1..000000000 --- a/docs/configguide/post-install.rst +++ /dev/null @@ -1,59 +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) - -============================= -Post Configuration Activities -============================= - -Once you have deployed and configured your scenario and features you should validate the -state of the system using the following guides. - -Scenario validation activities -============================== - -The following guides provide information on how to validate the installation of you scenario -based on the tools and test suites available for the installation tool you have selected: - -.. toctree:: - - postinstall-fuel - -.. toctree:: - - postinstall-joid - -Feature validation activities -============================= - -The following sections provide information on how to validate the features you have -installed in your scenario: - -.. toctree:: - - postinstall-copper - -.. toctree:: - - postinstall-ipv6 - - -Additional testing and validation activities -============================================ - -Many of our testing tools can be manually installed to facilitate targeted testing -of features and capabilities of your scenario. The following guides provide instruction on -setting up these testing suites: - -.. toctree:: - - postinstall-functest - -.. toctree:: - - postinstall-vswitchperf - -.. toctree:: - - postinstall-yardstick - diff --git a/docs/configguide/postinstall-copper.rst b/docs/configguide/postinstall-copper.rst deleted file mode 100644 index 06c4b151b..000000000 --- a/docs/configguide/postinstall-copper.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/copper/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-fuel.rst b/docs/configguide/postinstall-fuel.rst deleted file mode 100644 index 877e548cb..000000000 --- a/docs/configguide/postinstall-fuel.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/fuel/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-functest.rst b/docs/configguide/postinstall-functest.rst deleted file mode 100644 index 5c9e03ec3..000000000 --- a/docs/configguide/postinstall-functest.rst +++ /dev/null @@ -1,5 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/functest/userguide/introduction.rst -.. include:: ../projects/functest/configguide/configguide.rst diff --git a/docs/configguide/postinstall-ipv6.rst b/docs/configguide/postinstall-ipv6.rst deleted file mode 100644 index 8a51452b6..000000000 --- a/docs/configguide/postinstall-ipv6.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/ipv6/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-joid.rst b/docs/configguide/postinstall-joid.rst deleted file mode 100644 index d986b6f22..000000000 --- a/docs/configguide/postinstall-joid.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/joid/configguide/postinstall.rst diff --git a/docs/configguide/postinstall-vswitchperf.rst b/docs/configguide/postinstall-vswitchperf.rst deleted file mode 100644 index e241d4978..000000000 --- a/docs/configguide/postinstall-vswitchperf.rst +++ /dev/null @@ -1,4 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/vswitchperf/configguide/installation.rst diff --git a/docs/configguide/postinstall-yardstick.rst b/docs/configguide/postinstall-yardstick.rst deleted file mode 100644 index 841b47ff1..000000000 --- a/docs/configguide/postinstall-yardstick.rst +++ /dev/null @@ -1,6 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. include:: ../projects/yardstick/userguide/comp-intro.rst -.. include:: ../projects/yardstick/userguide/03-installation.rst - diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst deleted file mode 100644 index 959bb81eb..000000000 --- a/docs/configguide/postinstall.rst +++ /dev/null @@ -1,30 +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> - -<Project> post installation procedures -====================================== -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. - -Automated post installation activities --------------------------------------- -Describe specific post installation activities performed by the OPNFV -deployment pipeline including testing activities and reports. Refer to -the relevant testing guides, results, and release notes. - -note: this section should be singular and derived from the test projects -once we have one test suite to run for all deploy tools. This is not the -case yet so each deploy tool will need to provide (hopefully very simillar) -documentation of this. - -<Project> post configuration procedures --------------------------------------- -Describe any deploy tool or feature specific scripts, tests or procedures -that should be carried out on the deployment post install and configuration -in this section. - -Platform components validation ---------------------------------- -Describe any component specific validation procedures necessary for your -deployment tool in this section. diff --git a/docs/configguide/projects-configguide.rst b/docs/configguide/projects-configguide.rst deleted file mode 100644 index 71ed0d821..000000000 --- a/docs/configguide/projects-configguide.rst +++ /dev/null @@ -1,6 +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) - -.. This file will have links to other projects docs in composite doc build. - |