7a5132dcf14912bef97255617a8322a3553f1aa1
[opnfvdocs.git] / docs / release / installation.introduction.rst
1 .. _opnfv-installation:
2
3 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
4 .. SPDX-License-Identifier: CC-BY-4.0
5 .. (c) Sofia Wallin Ericsson AB and other contributors
6
7 ============
8 Installation
9 ============
10
11 Abstract
12 ========
13
14 This an overview document for the installation of the Iruya release of OPNFV.
15
16 The Iruya release can be installed making use of one of the installer projects in OPNFV:
17 Airship or Fuel. Each installer provides the ability to install a common OPNFV
18 platform as well as integrating additional features delivered through a variety of scenarios by
19 the OPNFV community.
20
21
22 Introduction
23 ============
24
25 The OPNFV platform is comprised of a variety of upstream components that may be deployed on your
26 infrastructure. A composition of components, tools and configurations is identified in OPNFV as a
27 deployment scenario.
28
29 The various OPNFV scenarios provide unique features and capabilities that you may want to leverage, and
30 it is important to understand your required target platform capabilities before installing and
31 configuring your scenarios.
32
33 An OPNFV installation requires either a physical infrastructure environment as defined
34 in the `Pharos specification <https://wiki.opnfv.org/display/pharos/Pharos+Specification>`_, or a virtual one.
35 When configuring a physical infrastructure it is strongly advised to follow the Pharos configuration guidelines.
36
37
38 Scenarios
39 =========
40
41 OPNFV scenarios are designed to host virtualised network functions (VNF’s) in a variety of deployment
42 architectures and locations. Each scenario provides specific capabilities and/or components aimed at
43 solving specific problems for the deployment of VNF’s.
44
45 A scenario may, for instance, include components such as OpenStack, OpenDaylight, OVS, KVM etc.,
46 where each scenario will include different source components or configurations.
47
48 To learn more about the scenarios supported in the Iruya release refer to the scenario
49 description documents provided:
50
51 - :ref:`os-nosdn-ovs-noha <os-nosdn-ovs-noha>`
52 - :ref:`os-nosdn-fdio-noha <os-nosdn-fdio-noha>`
53
54 Installation Procedure
55 ======================
56
57 Detailed step by step instructions for working with an installation toolchain and installing
58 the required scenario is provided by the installation projects. The projects providing installation
59 support for the OPNFV Iruya release are: Airship and Fuel.
60
61 The instructions for each toolchain can be found in these links:
62
63 - :ref:`Airship installation instruction <airship-installation>`
64 - :ref:`Fuel installation instruction <fuel-installation>`
65
66 OPNFV Test Frameworks
67 =====================
68
69 If you have elected to install the OPNFV platform using the deployment toolchain provided by OPNFV,
70 your system will have been validated once the installation is completed.
71 The basic deployment validation only addresses a small part of capabilities in
72 the platform and you may want to execute more exhaustive tests. Some investigation will be required to
73 select the right test suites to run on your platform.
74
75 Many of the OPNFV test project provide user-guide documentation and installation instructions in :ref:`this document <testing-userguide>`