summaryrefslogtreecommitdiffstats
path: root/docs/installation-instructions/introduction.rst
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-01-12 03:01:18 +0100
committerDan Radez <dradez@redhat.com>2016-01-20 10:16:14 -0500
commit129983418ead2f1352fa1998d4b74d19b40c484d (patch)
tree5320646711fc4ca032266c3bac003ae04df68e22 /docs/installation-instructions/introduction.rst
parent266eaa1148a529e829c322320d27842bad280157 (diff)
Restructured the installation-instruction file into indexed sub files
Take-two of this patch, originally merged: f479b77c4f7c0d11196e3902bb7e60ff8e34a1fe reverted: bffb8e0e27f21934a4bbb1138427f2adda6c583d Created a section based structure for the installation-instruction. It should show on the html artifact as a structured web page. We may want to move some sections to other directories to incorporate them into the release configguide. Left that for step 2... Now includes updates to the rpm spec so as not to break the build. Change-Id: I7c0d46467de668883fcd29ae7deaa20151bacdb2 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> Signed-off-by: Dan Radez <dradez@redhat.com>
Diffstat (limited to 'docs/installation-instructions/introduction.rst')
-rw-r--r--docs/installation-instructions/introduction.rst41
1 files changed, 41 insertions, 0 deletions
diff --git a/docs/installation-instructions/introduction.rst b/docs/installation-instructions/introduction.rst
new file mode 100644
index 00000000..af8e03b6
--- /dev/null
+++ b/docs/installation-instructions/introduction.rst
@@ -0,0 +1,41 @@
+Introduction
+============
+
+This document describes the steps to install an OPNFV Bramaputra reference
+platform, as defined by the Genesis Project using the Apex installer.
+
+The audience is assumed to have a good background in networking
+and Linux administration.
+
+Preface
+=======
+
+Apex uses the RDO Manager Open Source project as a server provisioning tool.
+RDO Manager is the RDO Project implimentation of OpenStack's Triple-O project.
+The Triple-O image based life cycle installation tool provisions an OPNFV
+Target System (3 controllers, n number of compute nodes) with OPNFV specific
+configuration provided by the Apex deployment tool chain.
+
+The Apex deployment artifacts contain the necessary tools to deploy and
+configure an OPNFV target system using the Apex deployment toolchain.
+These artifacts offer the choice of using the Apex bootable ISO
+(``opnfv-apex-bramaputra.iso``) to both install CentOS 7 and the
+nessesary materials to deploy or the Apex RPM (``opnfv-apex.rpm``)
+which expects installation to a CentOS 7 libvirt enabled host. The RPM
+contains a collection of configuration file, prebuilt disk images,
+and the automatic deployment script (``opnfv-deploy``).
+
+An OPNFV install requires a "Jumphost" in order to operate. The bootable
+ISO will allow you to install a customized CentOS 7 release to the Jumphost,
+which includes the required packages needed to run ``opnfv-deploy``.
+If you already have a Jumphost with CentOS 7 installed, you may choose to
+skip the ISO step and simply install the (``opnfv-apex.rpm``) RPM. The RPM
+is the same RPM included in the ISO and includes all the necessary disk
+images and configuration files to execute an OPNFV deployment. Either method
+will prepare a host to the same ready state for OPNFV deployment.
+
+``opnfv-deploy`` instantiates an RDO Manager Instack VM server using libvirt
+as its provider. This VM is then configured and used to provision the
+OPNFV target deployment (3 controllers, n compute nodes). These nodes can
+be either virtual or bare metal. This guide contains instructions for
+installing either method.