diff options
Diffstat (limited to 'docs')
-rw-r--r-- | docs/featureprojects.rst | 89 | ||||
-rw-r--r-- | docs/release/installation.introduction.rst | 43 | ||||
-rw-r--r-- | docs/release/release-notes.rst | 8 | ||||
-rw-r--r-- | docs/release/userguide.introduction.rst | 13 | ||||
m--------- | docs/submodules/apex | 0 | ||||
m--------- | docs/submodules/armband | 0 | ||||
m--------- | docs/submodules/clover | 0 | ||||
m--------- | docs/submodules/compass4nfv | 0 | ||||
m--------- | docs/submodules/fuel | 0 | ||||
m--------- | docs/submodules/functest | 0 | ||||
m--------- | docs/submodules/ipv6 | 0 | ||||
m--------- | docs/submodules/qtip | 0 | ||||
m--------- | docs/submodules/releng | 0 | ||||
m--------- | docs/submodules/sdnvpn | 0 | ||||
m--------- | docs/submodules/snaps | 0 | ||||
m--------- | docs/submodules/yardstick | 0 |
16 files changed, 29 insertions, 124 deletions
diff --git a/docs/featureprojects.rst b/docs/featureprojects.rst index ad604618b..bde163349 100644 --- a/docs/featureprojects.rst +++ b/docs/featureprojects.rst @@ -58,6 +58,11 @@ Barometer ../submodules/barometer/docs/development/design/index ../submodules/barometer/docs/development/manuals/index +Clover +------ +.. toctree:: + :maxdepth: 1 + ../submodules/clover/docs/development/design/index Compass4Nfv ----------- @@ -73,20 +78,6 @@ Compass4Nfv ../submodules/compass4nfv/docs/development/manuals/index -Copper ------- -.. toctree:: - :maxdepth: 1 - - ../submodules/copper/docs/development/overview/index - ../submodules/copper/docs/development/requirements/index - ../submodules/copper/docs/release/installation/index - ../submodules/copper/docs/release/configguide/index - ../submodules/copper/docs/release/userguide/index - ../submodules/copper/docs/development/design/index - ../submodules/copper/docs/development/manuals/index - - Daisy4NFV --------- .. toctree:: @@ -111,20 +102,6 @@ Doctor ../submodules/doctor/docs/development/manuals/index -Domino ------- -.. toctree:: - :maxdepth: 1 - - ../submodules/domino/docs/development/overview/index - ../submodules/domino/docs/development/requirements/index - ../submodules/domino/docs/release/installation/index - ../submodules/domino/docs/release/configguide/index - ../submodules/domino/docs/release/userguide/index - ../submodules/domino/docs/development/design/index - ../submodules/domino/docs/development/manuals/index - - IPV6 ---- .. toctree:: @@ -153,48 +130,6 @@ Joid ../submodules/joid/docs/development/manuals/index -Kvmfornfv ---------- -.. toctree:: - :maxdepth: 1 - - ../submodules/kvmfornfv/docs/development/overview/index - ../submodules/kvmfornfv/docs/development/requirements/index - ../submodules/kvmfornfv/docs/release/installation/index - ../submodules/kvmfornfv/docs/release/configguide/index - ../submodules/kvmfornfv/docs/release/userguide/index - ../submodules/kvmfornfv/docs/development/design/index - ../submodules/kvmfornfv/docs/development/manuals/index - - -Multisite ---------- -.. toctree:: - :maxdepth: 1 - - ../submodules/multisite/docs/development/overview/index - ../submodules/multisite/docs/development/requirements/index - ../submodules/multisite/docs/release/installation/index - ../submodules/multisite/docs/release/configguide/index - ../submodules/multisite/docs/release/userguide/index - ../submodules/multisite/docs/development/design/index - ../submodules/multisite/docs/development/manuals/index - - -Netready --------- -.. toctree:: - :maxdepth: 1 - - ../submodules/netready/docs/development/overview/index - ../submodules/netready/docs/development/requirements/index - ../submodules/netready/docs/release/installation/index - ../submodules/netready/docs/release/configguide/index - ../submodules/netready/docs/release/userguide/index - ../submodules/netready/docs/development/design/index - ../submodules/netready/docs/development/manuals/index - - Opera ----- .. toctree:: @@ -223,20 +158,6 @@ Parser ../submodules/parser/docs/development/manuals/index -Promise -------- -.. toctree:: - :maxdepth: 1 - - ../submodules/promise/docs/development/overview/index - ../submodules/promise/docs/development/requirements/index - ../submodules/promise/docs/release/installation/index - ../submodules/promise/docs/release/configguide/index - ../submodules/promise/docs/release/userguide/index - ../submodules/promise/docs/development/design/index - ../submodules/promise/docs/development/manuals/index - - SDNVPN -------- .. toctree:: diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst index b745714f0..a7aa975b2 100644 --- a/docs/release/installation.introduction.rst +++ b/docs/release/installation.introduction.rst @@ -11,9 +11,9 @@ Installation Abstract ======== -This an overview document for the installation of the Euphrates release of OPNFV. +This an overview document for the installation of the Fraser release of OPNFV. -The Euphrates release can be installed making use of any of the installer projects in OPNFV: +The Fraser release can be installed making use of any of the installer projects in OPNFV: Apex, Compass4Nfv, Daisy4NFV, Fuel or JOID. Each installer provides the ability to install a common OPNFV platform as well as integrating additional features delivered through a variety of scenarios by the OPNFV community. @@ -45,34 +45,33 @@ solving specific problems for the deployment of VNF’s. A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc., where each scenario will include different source components or configurations. -To learn more about the scenarios supported in the Euphrates release refer to the scenario +To learn more about the scenarios supported in the Fraser release refer to the scenario description documents provided: -- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>` -- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` -- `os-odl_l2-sfc-ha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-ha/index.html>`_ -- `os-odl_l2-sfc-noha <http://docs.opnfv.org/en/stable-danube/submodules/sfc/docs/release/scenarios/os-odl_l2-sfc-noha/index.html>`_ -- :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>` -- :ref:`os-nosdn-lxd-noha <os-nosdn-lxd-noha>` -- :ref:`k8-nosdn-nofeature-noha <k8-nosdn-nofeature-noha>` -- :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>` -- :ref:`os-nosdn-ovs-ha <os-nosdn-ovs-ha1>` -- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha1>` -- :ref:`os-nosdn-calipso-noha <os-nosdn-calipso-noha>` + - :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` - :ref:`os-nosdn-ovs_dpdk-noha <os-nosdn-ovs_dpdk-noha>` -- :ref:`os-odl-fdio-dvr-noha <os-odl-fdio-dvr-noha>` -- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>` -- :ref:`os-nosdn-kvm_ovs_dpdk-ha <os-nosdn-kvm_ovs_dpdk-ha>` -- :ref:`os-odl_l2-moon-ha <os-odl_l2-moon-ha>` - :ref:`k8-nosdn-lb-noha <k8-nosdn-lb-noha>` -- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>` -- :ref:`os-onos-sfc-ha <os-onos-sfc-ha>` -- :ref:`os-nosdn-ovs_dpdk-ha <os-nosdn-ovs_dpdk-ha>` -- :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>` - :ref:`k8-ovn-lb-noha <k8-ovn-lb-noha>` +- :ref:`k8-nosdn-lb_ceph-noha <k8-nosdn-lb_ceph-noha>` +- :ref:`k8-canal-lb-noha <k8-canal-lb-noha>` +- :ref:`os-nosdn-lxd-ha <os-nosdn-lxd-ha>` +- :ref:`os-nosdn-openbaton-ha <os-nosdn-openbaton-ha>` +- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha1>` +- :ref:`os-nosdn-ovs-ha <os-nosdn-ovs-ha1>` - :ref:`os-nosdn-bar-ha <os-nosdn-bar-ha>` - :ref:`os-nosdn-bar-noha <os-nosdn-bar-noha>` +- :ref:`os-nosdn-ovs_dpdk-noha <os-nosdn-ovs_dpdk-noha>` +- :ref:`os-nosdn-bar-ha <kvmfornfv-os-nosdn-bar-ha>` +- :ref:`os-nosdn-bar-noha <kvmfornfv-os-nosdn-bar-noha>` +- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>` +- :ref:`os-nosdn-fdio-ha <os-nosdn-fdio-ha>` +- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>` +- :ref:`os-nosdn-ovs-ha <os-nosdn-ovs-ha>` +- :ref:`os-odl-sfc-ha <os-odl-sfc-ha>` +- :ref:`os-odl-sfc-noha <os-odl-sfc-noha>` +- :ref:`os-odl-bgpvpn-noha <os-odl-bgpvpn-noha>` +- :ref:`os-odl-bgpvpn-ha <os-odl-bgpvpn-ha>` Installation Procedure ====================== diff --git a/docs/release/release-notes.rst b/docs/release/release-notes.rst index 8aad8a4d6..ade660c6c 100644 --- a/docs/release/release-notes.rst +++ b/docs/release/release-notes.rst @@ -38,20 +38,12 @@ Project release notes: :ref:`Joid Release Notes <joid-releasenotes>` -:ref:`KVMforNFV Release Notes <kvmfornfv-releasenotes>` - -:ref:`Moon Release Notes <moon-releasenotes>` - -:ref:`Netready Release Notes <netready-releasenotes>` - :ref:`NFVBench Release Notes <nfvbench-releasenotes>` :ref:`Orchestra Release Notes <orchestra-releasenotes>` :ref:`Parser Release Notes <parser-releasenotes>` -:ref:`Promise Release Notes <promise-releasenotes>` - :ref:`QTIP Release Notes <qtip-releasenotes>` :ref:`SampleVNF Release Notes <samplevnf-releasenotes>` diff --git a/docs/release/userguide.introduction.rst b/docs/release/userguide.introduction.rst index bd448a85a..337bf6730 100644 --- a/docs/release/userguide.introduction.rst +++ b/docs/release/userguide.introduction.rst @@ -15,7 +15,7 @@ OPNFV is a collaborative project aimed at providing a variety of virtualisation deployments intended to host applications serving the networking and carrier industries. This document provides guidance and instructions for using platform features designed to support these applications that are made available in the OPNFV -Euphrates release. +Fraser release. This document is not intended to replace or replicate documentation from other upstream open source projects such as KVM, OpenDaylight, OpenStack, etc., but to highlight the @@ -42,7 +42,7 @@ Feature Overview ================ The following links outline the feature deliverables from participating OPNFV -projects in the Euphrates release. Each of the participating projects provides +projects in the Fraser release. Each of the participating projects provides detailed descriptions about the delivered features including use cases, implementation, and configuration specifics. @@ -58,17 +58,13 @@ OPNFV wiki page at http://wiki.opnfv.org for more details. Feature Configuration Guides ============================ +- :ref:`Auto Configuration Guide <auto-configguide>` - :ref:`Barometer Configuration Guide <barometer-configguide>` - :ref:`Doctor Configuration Guide <doctor-configguide>` -- :ref:`Domino Configuration Guide <domino-configguide>` - :ref:`IPv6 Configuration Guide <ipv6-configguide>` -- :ref:`KVMforNFV Configuration Guide <kvmfornfv-configguide>` -- :ref:`Moon Configuration Guide <moon-configguide>` - :ref:`Netready Configuration Guide <netready-configguide>` -- :ref:`ONOSFW Configuration Guide <onosfw-configguide>` - :ref:`Orchestra Configuration Guide <orchestra-configguide>` - :ref:`Parser Configuration Guide <parser-configguide>` -- :ref:`Promise Configuration Guide <promise-configguide>` - :ref:`SDNVPN Configuration Guide <sdnvpn-configguide>` - :ref:`SFC Configuration Guide <sfc-configguide>` @@ -79,13 +75,10 @@ Feature User Guides - :ref:`Auto User Guide <auto-userguide>` - :ref:`Barometer User Guide <barometer-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:`OpenContrail Virtual Networking User Guide <ovno-userguide>` - :ref:`Orchestra User Guide <orchestra-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>` diff --git a/docs/submodules/apex b/docs/submodules/apex -Subproject e47c969c9fd655b87670de13a4daac343a08f6d +Subproject f8fd162ac74c83cd972311ee152b09bad631299 diff --git a/docs/submodules/armband b/docs/submodules/armband -Subproject 3f7602eaa9811170b9caeda6f927cdf6e264738 +Subproject b3c8e34c2f14000fdd442e8fe7d2fddfa11f941 diff --git a/docs/submodules/clover b/docs/submodules/clover -Subproject 106c87ed8b51ee9e202cc831f8d22d3f0c8240a +Subproject dc27eb3f6db07e68fc49661692bb6111a4fe4f5 diff --git a/docs/submodules/compass4nfv b/docs/submodules/compass4nfv -Subproject 01ff42530757cf99e99b0d63d6daa822b93e194 +Subproject 84036899c0ec4bde40c6b71e2c8d447bbdb79b0 diff --git a/docs/submodules/fuel b/docs/submodules/fuel -Subproject 6e28bcea8eca57d6befae2cd272a39564b0311e +Subproject 90d927d6b480d7169fe328a137b9f62bb2348db diff --git a/docs/submodules/functest b/docs/submodules/functest -Subproject c65906e74c02805308ff99c99bc207ac424437e +Subproject 4ca522bdb4918bf97c0e2ad9b1c8c281c0133ff diff --git a/docs/submodules/ipv6 b/docs/submodules/ipv6 -Subproject 8d92071b644ac9e45208feca41b6d45f008ec9a +Subproject 5b914695088b39aee3886bd60be4707b7a11a1e diff --git a/docs/submodules/qtip b/docs/submodules/qtip -Subproject 6b2283677453e83d0a215301ae2adfa42425490 +Subproject 2c1f682a9c7216a159f2d6c5b710eaf9bb7cceb diff --git a/docs/submodules/releng b/docs/submodules/releng -Subproject cf1ba3b2c19202a17fdd12a9ada8ca3a1f3f627 +Subproject 7ad76ea8d3f6840f145e8c9fa004d2be528f94b diff --git a/docs/submodules/sdnvpn b/docs/submodules/sdnvpn -Subproject 80186c4abd195947c63b058452d0a3c6b61d68c +Subproject d56cc9831e64559cf97071fd8d8a4798bd3a234 diff --git a/docs/submodules/snaps b/docs/submodules/snaps -Subproject 4edc3d87392cf78c3f046217543fb7638041330 +Subproject 1c749e4c6c21bea0c6bb6f177f4c3116d581dcc diff --git a/docs/submodules/yardstick b/docs/submodules/yardstick -Subproject 7262ad1b008f74b51460ce07986458ca3bfe8cc +Subproject 26083c4931c0bc72569d782c9df569dc6369077 |