docs/installation-instructions/introduction.rst

   1 Introduction
   2 ============
   3
   4 This document describes the steps to install an OPNFV Bramaputra 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 the RDO Manager Open Source project as a server provisioning tool.
  14 RDO Manager is the RDO Project implimentation of OpenStack's Triple-O project.
  15 The Triple-O image based life cycle installation tool provisions an OPNFV
  16 Target System (3 controllers, n number of compute nodes) with OPNFV specific
  17 configuration provided by the Apex 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-bramaputra.iso``) to both install CentOS 7 and the
  23 nessesary materials to deploy or the Apex RPM (``opnfv-apex.rpm``)
  24 which expects installation to a CentOS 7 libvirt enabled host. The RPM
  25 contains a collection of configuration file, prebuilt disk images,
  26 and the automatic deployment script (``opnfv-deploy``).
  27
  28 An OPNFV install requires a "Jumphost" in order to operate.  The bootable
  29 ISO will allow you to install a customized CentOS 7 release to the Jumphost,
  30 which includes the required packages needed to run ``opnfv-deploy``.
  31 If you already have a Jumphost with CentOS 7 installed, you may choose to
  32 skip the ISO step and simply install the (``opnfv-apex.rpm``) RPM. The RPM
  33 is the same RPM included in the ISO and includes all the necessary disk
  34 images and configuration files to execute an OPNFV deployment. Either method
  35 will prepare a host to the same ready state for OPNFV deployment.
  36
  37 ``opnfv-deploy`` instantiates an RDO Manager Undercloud VM server using libvirt
  38 as its provider.  This VM is then configured and used to provision the
  39 OPNFV target deployment (3 controllers, n compute nodes).  These nodes can
  40 be either virtual or bare metal. This guide contains instructions for
  41 installing either method.