summaryrefslogtreecommitdiffstats
path: root/docs/installationprocedure/installation.introduction.rst
diff options
context:
space:
mode:
authorSofia Wallin <sofia.wallin@ericsson.com>2016-08-15 15:20:50 +0200
committerSofia Wallin <sofia.wallin@ericsson.com>2016-09-19 13:38:49 +0000
commitbdeaf3f6beb1be54c14ccfa46576959ee6d4067c (patch)
tree2032d15c0cc26e2b79b9f26176e4a3780b21d0c2 /docs/installationprocedure/installation.introduction.rst
parent59b1fbbd5f6796b184a283c928d9e9154678df55 (diff)
WIP: Created 2 introduction documents for user guide and installation
Work on the contant in both installation and user guide Started to add artifacts in the installation instruction and user guide This is a first draft of the installation.introduction.rst and userguide.introduction.rst. Some of the information has been reused from the Brahmaputra docs with modifications. Please comment and add as needed/wanted. Change-Id: I0c6d79aac7d1152ec894986dda251ad2d3c7048e Signed-off-by: Sofia Wallin <sofia.wallin@ericsson.com> (cherry picked from commit e042f556c6c25858f328cb6287c164b2514a2561)
Diffstat (limited to 'docs/installationprocedure/installation.introduction.rst')
-rw-r--r--docs/installationprocedure/installation.introduction.rst84
1 files changed, 84 insertions, 0 deletions
diff --git a/docs/installationprocedure/installation.introduction.rst b/docs/installationprocedure/installation.introduction.rst
new file mode 100644
index 000000000..ae4a601ae
--- /dev/null
+++ b/docs/installationprocedure/installation.introduction.rst
@@ -0,0 +1,84 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+ .. (c) Sofia Wallin Ericsson AB
+
+========
+Abstract
+========
+
+The following document provides an overview of the instructions required for the installation
+of the Colorado release of OPNFV.
+
+The Colorado release can be installed using a variety of technologies provided by the
+integration projects participating in OPNFV: Apex, Compass4Nfv, Fuel and 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.
+
+============
+Introduction
+============
+
+The OPNFV platform is comprised of a variety of upstream components that may be deployed on your physical
+infrastructure. A composition of components, tools and configurations is identified in OPNFV as a
+deployment scenario.
+The various OPNFV scenarios provide unique features and capabilities that you may want to leverage,
+it is important to understand your required target platform capabilities before installing and
+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/docs/specification/index.html>`_.
+When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
+
+=========
+Scenarios
+=========
+
+OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
+architectures and locations. Each scenario provides specific capabilities and/or components aimed to
+solve 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 Colorado release refer to the scenario
+description documents provided:
+
+- Accelerated OVS `os-nosdn-ovs <http://artifacts.opnfv.org/ovsnfv/colorado/docs/scenarios_os-nosdn-ovs/index.html>`_
+- FD.io based forwarding `os-nosdn-fdio-noha <http://artifacts.opnfv.org/fds/docs/scenarios_os-nosdn-fdio-noha/index.html>`_
+- Layer 3 overlay using opendaylight `os-odl-l2-bgpvpn <http://artifacts.opnfv.org/bgpvpn/colorado/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/scenarios_os-odl_l2-fdio-noha/index.html>`_
+- High availability service function chaining `os-odl-l2-sfc-ha <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-ha/index.html>`_
+- Service function chaining `os-odl-l2-sfc-noha <http://artifacts.opnfv.org/sfc/colorado/docs/scenarios_os-odl_l2-sfc-noha/index.html>`_
+- `os-odl-l2-moon-ha <http://artifacts.opnfv.org/moon/colorado/docs/senarios/os-odl_l2-moon-ha/index.html>`_
+
+======================
+Installation Procedure
+======================
+
+Detailed step by step instructions for working with an installation toolchain and installing
+the required scenario are provided by each installation project. The four projects providing installation
+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/docs/installationprocedure/index.html>`_
+- `Compass4nfv installation instruction <http://artifacts.opnfv.org/compass4nfv/colorado/docs/installationprocedure/index.html>`_
+- `Fuel installation instruction <http://artifacts.opnfv.org/fuel/colorado/docs/installationprocedure/index.html>`_
+- `Joid installation instruction <http://artifacts.opnfv.org/joid/colorado/docs/installationprocedure/index.html>`_
+
+=====================
+OPNFV Test Frameworks
+=====================
+
+If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV
+your system will have been validated once the installation is completed.
+The basic deployment validation only addresses a small component of the capability provided in
+the platform and you may desire to execute more exhaustive tests. Some investigation is required to
+select the right test suites to run on your platform from the available projects and suites.
+
+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/docs/userguide/index.html>`_
+- `Yardstick user guide <http://artifacts.opnfv.org/yardstick/colorado/docs/userguide/index.html>`_
+- `vSwitchPerf user guide <http://artifacts.opnfv.org/vswitchperf/colorado/index.html>`_
+- `Software Fastpath Service Quality Metrics (SFQM) user guide <http://artifacts.opnfv.org/fastpathmetrics/colorado/index.html>`_
+- `Bottlenecks user guide <http://artifacts.opnfv.org/bottlenecks/colorado/docs/installationprocedure/index.html>`_