diff options
| -rw-r--r-- | docs/featureprojects.rst | 4 | ||||
| -rw-r--r-- | docs/index.rst | 10 | ||||
| -rw-r--r-- | docs/release/installation.introduction.rst | 58 | ||||
| -rw-r--r-- | docs/release/overview.rst | 5 | ||||
| -rw-r--r-- | docs/release/userguide.introduction.rst | 66 |
5 files changed, 69 insertions, 74 deletions
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index c35850966..ebab13b19 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -6,7 +6,6 @@ ARMband .. toctree:: :maxdepth: 1 - ../submodules/armband/docs/releasenotes/index ../submodules/armband/docs/installationprocedure/index Barometer @@ -14,7 +13,6 @@ Barometer .. toctree:: :maxdepth: 1 - ../submodules/barometer/docs/release/release-notes/index ../submodules/barometer/docs/release/configguide/index ../submodules/barometer/docs/release/userguide/index @@ -25,7 +23,6 @@ Copper :maxdepth: 1 ../submodules/copper/docs/design/index - ../submodules/copper/docs/releasenotes/index ../submodules/copper/docs/userguide/index ../submodules/copper/docs/installationprocedure/index @@ -37,7 +34,6 @@ Doctor ../submodules/doctor/docs/scenario/index ../submodules/doctor/docs/installationprocedure/index ../submodules/doctor/docs/userguide/index - ../submodules/doctor/docs/releasenotes/index Domino -------- diff --git a/docs/index.rst b/docs/index.rst index f0ea9589b..5002adb1b 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -29,11 +29,11 @@ Testing Documentation .. toctree:: :maxdepth: 1 - submodules/functest/docs/userguide/index - submodules/bottlenecks/docs/userguide/index - submodules/yardstick/docs/userguide/index - submodules/vswitchperf/docs/index - submodules/storperf/docs/index + submodules/functest/docs/testing/user/index + submodules/bottlenecks/docs/testing/user/index + submodules/yardstick/docs/testing/user/index + submodules/vswitchperf/docs/testing/user/index + submodules/storperf/docs/testing/user/index Development Documentation diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index 904c2d66b..ab043c4a2 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -29,7 +29,7 @@ it is important to understand your required target platform capabilities before configuring your target scenario. An OPNFV installation requires either a physical, or virtual, infrastructure environment as defined -in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`_. +in the `Pharos specification <http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html>`. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. @@ -45,14 +45,14 @@ where each scenario will include different source components or configurations. To learn more about the scenarios supported in the Colorado release refer to the scenario description documents provided: -- Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>`_ -- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>`_ -- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>`_ -- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_ -- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_ -- Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/scenarios_os-nosdn-kvm-ha/index.html>`_ -- LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>`_ -- High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>`_ +- Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/scenarios_os-nosdn-ovs/index.html>` +- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/scenarios_os-odl_l2-bgpvpn/index.html>` +- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha <http://artifacts.opnfv.org/fds/colorado/2.0/scenarios_os-odl_l2-fdio-noha/index.html>` +- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-ha/index.html>` +- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/scenarios_os-odl_l2-sfc-noha/index.html>` +- Accelerated KVM hypervisor `os-nosdn-kvm-ha <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/scenarios_os-nosdn-kvm-ha/index.html>` +- LXD container hypervisor `os-nosdn-lxd-noha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-noha/index.html>` +- High Availability LXD container hypervisor `os-nosdn-lxd-ha <http://artifacts.opnfv.org/joid/colorado/2.0/docs/scenarios_os-nosdn-lxd-ha/index.html>` Installation Procedure @@ -64,10 +64,10 @@ support for the OPNFV Colorado release are; Apex, Compass4nfv, Fuel and Joid. The instructions for each toolchain can be found in these links: -- `Apex installation instruction <http://artifacts.opnfv.org/apex/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Compass4nfv installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/2.0/docs/installationprocedure/index.html>`_ +- :ref:`Apex installation instruction <apex-installation>` +- :ref:`Compass4nfv installation instruction <compass4nfv-installation>` +- :ref:`Fuel installation instruction <fuel-installation>` +- :ref:`Joid installation instruction <joid-installation>` OPNFV Test Frameworks @@ -81,12 +81,12 @@ select the right test suites to run on your platform from the available projects Many of the OPNFV test project provide user-guide documentation and installation instructions as provided below: -- `Functest user guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_ -- `Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/2.0/docs/userguide/index.html>`_ -- `vSwitchPerf user guide <http://artifacts.opnfv.org/vswitchperf/colorado/2.0/index.html>`_ -- `Software Fastpath Service Quality Metrics (SFQM) user guide <http://artifacts.opnfv.org/fastpathmetrics/colorado/2.0/index.html>`_ -- `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Storage Performance Benchmarking for NFVI (StorPerf) user guide <http://artifacts.opnfv.org/storperf/colorado/2.0/docs/userguide/index.html>`_ +- :ref:`Functest user guide <functest-userguide>` +- :ref:`Yardstick user guide <yardstick-userguidde>` +- :ref:`vSwitchPerf user guide <vswitchperf-userguide>` +- :ref:`Software Fastpath Service Quality Metrics (SFQM) user guide <fastpathmetrics-userguide>` +- :ref:`Bottlenecks user guide <bottlenecks-userguide>` +- :ref:`Storage Performance Benchmarking for NFVI (StorPerf) user guide <storperf-userguide>` Security Notes @@ -95,13 +95,13 @@ Security Notes The following patches were applied to fix security issues discovered in opnfv projects, during the c-release cycle. -- `Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>`_ -- `Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>`_ -- `Implements use of yaml.safe_load <https://gerrit.opnfv.org/gerrit/#/c/20911/>`_ -- `Fix security issues reported by the security audit <https://gerrit.opnfv.org/gerrit/#/c/20693/>`_ -- `Fix issues found in security review <https://gerrit.opnfv.org/gerrit/#/c/21541/>`_ -- `Removing OpenSteak Project <https://gerrit.opnfv.org/gerrit/#/c/22139/>`_ -- `Remove unsed files in open-contrail role <https://gerrit.opnfv.org/gerrit/#/c/21997/>`_ -- `Get rid of private key in repo <https://gerrit.opnfv.org/gerrit/#/c/21985>`_ -- `Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>`_ -- `Remove `Debug = True when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>`_ +- :ref:`Removal of private keys <https://gerrit.opnfv.org/gerrit/#/c/21995/>` +- :ref:`Fix security issues of eval-s in testapi <https://gerrit.opnfv.org/gerrit/#/c/20751/>` +- :ref:`Implements use of yaml.safe_load <https://gerrit.opnfv.org/gerrit/#/c/20911/>` +- :ref:`Fix security issues reported by the security audit <https://gerrit.opnfv.org/gerrit/#/c/20693/>` +- :ref:`Fix issues found in security review <https://gerrit.opnfv.org/gerrit/#/c/21541/>` +- :ref:`Removing OpenSteak Project <https://gerrit.opnfv.org/gerrit/#/c/22139/>` +- :ref:`Remove unsed files in open-contrail role <https://gerrit.opnfv.org/gerrit/#/c/21997/>` +- :ref:`Get rid of private key in repo <https://gerrit.opnfv.org/gerrit/#/c/21985>` +- :ref:`Handling file loads and tmp dirs differently <https://gerrit.opnfv.org/gerrit/#/c/21499>` +- :ref:`Remove `Debug = True when run Flask and add logger <https://gerrit.opnfv.org/gerrit/#/c/21799/>` diff --git a/docs/release/overview.rst b/docs/release/overview.rst index 83ffe4deb..4d2b611c6 100644 --- a/docs/release/overview.rst +++ b/docs/release/overview.rst @@ -223,8 +223,7 @@ Functest Functest provides a functional testing framework incorporating a number of test suites and test cases that test and verify OPNFV platform functionality. -The scope of Functest and relevant test cases can be found in its -`user guide <http://artifacts.opnfv.org/functest/colorado/2.0/docs/userguide/index.html>`_. +The scope of Functest and relevant test cases can be found in its :ref:`user guide <Functest-UserGuide>`_ Functest provides both feature project and component test suite integration, leveraging OpenStack and SDN controllers testing frameworks to verify the key components of the OPNFV @@ -290,4 +289,4 @@ root cause isolation capabilities to facilitate system evaluation. .. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/configguide .. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/userguide -.. _Dovetail project: https://wiki.opnfv.org/display/dovetail +.. _`Dovetail project`: https://wiki.opnfv.org/display/dovetail diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index ecbb75884..b4ebab25a 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -2,9 +2,9 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Sofia Wallin (sofia.wallin@ericssion.com) -================ -OPNFV Userguide -================ +====================================== +OPNFV User Guide & Configuration Guide +====================================== Abstract ======== @@ -25,15 +25,15 @@ Introduction OPNFV provides a suite of scenarios, infrastructure depoyment options, which are able to be installed to host virtualized network functions (VNFs). -This guide intends to help users of the platform leverage the features and +This Guide intends to help Users of the platform leverage the features and capabilities delivered by the OPNFV project in support of these applications. OPNFV Continuous Integration builds, deploys and tests combinations of virtual infrastructure components in what are defined as scenarios. A scenario may include components such as OpenStack, OpenDaylight, OVS, KVM etc. where each -scenario will include different source components or configurations. Scenarios +scenario will include different source components or Configurations. Scenarios are designed to enable specific features and capabilities in the platform that -can be leveraged by the OPNFV user community. +can be leveraged by the OPNFV User community. Feature Overview @@ -42,47 +42,47 @@ Feature Overview The following links outline the feature deliveries from the participant OPNFV projects in the Colorado release. Each of the participating projects provides detailed descriptions about the delivered features. Including use cases, -implementation and configuration specifics on a per OPNFV project basis. +implementation and Configuration specifics on a per OPNFV project basis. The following are Configuration Guides and User Guides and assume that the reader has already some -information about a given projects specifics and deliverables. These guides +information about a given projects specifics and deliverables. These Guides are intended to be used following the installation of a given OPNFV installer to allow a user to deploy and implement feature delivered by OPNFV. If you are unsure about the specifics of a given project, please refer to the OPNFV projects home page, found on http://wiki.opnfv.org, for specific details. -You can find project specific usage and configuration information below: +You can find project specific usage and Configuration information below: Feature Configuration Guides ============================ -- `Armband configuration guide <http://artifacts.opnfv.org/armband/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Copper configuration guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Doctor configuration guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/installationprocedure/index.html>`_ -- `IPv6 configuration guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/installationprocedure/index.html>`_ -- `KVMforNFV configuration guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Moon configuration guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/installationprocedure/index.html>`_ -- `Multisite configuration guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/installationprocedure/index.html>`_ -- `ONOSFW configuration guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/installationprocedure/index.html>`_ -- `OVSNFV configuration guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/configguide/index.html>`_ -- `Promise configuration guide <https://git.opnfv.org/promise/tree/docs/release/configguide/feature.configuration.rst>`_ -- `SFC configuration guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/installationprocedure/index.html>`_ +- :ref:`Armband Configuration Guide <armband-configguide>` +- :ref:`Copper Configuration Guide <copper-configguide>` +- :ref:`Doctor Configuration Guide <doctor-configguide>` +- :ref:`IPv6 Configuration Guide <ipv6-configguide>` +- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` +- :ref:`Moon Configuration Guide <moon-configguide>` +- :ref:`Multisite Configuration Guide <multisite-configguide>` +- :ref:`ONOSFW Configuration Guide <onosfw-configguide>` +- :ref:`OVSNFV Configuration Guide <ovsnfv-configguide>` +- :ref:`Promise Configuration Guide <promise-configguide>` +- :ref:`SFC Configuration Guide <sfc-configguide>` Feature User Guides =================== -- `Copper user guide <http://artifacts.opnfv.org/copper/colorado/2.0/docs/userguide/index.html>`_ -- `Doctor user guide <http://artifacts.opnfv.org/doctor/colorado/2.0/docs/userguide/index.html>`_ -- `Domino user guide <http://artifacts.opnfv.org/domino/colorado/2.0/docs/userguide/index.html>`_ -- `IPv6 user guide <http://artifacts.opnfv.org/ipv6/colorado/2.0/docs/userguide/index.html>`_ -- `KVMforNFV user guide <http://artifacts.opnfv.org/kvmfornfv/colorado/2.0/docs/userguide/index.html>`_ -- `Moon user guide <http://artifacts.opnfv.org/moon/colorado/2.0/docs/userguide/index.html>`_ -- `Multisite user guide <http://artifacts.opnfv.org/multisite/colorado/2.0/docs/userguide/index.html>`_ -- `ONOSFW user guide <http://artifacts.opnfv.org/onosfw/colorado/2.0/docs/userguide/index.html>`_ -- `OVSNFV user guide <http://artifacts.opnfv.org/ovsnfv/colorado/2.0/docs/userguide/index.html>`_ -- `Parser user guide <http://artifacts.opnfv.org/parser/colorado/2.0/docs/userguide/index.html>`_ -- `Promise user guide <https://git.opnfv.org/promise/tree/docs/release/userguide/feature.userguide.rst>`_ -- `SDNVPN user guide <http://artifacts.opnfv.org/sdnvpn/colorado/2.0/docs/userguide/index.html>`_ -- `SFC user guide <http://artifacts.opnfv.org/sfc/colorado/2.0/docs/userguide/index.html>`_ +- :ref:`Copper User Guide <copper-userguide>` +- :ref:`Doctor User Guide <doctor-userguide>` +- :ref:`Domino User Guide <domino-userguide>` +- :ref:`IPv6 User Guide <ipv6-userguide>` +- :ref:`KVMforNFV User Guide <kvmfornfv-userguide>` +- :ref:`Moon User Guide <moon-userguide>` +- :ref:`Multisite User Guide <multisite-userguide>` +- :ref:`ONOSFW User Guide <onosfw-userguide>` +- :ref:`OVSNFV User Guide <ovsnfv-userguide>` +- :ref:`Parser User Guide <parser-userguide>` +- :ref:`Promise User Guide <promise-userguide>` +- :ref:`SDNVPN User Guide <sdnvpn-userguide>` +- :ref:`SFC User Guide <sfc-userguide>` |