From 35538de373a97950bfa2bc60e43e0b2422e05b9c Mon Sep 17 00:00:00 2001 From: Sofia Wallin Date: Fri, 25 Nov 2016 14:54:23 +0100 Subject: Final updates for Colorado 3.0 Change-Id: I5a7ed8e2d76b62912e8ef1ab95e7150ae1955d5a Signed-off-by: Sofia Wallin --- docs/documentation/index.rst | 146 ++++++++++----------- .../installation.introduction.rst | 39 +++--- docs/overview/overview.rst | 10 +- docs/userguide/userguide.introduction.rst | 48 +++---- 4 files changed, 122 insertions(+), 121 deletions(-) diff --git a/docs/documentation/index.rst b/docs/documentation/index.rst index 6f3ee54b8..6fd59e646 100644 --- a/docs/documentation/index.rst +++ b/docs/documentation/index.rst @@ -16,21 +16,21 @@ more detailed installation instructions and descriptive documentation. Platform documentation ====================== -* `OPNFV platform overview document `_ -* `OPNFV Installation instruction `_ -* `OPNFV user guide `_ +* `OPNFV platform overview document `_ +* `OPNFV Installation instruction `_ +* `OPNFV user guide `_ Installation instructions ========================= -* `Apex installation instruction `_ -* `Apex release notes `_ -* `Compass installation instruction `_ -* `Compass release notes `_ -* `Fuel installation instruction `_ -* `Fuel release notes `_ -* `Joid installation instruction `_ -* `Joid release notes `_ +* `Apex installation instruction `_ +* `Apex release notes `_ +* `Compass installation instruction `_ +* `Compass release notes `_ +* `Fuel installation instruction `_ +* `Fuel release notes `_ +* `Joid installation instruction `_ +* `Joid release notes `_ Feature project documentation ============================= @@ -39,139 +39,139 @@ Feature project documentation ARMband project --------------- -* `Installation instruction `_ -* `Release notes `_ +* `Installation instruction `_ +* `Release notes `_ ----------------------------------------------- +---------------------------- Copper release documentation ----------------------------------------------- +---------------------------- -* `Design documentation `_ -* `Installation instruction `_ -* `User guide `_ -* `Release notes `_ +* `Design documentation `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ ------------------------------------------------------ +-------------------------------- Doctor features and capabilities ------------------------------------------------------ +-------------------------------- -* `Project overview `_ -* `User guide `_ -* `Release notes `_ +* `Project overview `_ +* `User guide `_ +* `Release notes `_ ----------------------------------------------------------------- +-------------------------------- Domino features and capabilities ----------------------------------------------------------------- +-------------------------------- -* `User guide `_ +* `User guide `_ ------------------------------------------------- FastDataStacks feature and scenario documentation ------------------------------------------------- -* `OpenDaylight integrated fd.io scenario description `_ +* `OpenDaylight integrated fd.io scenario description `_ ------------------------------------ IPv6 platform support and capability ------------------------------------ -* `Configuration guide `_ -* `User guide `_ +* `Configuration guide `_ +* `User guide `_ ----------- KVM for NFV ----------- -* `Installation instruction `_ -* `Configuration guide `_ -* `User guide `_ -* `Release notes `_ +* `Installation instruction `_ +* `Configuration guide `_ +* `User guide `_ +* `Release notes `_ -------------------------------- MOON security management for NFV -------------------------------- -* `Project and Scenario overview `_ -* `Installation instruction `_ -* `User guide `_ -* `Release notes `_ +* `Project and Scenario overview `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ ---------------------------- Multisite datacenter project ---------------------------- -* `Installation instruction `_ -* `User guide `_ -* `Release notes `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ ------------------------- Network readiness project ------------------------- -* `Requirements document `_ +* `Requirements document `_ ---------------------- ONOS framework project ---------------------- -* `Installation instruction `_ -* `User guide `_ +* `Installation instruction `_ +* `User guide `_ ---------------------------- OVSNFV release documentation ---------------------------- -* `OVS for NFV scenario description `_ -* `Configuration guide `_ -* `User guide `_ +* `OVS for NFV scenario description `_ +* `Configuration guide `_ +* `User guide `_ -------------- Parser project -------------- -* `Parser release documentation `_ -* `Installation instruction `_ -* `User guide `_ +* `Parser release documentation `_ +* `Installation instruction `_ +* `User guide `_ ------ Pharos ------ -* `Pharos specification `_ -* `Configuration guide `_ +* `Pharos specification `_ +* `Configuration guide `_ ------- Promise ------- -* `Requirement specification `_ -* `Installation and configuration guide `_ -* `User guide `_ +* `Requirement specification `_ +* `Installation and configuration guide `_ +* `User guide `_ ------ SDNVPN ------ -* `BGPVPN scenario description `_ -* `User guide `_ -* `Release notes `_ +* `BGPVPN scenario description `_ +* `User guide `_ +* `Release notes `_ --- SFC --- -* `Design documentation `_ -* `SFC scenario description `_ -* `High availability SFC scenario description `_ -* `Installation instruction `_ -* `User guide `_ -* `Release notes `_ +* `Design documentation `_ +* `SFC scenario description `_ +* `High availability SFC scenario description `_ +* `Installation instruction `_ +* `User guide `_ +* `Release notes `_ ------------------------------------------------ Software fast-path quality metrics documentation ------------------------------------------------ -* `Release and development documentation `_ +* `Release and development documentation `_ Test Project documentation @@ -181,28 +181,28 @@ Test Project documentation Bottlenecks documentation ------------------------- -* `Installation instruction `_ -* `Release notes `_ +* `Installation instruction `_ +* `Release notes `_ ---------------------- Functest documentation ---------------------- -* `Configuration guide `_ -* `User guide `_ -* `Developer guide `_ +* `Configuration guide `_ +* `User guide `_ +* `Developer guide `_ * `Release notes `_ ------------------------- vSwitchPerf documentation ------------------------- -* `Release and development documentation `_ +* `Release and development documentation `_ ----------------------- Yardstick documentation ----------------------- -* `User guide `_ -* `Release notes `_ +* `User guide `_ +* `Release notes `_ diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst index 201112cad..298c3e6a7 100644 --- a/docs/installationprocedure/installation.introduction.rst +++ b/docs/installationprocedure/installation.introduction.rst @@ -26,7 +26,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 `_. +in the `Pharos specification `_. When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines. ========= @@ -42,14 +42,15 @@ 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 `_ -- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn `_ -- FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha `_ -- High availability service function chaining `os-odl-l2-sfc-ha `_ -- Service function chaining `os-odl-l2-sfc-noha `_ -- Accelerated KVM hypervisor `os-nosdn-kvm-ha `_ -- LXD container hypervisor `os-nosdn-lxd-noha `_ -- High Availability LXD container hypervisor `os-nosdn-lxd-ha `_ +- Accelerated OVS `os-nosdn-ovs `_ +- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn `_ + - FD.io based forwarding using opendaylight SDN `os-odl-12-fdio-noha `_ +- FD.io based forwarding for OPNFV `os-nosdn-fdio-noha `_ +- High availability service function chaining `os-odl-l2-sfc-ha `_ +- Service function chaining `os-odl-l2-sfc-noha `_ +- Accelerated KVM hypervisor `os-nosdn-kvm-ha `_ +- LXD container hypervisor `os-nosdn-lxd-noha `_ +- High Availability LXD container hypervisor `os-nosdn-lxd-ha `_ ====================== Installation Procedure @@ -61,10 +62,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 `_ -- `Compass4nfv installation instruction `_ -- `Fuel installation instruction `_ -- `Joid installation instruction `_ +- `Apex installation instruction `_ +- `Compass4nfv installation instruction `_ +- `Fuel installation instruction `_ +- `Joid installation instruction `_ ===================== OPNFV Test Frameworks @@ -78,12 +79,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 `_ -- `Yardstick user guide `_ -- `vSwitchPerf user guide `_ -- `Software Fastpath Service Quality Metrics (SFQM) user guide `_ -- `Bottlenecks user guide `_ -- `Storage Performance Benchmarking for NFVI (StorPerf) user guide `_ +- `Functest user guide `_ +- `Yardstick user guide `_ +- `vSwitchPerf user guide `_ +- `Software Fastpath Service Quality Metrics (SFQM) user guide `_ +- `Bottlenecks user guide `_ +- `Storage Performance Benchmarking for NFVI (StorPerf) user guide `_ ============== Security Notes diff --git a/docs/overview/overview.rst b/docs/overview/overview.rst index 5f2fc15e2..1ab3c6c08 100644 --- a/docs/overview/overview.rst +++ b/docs/overview/overview.rst @@ -109,7 +109,7 @@ composition may vary depending on the installer and scenario. For details on the scenarios available in OPNFV and the specific composition of components refer to the OPNFV installation instruction: -http://artifacts.opnfv.org/opnfvdocs/colorado/2.0/docs/installationprocedure/index.html +http://artifacts.opnfv.org/opnfvdocs/colorado/3.0/docs/installationprocedure/index.html ----------------- Operating Systems @@ -165,7 +165,7 @@ A typical OPNFV deployment starts with three controller nodes running in a high configuration including control plane components from OpenStack, SDN, etc. and a minimum of two compute nodes for deployment of workloads (VNFs). A detailed description of the hardware requirements required to support the 5 node configuration -can be found in pharos specification: http://artifacts.opnfv.org/pharos/colorado/2.0/docs/specification/index.html +can be found in pharos specification: http://artifacts.opnfv.org/pharos/colorado/3.0/docs/specification/index.html In addition to the deployment on a highly available physical infrastructure, OPNFV can be deployed for development and lab purposes in a virtual environment. In this case each of the hosts @@ -219,7 +219,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 `_. +`user guide `_. 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 @@ -283,6 +283,6 @@ Bottlenecks provides a framework to find system limitations and bottlenecks, pro 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 +.. _`OPNFV Configuration Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/3.0/docs/configguide +.. _`OPNFV User Guide`: http://artifacts.opnfv.org/opnfvdocs/colorado/3.0/docs/userguide .. _Dovetail project: https://wiki.opnfv.org/display/dovetail diff --git a/docs/userguide/userguide.introduction.rst b/docs/userguide/userguide.introduction.rst index 48112e78e..952a01d45 100644 --- a/docs/userguide/userguide.introduction.rst +++ b/docs/userguide/userguide.introduction.rst @@ -54,32 +54,32 @@ You can find project specific usage and configuration information below: Feature Configuration Guides ============================ -- `Armband configuration guide `_ -- `Copper configuration guide `_ -- `Doctor configuration guide `_ -- `IPv6 configuration guide `_ -- `KVMforNFV configuration guide `_ -- `Moon configuration guide `_ -- `Multisite configuration guide `_ -- `ONOSFW configuration guide `_ -- `OVSNFV configuration guide `_ -- `Promise configuration guide `_ -- `SFC configuration guide `_ +- `Armband configuration guide `_ +- `Copper configuration guide `_ +- `Doctor configuration guide `_ +- `IPv6 configuration guide `_ +- `KVMforNFV configuration guide `_ +- `Moon configuration guide `_ +- `Multisite configuration guide `_ +- `ONOSFW configuration guide `_ +- `OVSNFV configuration guide `_ +- `Promise configuration guide `_ +- `SFC configuration guide `_ Feature User Guides =================== -- `Copper user guide `_ -- `Doctor user guide `_ -- `Domino user guide `_ -- `IPv6 user guide `_ -- `KVMforNFV user guide `_ -- `Moon user guide `_ -- `Multisite user guide `_ -- `ONOSFW user guide `_ -- `OVSNFV user guide `_ -- `Parser user guide `_ -- `Promise user guide `_ -- `SDNVPN user guide `_ -- `SFC user guide `_ +- `Copper user guide `_ +- `Doctor user guide `_ +- `Domino user guide `_ +- `IPv6 user guide `_ +- `KVMforNFV user guide `_ +- `Moon user guide `_ +- `Multisite user guide `_ +- `ONOSFW user guide `_ +- `OVSNFV user guide `_ +- `Parser user guide `_ +- `Promise user guide `_ +- `SDNVPN user guide `_ +- `SFC user guide `_ -- cgit 1.2.3-korg