Adding unittests for apex/deploy.py
[apex.git] / docs / release / installation / introduction.rst
1 Introduction
2 ============
3
4 This document describes the steps to install an OPNFV Euphrates reference
5 platform, as defined by the Genesis Project using the Apex installer.
6
7 The audience is assumed to have a good background in networking
8 and Linux administration.
9
10 Preface
11 =======
12
13 Apex uses Triple-O from the RDO Project OpenStack distribution as a
14 provisioning tool. The Triple-O image based life cycle installation
15 tool provisions an OPNFV Target System (3 controllers, 2 or more
16 compute nodes) with OPNFV specific configuration provided by the Apex
17 deployment tool chain.
18
19 The Apex deployment artifacts contain the necessary tools to deploy and
20 configure an OPNFV target system using the Apex deployment toolchain.
21 These artifacts offer the choice of using the Apex bootable ISO
22 (``opnfv-apex-euphrates.iso``) to both install CentOS 7 and the
23 necessary materials to deploy or the Apex RPMs (``opnfv-apex*.rpm``),
24 and their associated dependencies, which expects installation to a
25 CentOS 7 libvirt enabled host. The RPM contains a collection of
26 configuration files, prebuilt disk images, and the automatic deployment
27 script (``opnfv-deploy``).
28
29 An OPNFV install requires a "Jumphost" in order to operate.  The bootable
30 ISO will allow you to install a customized CentOS 7 release to the Jumphost,
31 which includes the required packages needed to run ``opnfv-deploy``.
32 If you already have a Jumphost with CentOS 7 installed, you may choose to
33 skip the ISO step and simply install the (``opnfv-apex*.rpm``) RPMs. The RPMs
34 are the same RPMs included in the ISO and include all the necessary disk
35 images and configuration files to execute an OPNFV deployment. Either method
36 will prepare a host to the same ready state for OPNFV deployment.
37
38 ``opnfv-deploy`` instantiates a Triple-O Undercloud VM server using libvirt
39 as its provider.  This VM is then configured and used to provision the
40 OPNFV target deployment (3 controllers, n compute nodes).  These nodes can
41 be either virtual or bare metal. This guide contains instructions for
42 installing either method.