summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-01-31 19:19:36 +0100
committerTim Rozet <trozet@redhat.com>2016-02-02 04:49:48 +0000
commit3b86e1b9fafeab1261b1caae3b2d08ad410822b7 (patch)
tree1ba48ba6a458e439c5c6eaa9e2499fb4554215c7
parentc33a1ff1526172fec7afe04470d102e9abf81c85 (diff)
Updating directory structure to add files to the central docs.
Moved the introduction and baremetal installation instructions to /configguide. The files baremetal and introduction will be pulled into the central config guide document for release. (A little local file name juggling was required to accommodate the toolchain.) Once merged this should be pulled into the configguide. Will work on a patch for that now. Change-Id: Ie270154d0c7ac418b693ac7cf6e1444a33023266 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> (cherry picked from commit 5cfe9f9299ab1bc39401b11f780c1eef8e425677)
-rw-r--r--docs/configguide/baremetalinstall.rst (renamed from docs/installation-instructions/baremetalinstall.rst)0
-rw-r--r--docs/configguide/introduction.rst41
-rw-r--r--docs/installation-instructions/baremetal.rst2
-rw-r--r--docs/installation-instructions/index.rst6
-rw-r--r--docs/installation-instructions/introduction.rst41
5 files changed, 46 insertions, 44 deletions
diff --git a/docs/installation-instructions/baremetalinstall.rst b/docs/configguide/baremetalinstall.rst
index 0881da68..0881da68 100644
--- a/docs/installation-instructions/baremetalinstall.rst
+++ b/docs/configguide/baremetalinstall.rst
diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst
new file mode 100644
index 00000000..af8e03b6
--- /dev/null
+++ b/docs/configguide/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.
diff --git a/docs/installation-instructions/baremetal.rst b/docs/installation-instructions/baremetal.rst
new file mode 100644
index 00000000..62cbfa2d
--- /dev/null
+++ b/docs/installation-instructions/baremetal.rst
@@ -0,0 +1,2 @@
+.. include:: ../configguide/baremetal.rst
+
diff --git a/docs/installation-instructions/index.rst b/docs/installation-instructions/index.rst
index 1e94bf6d..1c3f4fe1 100644
--- a/docs/installation-instructions/index.rst
+++ b/docs/installation-instructions/index.rst
@@ -9,10 +9,10 @@ Contents:
:maxdepth: 4
abstract.rst
- instroduction.rst
+ introduction.rst
architecture.rst
requirements.rst
- baremetalinstall.rst
+ baremetal.rst
virtualinstall.rst
verification.rst
references.rst
@@ -24,6 +24,4 @@ Contents:
Indices and tables
==================
-* :ref:`genindex`
-* :ref:`modindex`
* :ref:`search`
diff --git a/docs/installation-instructions/introduction.rst b/docs/installation-instructions/introduction.rst
index af8e03b6..883c148a 100644
--- a/docs/installation-instructions/introduction.rst
+++ b/docs/installation-instructions/introduction.rst
@@ -1,41 +1,2 @@
-Introduction
-============
+.. include:: ../configguide/introduction.rst
-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.