diff options
Diffstat (limited to 'docs/release/configguide')
| -rw-r--r-- | docs/release/configguide/featureconfig.rst | 52 | ||||
| -rw-r--r-- | docs/release/configguide/postinstall.rst | 78 |
2 files changed, 92 insertions, 38 deletions
diff --git a/docs/release/configguide/featureconfig.rst b/docs/release/configguide/featureconfig.rst index 005fe9f..2be0fff 100644 --- a/docs/release/configguide/featureconfig.rst +++ b/docs/release/configguide/featureconfig.rst @@ -2,31 +2,49 @@ .. http://creativecommons.org/licenses/by/4.0 ====================== -NetReady Configuration +Gluon 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. -.. contents:: - :depth: 3 - :local: +.. 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. + +The configuration of the Gluon framework is entirely handled by the +corresponding scenario os-odl-gluon-noha available for the Apex installer. In +general, the installer installs and configures all components so that no +additional configuration steps are needed after installing the aforementioned +scenario. + 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 + +.. 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 + +No pre-configuration steps are needed in addition to the pre-configuration +needed for an Apex virtual or bare metal deployment. Please review the Apex +installation instructions for further details. + Hardware configuration ---------------------- -Describe the hardware configuration needed for this specific feature + +No specific hardware configuration is needed for running the os-odl-gluon-noha +scenario providing the Gluon framework in addition to the hardware requirements +listed for Apex-based scenarios. + 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...) + +.. 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...) + +No specific additional configuration is needed after installing the +os-odl-gluon-noha scenario using the Apex installer. diff --git a/docs/release/configguide/postinstall.rst b/docs/release/configguide/postinstall.rst index a1a3a2b..4073393 100644 --- a/docs/release/configguide/postinstall.rst +++ b/docs/release/configguide/postinstall.rst @@ -1,35 +1,71 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 -==================================== -NetReady Post Installation Procedure -==================================== +================================= +Gluon Post Installation Procedure +================================= -Add a brief introduction to the methods of validating the installation -according to this specific installer or feature. +.. Add a brief introduction to the methods of validating the installation +.. according to this specific installer or feature. + +The configuration of the Gluon framework is entirely handled by the +corresponding scenario os-odl-gluon-noha available for the Apex installer. In +general, Apex installs and configures all components so that no additional +configuration steps are needed after deploying the aforementioned scenario. -.. contents:: - :depth: 3 - :local: 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. +.. 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. + +An overview of all test suites run by the OPNFV pipeline against the +os-odl-gluon-noha scenario as well as the test results can be found at the +`Functest test result overview page. +<http://testresults.opnfv.org/reporting/functest/release/master/index-status-apex.html>`_ + -NetReady post configuration procedures + +Gluon 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. + +.. 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. + +No post configuration procedures need to be performed after deploying the +os-odl-gluon-noha scenario using the Apex installer. + + Platform components validation ------------------------------ -Describe any component specific validation procedures necessary for your -deployment tool in this section. + +.. Describe any component specific validation procedures necessary for your +.. deployment tool in this section. + +As described in the `Gluon scenario description +<../release_scenarios_os-odl-gluon-noha/index.html>`_, the Gluon framework +consists of five software components. This section describes how to validate +their successful installation. + +* **Gluon core plugin**: Check in the file ``/etc/neutron/neutron.conf`` that + the Neutron core plugin is set to ``gluon``. + +* **Proton server**: Check that the process ``proton-server`` is running. + +* **Proton client**: Verify that the ``protonclient`` tool is installed and + executable. + +* **etcd**: Verify that the etcd key-value-store is installed and running by + means of the etcdctl tool. + +* **Proton shim layer for OpenDaylight**: Verify that the + ``proton-shim-server`` process is running. |