diff options
Diffstat (limited to 'docs/configurationguide')
| -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 | 16 | ||||
| -rw-r--r-- | docs/configurationguide/installation.procedure.render.rst | 20 |
5 files changed, 104 insertions, 0 deletions
diff --git a/docs/configurationguide/abstract.rst b/docs/configurationguide/abstract.rst new file mode 100644 index 000000000..1263dfa56 --- /dev/null +++ b/docs/configurationguide/abstract.rst @@ -0,0 +1,19 @@ +.. 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 new file mode 100644 index 000000000..f8f16ff54 --- /dev/null +++ b/docs/configurationguide/configuration.options.render.rst @@ -0,0 +1,27 @@ +.. 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 new file mode 100644 index 000000000..717cd0fa2 --- /dev/null +++ b/docs/configurationguide/feature.configuration.description.rst @@ -0,0 +1,22 @@ +.. 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 new file mode 100644 index 000000000..1b0fec4ce --- /dev/null +++ b/docs/configurationguide/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) Christopher Price (Ericsson AB) + +************************* +OPNFV Configuration Guide +************************* + +.. toctree:: + :maxdepth: 2 + + ./abstract + ./configuration.options.render + ./feature.configuration.description + ./installer.procedure.render + diff --git a/docs/configurationguide/installation.procedure.render.rst b/docs/configurationguide/installation.procedure.render.rst new file mode 100644 index 000000000..c0925c507 --- /dev/null +++ b/docs/configurationguide/installation.procedure.render.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) Sofia Wallin (Ericsson AB) + +===================== +Installation of <xxx> +===================== + +Introduction +------------ +Describe the capabilities and associated features of each installer. + +Pre-installation activities +--------------------------- +List the acitvites needed for pre-installation. + +Hardware requirement +-------------------- +List the HW requirement for each installer + |