diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configguide/feature-config.rst | 2 | ||||
| -rw-r--r-- | docs/configguide/index.rst | 3 | ||||
| -rw-r--r-- | docs/configguide/installer-config.rst | 12 | ||||
| -rw-r--r-- | docs/configguide/installerconfig-apex.rst | 11 | ||||
| -rw-r--r-- | docs/configguide/installerconfig-fuel.rst | 4 | ||||
| -rw-r--r-- | docs/configguide/installerconfig-joid.rst | 4 | ||||
| -rw-r--r-- | docs/userguide/feature-usage.rst | 6 | ||||
| -rw-r--r-- | docs/userguide/general-system.rst | 11 | ||||
| -rw-r--r-- | docs/userguide/index.rst | 3 | ||||
| -rw-r--r-- | docs/userguide/onos.rst | 11 | ||||
| -rw-r--r-- | docs/userguide/opendaylight.rst | 12 | ||||
| -rw-r--r-- | docs/userguide/openstack.rst | 3 | ||||
| -rw-r--r-- | docs/userguide/test-usage.rst | 4 |
13 files changed, 32 insertions, 54 deletions
diff --git a/docs/configguide/feature-config.rst b/docs/configguide/feature-config.rst index 29e7e09cf..f40bff22c 100644 --- a/docs/configguide/feature-config.rst +++ b/docs/configguide/feature-config.rst @@ -8,3 +8,5 @@ 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/index.rst b/docs/configguide/index.rst index 1d042fb99..d6630663a 100644 --- a/docs/configguide/index.rst +++ b/docs/configguide/index.rst @@ -6,6 +6,8 @@ OPNFV Configuration Guide ************************* +.. test + .. toctree:: :maxdepth: 2 @@ -14,3 +16,4 @@ OPNFV Configuration Guide ./installer-config ./feature-config ./post-install + diff --git a/docs/configguide/installer-config.rst b/docs/configguide/installer-config.rst index ad10cb4ae..3569d4ed2 100644 --- a/docs/configguide/installer-config.rst +++ b/docs/configguide/installer-config.rst @@ -9,14 +9,4 @@ Installer Configuration The following sections describe the per installer configuration options. Further details for each installer are captured in the referred project documentation. -.. toctree:: - - installerconfig-apex - -.. toctree:: - - installerconfig-fuel - -.. toctree:: - - installerconfig-joid +.. <project>/docs/configguide/installerconfig.rst files will be imported below by the build script. diff --git a/docs/configguide/installerconfig-apex.rst b/docs/configguide/installerconfig-apex.rst deleted file mode 100644 index 272956540..000000000 --- a/docs/configguide/installerconfig-apex.rst +++ /dev/null @@ -1,11 +0,0 @@ -.. This work is licensed under a Creative Commons Attribution 4.0 International License. -.. http://creativecommons.org/licenses/by/4.0 - -.. NOTE: this is workaround and has to be fixed in each project repo. - -================== -Apex configuration -================== - -.. include:: ../projects/apex/configguide/introduction.rst -.. include:: ../projects/apex/configguide/baremetalinstall.rst diff --git a/docs/configguide/installerconfig-fuel.rst b/docs/configguide/installerconfig-fuel.rst deleted file mode 100644 index 2a66ea1b0..000000000 --- a/docs/configguide/installerconfig-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/installerconfig.rst diff --git a/docs/configguide/installerconfig-joid.rst b/docs/configguide/installerconfig-joid.rst deleted file mode 100644 index cd4e5e254..000000000 --- a/docs/configguide/installerconfig-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/installerconfig.rst diff --git a/docs/userguide/feature-usage.rst b/docs/userguide/feature-usage.rst index 8484a7ba5..fa1186dc6 100644 --- a/docs/userguide/feature-usage.rst +++ b/docs/userguide/feature-usage.rst @@ -10,8 +10,6 @@ The following sections of the user guide provide feature specific usage guidelin Providing users the necessary information to leveraging the features in the platform, some operation in this section may refer back to the guides in the general system usage section. -.. include:: ../projects/copper/userguide/userguide.rst -.. include:: ../projects/doctor/userguide/userguide.rst -.. include:: ../projects/ipv6/userguide/userguide.rst -.. include:: ../projects/promise/userguide/userguide.rst +.. <project>/docs/userguide/featureusage.rst files will be imported below by the build script. + diff --git a/docs/userguide/general-system.rst b/docs/userguide/general-system.rst index 055e561c2..1235c8f77 100644 --- a/docs/userguide/general-system.rst +++ b/docs/userguide/general-system.rst @@ -6,17 +6,20 @@ Using common platform components ================================ -This section outlines basic usage principans and methods for some of the commonly deployed -components of suported OPNFV scenario's in Brahmaputra. +This section outlines basic usage principals and methods for some of the commonly deployed +components of supported OPNFV scenario's in Brahmaputra. The subsections provide an outline of how these components are commonly used and how to address them in an OPNFV deployment. The components derive from autonomous upstream communities and where possible -this guide will provide direction ot the relevant documentation made available by those communities +this guide will provide direction to the relevant documentation made available by those communities to better help you navigate the OPNFV deployment. +Common VIM components +===================== + .. include:: ./openstack.rst Common SDN components ---------------------- +===================== .. include:: ./opendaylight.rst .. include:: ./onos.rst diff --git a/docs/userguide/index.rst b/docs/userguide/index.rst index bdc6f221f..d7c6d7382 100644 --- a/docs/userguide/index.rst +++ b/docs/userguide/index.rst @@ -12,5 +12,6 @@ OPNFV User Guide ./abstract ./introduction ./general-system - ./test-usage ./feature-usage + ./test-usage + diff --git a/docs/userguide/onos.rst b/docs/userguide/onos.rst index e39e2ea34..0535c3e97 100644 --- a/docs/userguide/onos.rst +++ b/docs/userguide/onos.rst @@ -2,17 +2,18 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Christopher Price (Ericsson AB) +--------------- ONOS User Guide -=============== +--------------- ONOS is an SDN controller platform developed and released by the `ONOS project <https://www.onosproject.org>`_. The ONOS controller is installed and configured in OPNFV as the networking component of a variety of OPNFV NFVI scenarios. -ONOS runs within a JVM instance and is integrated with OpenStack via a Neutron ML2 -plugin. The ONOS instance can be configured through the OpenStack Neutron interface, -or through native ONOS tools, from the OPNFV jumphost. The Brahmaputra release of +ONOS runs within a JVM instance and is integrated with OpenStack via a Neutron ML2 +plugin. The ONOS instance can be configured through the OpenStack Neutron interface, +or through native ONOS tools from the OPNFV jumphost. The Brahmaputra release of OPNFV integrates the latest `ONOS 1.4 (EMU) <https://wiki.onosproject.org/display/ONOS/Download+packages+and+tutorial+VMs>`_ release version. @@ -46,5 +47,5 @@ It is important to be aware that when working directly on the ONOS controller the OpenStack instance will not always be aware of the changes you are making to the networking controller. This may result in unrecoverable inconsistencies in your deployment. -If you have any questions or need further assistance, you may also direct your queries to +If you have any questions or need further assistance, you may also direct your queries to `ONOSFW Forum <http://forum.onosfw.com>` diff --git a/docs/userguide/opendaylight.rst b/docs/userguide/opendaylight.rst index 7171f0c3a..4df09d03a 100644 --- a/docs/userguide/opendaylight.rst +++ b/docs/userguide/opendaylight.rst @@ -2,21 +2,21 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Christopher Price (Ericsson AB) +----------------------- OpenDaylight User Guide -======================= +----------------------- OpenDaylight is an SDN controller platform developed and released by the `OpenDaylight project <https://www.opendaylight.org/>`_. The OpenDaylight controller is installed and configured in OPNFV as the networking -component of a variety of OPNFV VNFi scenarios using the neutron ODL device driver +component of a variety of OPNFV NVFi scenarios using the neutron ODL device driver as an integration point toward OpenStack. -OpenDaylight runs within a JVM that is installed in OPNFV within a container and +OpenDaylight runs within a JVM and is installed in OPNFV within a container and integrated with OpenStack. The OpenDaylight instance can be configured through the OpenStack Horizon interface, or accessed directly from the OPNFV Jumphost. The Brahmaputra release of OPNFV integrates the latest -`Lithium stable release <https://www.opendaylight.org/downloads/>`_ or when deploying -an SFC or SDNVPN scenario will integrate a Beryllium release version. +`Beryllium release <https://www.opendaylight.org/downloads/>`_. OpenDaylight references ----------------------- @@ -36,7 +36,7 @@ of the deployed system. Connecting to the OpenDaylight instance --------------------------------------- -Once you are familiar with the OpenDaylight controller and it's configuration +Once you are familiar with the OpenDaylight controller and its configuration you will want to connect to the OpenDaylight instance from the Jumphost. To do this you should open a browser on the JumpHost to the following address and enter the username and password: diff --git a/docs/userguide/openstack.rst b/docs/userguide/openstack.rst index 00267321c..2b8255bcf 100644 --- a/docs/userguide/openstack.rst +++ b/docs/userguide/openstack.rst @@ -2,8 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Christopher Price (Ericsson AB) +-------------------------------- Brahmaputra OpenStack User Guide -================================ +-------------------------------- OpenStack is a cloud operating system developed and released by the `OpenStack project <https://www.openstack.org>`_. OpenStack is used in OPNFV for diff --git a/docs/userguide/test-usage.rst b/docs/userguide/test-usage.rst index aa2ad96e0..60b95dda2 100644 --- a/docs/userguide/test-usage.rst +++ b/docs/userguide/test-usage.rst @@ -12,7 +12,5 @@ system testing, automated deployment validation and performance charecteristics The following sections outline how to use the test projects delivering automated test suites and frameworks in the in the Brahmaputra release of OPNFV. -.. include:: ../projects/functest/userguide/description.rst -.. include:: ../projects/functest/userguide/runfunctest.rst -.. include:: ../projects/vswitchperf/userguide/quickstart.rst +.. <project>/docs/userguide/testusage.rst files will be imported below by the build script. |