aboutsummaryrefslogtreecommitdiffstats
path: root/docs/release/installation.introduction.rst
diff options
context:
space:
mode:
authorStuart Mackie <wsmackie@juniper.net>2017-08-29 05:21:36 -0700
committerStuart Mackie <wsmackie@juniper.net>2017-08-29 05:21:36 -0700
commitfce102283bab73ed08c292fce03e39c52f4a1fe2 (patch)
tree299e9f8e5daca49f74f207cbe6699295b9115876 /docs/release/installation.introduction.rst
parent711967ae9639095ce41500bb0e6f80c8b80fab95 (diff)
Added doc directories
Change-Id: I671d7c3ad4f4e5e476c98f53780d867dc94b3089 Signed-off-by: Stuart Mackie <wsmackie@juniper.net>
Diffstat (limited to 'docs/release/installation.introduction.rst')
-rw-r--r--docs/release/installation.introduction.rst100
1 files changed, 100 insertions, 0 deletions
diff --git a/docs/release/installation.introduction.rst b/docs/release/installation.introduction.rst
new file mode 100644
index 0000000..cc43aa1
--- /dev/null
+++ b/docs/release/installation.introduction.rst
@@ -0,0 +1,100 @@
+.. _opnfv-installation:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) Sofia Wallin Ericsson AB
+
+=============
+Installation
+=============
+
+Abstract
+========
+
+This document provides an overview of the installation of the Danube release of OPNFV.
+
+The Danube release can be installed making use of any of the installer projects in OPNFV:
+Apex, Compass4Nfv, 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.
+
+
+Introduction
+============
+
+The OPNFV platform is comprised of a variety of upstream components that may be deployed on your
+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, and
+it is important to understand your required target platform capabilities before installing and
+configuring your scenarios.
+
+An OPNFV installation requires either a physical infrastructure environment as defined
+in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_, or a virtual one.
+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 at
+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 Danube release refer to the scenario
+description documents provided:
+
+- :ref:`os-nosdn-kvm-ha <kvmfornfv-os-nosdn-kvm-ha>`
+- :ref:`os-nosdn-kvm_ovs_dpdk-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk-noha>`
+- :ref:`os-nosdn-kvm_ovs_dpdk_bar-noha <kvmfornfv-os-nosdn-kvm_nfv_ovs_dpdk_bar-noha>`
+- :ref:`os-odl_l3-fdio-noha <os-odl_l3-fdio-noha>`
+- :ref:`os-odl_l2-fdio-ha <os-odl_l2-fdio-ha>`
+- :ref:`os-odl_l2-fdio-noha <os-odl_l2-fdio-noha>`
+- :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
+- :ref:`os-odl_l2-bgpvpn-noha <sdnvpn-os-odl_l2-bgpvpn-noha>`
+- :ref:`os-odl_l2-bgpvpn-ha <sdnvpn-os-odl_l2-bgpvpn-ha>`
+- :ref:`os-odl-gluon-noha <gluon-scenario>`
+- :ref:`os-nosdn-openo-ha <opera-os-nosdn-openo-ha>`
+- `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>`
+- `os-nosdn-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-nosdn-ovs-ha/index.html>`_
+- :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>`
+- :ref:`os-nosdn-ovs <os-nosdn-ovs>`
+- `os-odl_l3-ovs-ha <http://docs.opnfv.org/en/stable-danube/submodules/ovsnfv/docs/release/scenarios/os-odl_l3-ovs-ha/index.html>`_
+- :ref:`os-odl_l3-ovs-noha <os-odl_l3-ovs-noha>`
+- :ref:`os-odl_l3-fdio-ha <os-odl_l3-fdio-ha>`
+
+
+Installation Procedure
+======================
+
+Detailed step by step instructions for working with an installation toolchain and installing
+the required scenario are provided by the installation projects. The four projects providing installation
+support for the OPNFV Danube release are: Apex, Compass4nfv, Fuel and JOID.
+
+The instructions for each toolchain can be found in these links:
+
+- :ref:`Apex installation instruction <apex-installation>`
+- :ref:`Compass4nfv installation instruction <compass4nfv-installation>`
+- :ref:`Daisy installation instruction <daisy-installation>`
+- :ref:`Fuel installation instruction <fuel-installation>`
+- :ref:`JOID installation instruction <joid-installation>`
+
+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 part of capabilities provided in
+the platform and you may want to execute more exhaustive tests. Some investigation will be required to
+select the right test suites to run on your platform.
+
+Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`