summaryrefslogtreecommitdiffstats
path: root/docs/release/installation.introduction.rst
diff options
context:
space:
mode:
authorShubhamRathi <shubhamiiitbackup@gmail.com>2017-03-05 03:40:13 +0530
committerShubhamRathi <shubhamiiitbackup@gmail.com>2017-03-13 16:25:11 +0530
commit77a324e8f19bb42d08116a895d2c31fac2e608f9 (patch)
tree4d40cc078a1f032ee6a590f33e9e87fda846c271 /docs/release/installation.introduction.rst
parentcf86ae5d513433c597615b79994d662180359694 (diff)
Misc Changes
1. Testing on index page points to <project>/docs/testing/user/index 2. Update all artifact links to RTD using labels 3. 'OPNFV Userguide' renamed as 'OPNFV User Guide & Config Guide' Change-Id: I47837bac86feba0ae6f319b87315d38b4ef3229e Signed-off-by: ShubhamRathi <shubhamiiitbackup@gmail.com>
Diffstat (limited to 'docs/release/installation.introduction.rst')
-rw-r--r--docs/release/installation.introduction.rst58
1 files changed, 29 insertions, 29 deletions
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/>`