path: root/docs
diff options
authorDan Radez <>2016-06-09 19:59:58 -0400
committerDan Radez <>2016-06-09 20:02:12 -0400
commitee3c2493f1c11c26737af8fa0cfa91722269817e (patch)
tree7c7f0939cc7dd3f6116e3d95765dc28ccdb4fc96 /docs
parent3a0e2e2823c0d501a72708a89649bb14d90e25dd (diff)
Documentation updates
- now referencing opnfv-util - now referencing the python34 packages for installation Change-Id: Idf2973766aab01629734e6180f6c0bd248872475 Signed-off-by: Dan Radez <>
Diffstat (limited to 'docs')
5 files changed, 24 insertions, 11 deletions
diff --git a/docs/installation-instructions/baremetal.rst b/docs/installation-instructions/baremetal.rst
index e3257009..e60ec9dc 100644
--- a/docs/installation-instructions/baremetal.rst
+++ b/docs/installation-instructions/baremetal.rst
@@ -10,9 +10,10 @@ platform. All the networks involved in the OPNFV infrastructure as well as the
networks and the private tenant VLANs needs to be manually configured.
The Jumphost can be installed using the bootable ISO or by other means including the
-(``opnfv-apex*.rpm``) RPMs and virtualization capabilities. The Jumphost should then be
-configured with an IP gateway on its admin or public interface and configured with a
-working DNS server. The Jumphost should also have routable access to the lights out network.
+(``opnfv-apex*.rpm``) RPMs, their dependencies and virtualization capabilities. The
+Jumphost should then be configured with an IP gateway on its admin or public interface
+and configured with a working DNS server. The Jumphost should also have routable access
+to the lights out network.
``opnfv-deploy`` is then executed in order to deploy the Undercloud VM. ``opnfv-deploy`` uses
three configuration files in order to know how to install and provision the OPNFV target system.
@@ -102,13 +103,21 @@ Install Bare Metal Jumphost
- opnfv-apex-opendaylight-sfc - OpenDaylight SFC support **
- opnfv-apex-undercloud - (required) Undercloud Image
- opnfv-apex-common - (required) Supporting config files and scripts
+ - python34-markupsafe - (required) Dependency of opnfv-apex-common ***
+ - python3-jinja2 - (required) Dependency of opnfv-apex-common ***
** One or more of these RPMs is required
Only one of opnfv-apex, opnfv-apex-onos and opnfv-apex-opendaylight-sfc is required. It is
safe to leave the unneeded SDN controller's RPMs uninstalled if you do not intend to use them.
+ *** These RPMs are not yet distributed by CentOS or EPEL.
+ Apex has built these for distribution with Apex while CentOS and EPEL do not distribute them. Once
+ they are carried in an upstream channel Apex will no longer carry them and they will not need
+ special handling for installation.
To install these RPMs download them to the local disk on your CentOS 7 install and pass the
file names directly to yum:
+ ``sudo yum install python34-markupsafe-<version>.rpm python3-jinja2-<version>.rpm``
``sudo yum install opnfv-apex-<version>.rpm opnfv-apex-undercloud-<version>.rpm opnfv-apex-common-<version>.rpm``
diff --git a/docs/installation-instructions/index.rst b/docs/installation-instructions/index.rst
index 1c3f4fe1..0dd3d87b 100644
--- a/docs/installation-instructions/index.rst
+++ b/docs/installation-instructions/index.rst
@@ -19,7 +19,7 @@ Contents:
:Authors: Tim Rozet (
:Authors: Dan Radez (
-:Version: 1.0
+:Version: 3.0
Indices and tables
diff --git a/docs/installation-instructions/introduction.rst b/docs/installation-instructions/introduction.rst
index 3d5d1bc4..14fe04be 100644
--- a/docs/installation-instructions/introduction.rst
+++ b/docs/installation-instructions/introduction.rst
@@ -20,10 +20,11 @@ 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-colorado.iso``) to both install CentOS 7 and the
-necessary materials to deploy or the Apex RPMs (``opnfv-apex*.rpm``)
-which expects installation to a CentOS 7 libvirt enabled host. The RPM
-contains a collection of configuration files, prebuilt disk images,
-and the automatic deployment script (``opnfv-deploy``).
+necessary materials to deploy or the Apex RPMs (``opnfv-apex*.rpm``),
+and their associated dependencies, which expects installation to a
+CentOS 7 libvirt enabled host. The RPM contains a collection of
+configuration files, 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,
diff --git a/docs/installation-instructions/requirements.rst b/docs/installation-instructions/requirements.rst
index ff9dc2ad..af03aac8 100644
--- a/docs/installation-instructions/requirements.rst
+++ b/docs/installation-instructions/requirements.rst
@@ -15,7 +15,7 @@ The Jumphost requirements are outlined below:
4. minimum 2 networks and maximum 6 networks, multiple NIC and/or VLAN combinations are supported.
This is virtualized for a VM deployment.
-5. The Colorado Apex RPMs.
+5. The Colorado Apex RPMs and their dependencies.
6. 16 GB of RAM for a bare metal deployment, 64 GB of RAM for a VM deployment.
diff --git a/docs/installation-instructions/verification.rst b/docs/installation-instructions/verification.rst
index 42dcb8c5..0ff56322 100644
--- a/docs/installation-instructions/verification.rst
+++ b/docs/installation-instructions/verification.rst
@@ -3,9 +3,12 @@ Verifying the Setup
Once the deployment has finished, the OPNFV deployment can be accessed via the Undercloud node. From
the jump host ssh to the Undercloud host and become the stack user. Alternativly ssh keys have been
-setup such that the root user on the jump host can ssh to Undercloud directly as the stack user.
+setup such that the root user on the jump host can ssh to Undercloud directly as the stack user. For
+convenience a utility script has been provided to look up the undercloud's ip address and ssh to the
+undercloud all in one command. An optional user name can be passed to indicate whether to connect as
+the stack or root user. The stack user is default if a username is not specified.
-| ``ssh root@``
+| ``opnfv-util undercloud root``
| ``su - stack``
Once connected to Undercloud as the stack user look for two keystone files that can be used to