summaryrefslogtreecommitdiffstats
path: root/docs/release/installation
diff options
context:
space:
mode:
authorTim Rozet <trozet@redhat.com>2018-11-09 11:17:28 -0500
committerTim Rozet <trozet@redhat.com>2018-11-09 11:24:55 -0500
commitb188263699077102e956929970cc20191dafd312 (patch)
tree9aed230ef12422d3ed834202a216e28199aae86c /docs/release/installation
parent1486696939e9b8d42f6f96bc5adb85849f675413 (diff)
Updates documentation for Gambia
Changes-Include: - Remove references to Apex ISO and disk image RPMs - Update supported scenarios - Update using upstream documentation Change-Id: If2b66d1d5a861bd1f90b0e8829de37d84e656619 Signed-off-by: Tim Rozet <trozet@redhat.com>
Diffstat (limited to 'docs/release/installation')
-rw-r--r--docs/release/installation/abstract.rst6
-rw-r--r--docs/release/installation/architecture.rst17
-rw-r--r--docs/release/installation/baremetal.rst42
-rw-r--r--docs/release/installation/index.rst2
-rw-r--r--docs/release/installation/introduction.rst20
-rw-r--r--docs/release/installation/references.rst2
-rw-r--r--docs/release/installation/requirements.rst4
-rw-r--r--docs/release/installation/upstream.rst40
8 files changed, 60 insertions, 73 deletions
diff --git a/docs/release/installation/abstract.rst b/docs/release/installation/abstract.rst
index aeef124..2d55c15 100644
--- a/docs/release/installation/abstract.rst
+++ b/docs/release/installation/abstract.rst
@@ -1,16 +1,16 @@
Abstract
========
-This document describes how to install the Fraser release of OPNFV when
+This document describes how to install the Gambia release of OPNFV when
using Apex as a deployment tool covering it's limitations, dependencies
and required system resources.
License
=======
-Fraser release of OPNFV when using Apex as a deployment tool Docs
+Gambia release of OPNFV when using Apex as a deployment tool Docs
(c) by Tim Rozet (Red Hat)
-Fraser release of OPNFV when using Apex as a deployment tool Docs
+Gambia release of OPNFV when using Apex as a deployment tool Docs
are licensed under a Creative Commons Attribution 4.0 International License.
You should have received a copy of the license along with this.
If not, see <http://creativecommons.org/licenses/by/4.0/>.
diff --git a/docs/release/installation/architecture.rst b/docs/release/installation/architecture.rst
index 1ab7c7f..0bf2d3b 100644
--- a/docs/release/installation/architecture.rst
+++ b/docs/release/installation/architecture.rst
@@ -16,8 +16,7 @@ deploy the overcloud.
The undercloud is the all-in-one installation of OpenStack that includes
baremetal provisioning capability. The undercloud will be deployed as a
-virtual machine on a Jump Host. This VM is pre-built and distributed as part
-of the Apex RPM.
+virtual machine on a Jump Host.
The overcloud is OPNFV. Configuration will be passed into undercloud and
the undercloud will use OpenStack's orchestration component, named Heat, to
@@ -127,11 +126,11 @@ issues per scenario. The following scenarios correspond to a supported
+-------------------------+-------------+---------------+
| os-nosdn-nofeature-noha | Apex | Yes |
+-------------------------+-------------+---------------+
-| os-nosdn-bar-ha | Barometer | Yes |
+| os-nosdn-bar-ha | Barometer | No |
+-------------------------+-------------+---------------+
-| os-nosdn-bar-noha | Barometer | Yes |
+| os-nosdn-bar-noha | Barometer | No |
+-------------------------+-------------+---------------+
-| os-nosdn-calipso-noha | Calipso | No |
+| os-nosdn-calipso-noha | Calipso | Yes |
+-------------------------+-------------+---------------+
| os-nosdn-ovs_dpdk-ha | Apex | No |
+-------------------------+-------------+---------------+
@@ -168,9 +167,9 @@ issues per scenario. The following scenarios correspond to a supported
+-------------------------+-------------+---------------+
| os-odl-l2gw-noha | Apex | No |
+-------------------------+-------------+---------------+
-| os-odl-sfc-ha | SFC | No |
+| os-odl-sfc-ha | SFC | Yes |
+-------------------------+-------------+---------------+
-| os-odl-sfc-noha | SFC | No |
+| os-odl-sfc-noha | SFC | Yes |
+-------------------------+-------------+---------------+
| os-odl-gluon-noha | Gluon | No |
+-------------------------+-------------+---------------+
@@ -188,5 +187,7 @@ issues per scenario. The following scenarios correspond to a supported
+-------------------------+-------------+---------------+
| os-onos-sfc-ha | ONOSFW | No |
+-------------------------+-------------+---------------+
-| os-ovn-nofeature-noha | Apex | Yes |
+| os-ovn-nofeature-noha | Apex | No |
++-------------------------+-------------+---------------+
+| os-ovn-nofeature-ha | Apex | Yes |
+-------------------------+-------------+---------------+
diff --git a/docs/release/installation/baremetal.rst b/docs/release/installation/baremetal.rst
index ff55bc1..2a2eefd 100644
--- a/docs/release/installation/baremetal.rst
+++ b/docs/release/installation/baremetal.rst
@@ -46,11 +46,17 @@ and report the properties of it back to the undercloud node.
After introspection the undercloud will execute a Heat Stack Deployment to
continue node provisioning and configuration. The nodes will reboot and PXE
from the undercloud PXE server again to provision each node using Glance disk
-images provided by the undercloud. These disk images include all the necessary
-packages and configuration for an OPNFV deployment to execute. Once the disk
+images provided by the undercloud. These disk images include all the necessary
+packages and configuration for an OPNFV deployment to execute. Once the disk
images have been written to node's disks the nodes will boot locally and
-execute cloud-init which will execute the final node configuration. This
-configuration is largely completed by executing a puppet apply on each node.
+execute cloud-init which will execute the final node configuration. At this
+point in the deployment, the Heat Stack will complete, and Mistral will
+takeover the configuration of the nodes. Mistral handles calling Ansible which
+will connect to each node, and begin configuration. This configuration includes
+launching the desired OPNFV services as containers, and generating their
+configuration files. These configuration is largely completed by executing a
+puppet apply on each container to generate the config files, which are then
+stored on the overcloud host and mounted into the service container at runtime.
Installation Guide - Bare Metal Deployment
==========================================
@@ -62,11 +68,7 @@ Install Bare Metal Jump Host
----------------------------
1a. If your Jump Host does not have CentOS 7 already on it, or you would like
- to do a fresh install, then download the Apex bootable ISO from the OPNFV
- artifacts site <http://artifacts.opnfv.org/apex.html>. There have been
- isolated reports of problems with the ISO having trouble completing
- installation successfully. In the unexpected event the ISO does not work
- please workaround this by downloading the CentOS 7 DVD and performing a
+ to do a fresh install, then download the CentOS 7 DVD and perform a
"Virtualization Host" install. If you perform a "Minimal Install" or
install type other than "Virtualization Host" simply run
``sudo yum -y groupinstall "Virtualization Host"``
@@ -84,11 +86,11 @@ Install Bare Metal Jump Host
Replace /dev/sdX with the device assigned to your usb drive. Then select
the USB device as the boot media on your Jump Host
-2a. When not using the OPNFV Apex ISO, install these repos:
+2a. Install these repos:
- ``sudo yum install https://repos.fedorapeople.org/repos/openstack/openstack-pike/rdo-release-pike-1.noarch.rpm``
+ ``sudo yum install https://repos.fedorapeople.org/repos/openstack/openstack-queens/rdo-release-queens-1.noarch.rpm``
``sudo yum install epel-release``
- ``sudo curl -o /etc/yum.repos.d/opnfv-apex.repo http://artifacts.opnfv.org/apex/fraser/opnfv-apex.repo``
+ ``sudo curl -o /etc/yum.repos.d/opnfv-apex.repo http://artifacts.opnfv.org/apex/queens/opnfv-apex.repo``
The RDO Project release repository is needed to install OpenVSwitch, which
is a dependency of opnfv-apex. If you do not have external connectivity to
@@ -97,14 +99,12 @@ Install Bare Metal Jump Host
opnfv-apex repo hosts all of the Apex dependencies which will automatically
be installed when installing RPMs, but will be pre-installed with the ISO.
-2b. If you chose not to use the Apex ISO, then you must download and install
- the Apex RPMs to the Jump Host. Download the first 3 Apex RPMs from the
- OPNFV downloads page, under the TripleO RPMs
- ``https://www.opnfv.org/software/downloads``.
+2b. Download the first Apex RPMs from the OPNFV downloads page, under the
+ TripleO RPMs ``https://www.opnfv.org/software/downloads``. The dependent
+ RPMs will be automatically installed from the opnfv-apex repo in the
+ previous step.
The following RPMs are available for installation:
- - opnfv-apex - OpenDaylight, OVN, and nosdn support
- - opnfv-apex-undercloud - (reqed) Undercloud Image
- python34-opnfv-apex - (reqed) OPNFV Apex Python package
- python34-markupsafe - (reqed) Dependency of python34-opnfv-apex **
- python34-jinja2 - (reqed) Dependency of python34-opnfv-apex **
@@ -123,9 +123,9 @@ Install Bare Metal Jump Host
automatically installed by installing python34-opnfv-apex when the
opnfv-apex.repo has been previously downloaded to ``/etc/yum.repos.d/``.
- Install the three required RPMs (replace <rpm> with the actual downloaded
+ Install the required RPM (replace <rpm> with the actual downloaded
artifact):
- ``yum -y install <opnfv-apex.rpm> <opnfv-apex-undercloud> <python34-opnfv-apex>``
+ ``yum -y install <python34-opnfv-apex>``
3. After the operating system and the opnfv-apex RPMs are installed, login to
your Jump Host as root.
@@ -151,7 +151,7 @@ IPMI configuration information gathered in section
2. The nodes dictionary contains a definition block for each baremetal host
that will be deployed. 0 or more compute nodes and 1 or 3 controller nodes
- are required. (The example file contains blocks for each of these already).
+ are required (the example file contains blocks for each of these already).
It is optional at this point to add more compute nodes into the node list.
By specifying 0 compute nodes in the inventory file, the deployment will
automatically deploy "all-in-one" nodes which means the compute will run
diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
index 82b9d25..ebb311f 100644
--- a/docs/release/installation/index.rst
+++ b/docs/release/installation/index.rst
@@ -23,7 +23,7 @@ Contents:
:Authors: Tim Rozet (trozet@redhat.com)
:Authors: Dan Radez (dradez@redhat.com)
-:Version: 6.0
+:Version: 7.0
Indices and tables
==================
diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst
index 76ed0ac..706e226 100644
--- a/docs/release/installation/introduction.rst
+++ b/docs/release/installation/introduction.rst
@@ -1,7 +1,7 @@
Introduction
============
-This document describes the steps to install an OPNFV Fraser reference
+This document describes the steps to install an OPNFV Gambia reference
platform using the Apex installer.
The audience is assumed to have a good background in networking
@@ -18,22 +18,14 @@ 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-fraser.iso``) to both install CentOS 7 and the
-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``).
+The Apex artifact is a python package capable of automating the installation of
+TripleO and other OPNFV components.
-An OPNFV install requires a "Jump Host" in order to operate. The bootable
-ISO will allow you to install a customized CentOS 7 release to the Jump Host,
+An OPNFV install requires a "Jump Host" in order to operate. It is required
+to install CentOS 7 release to the Jump Host for traditional deployment,
which includes the required packages needed to run ``opnfv-deploy``.
If you already have a Jump Host with CentOS 7 installed, you may choose to
-skip the ISO step and simply install the (``opnfv-apex*.rpm``) RPMs. The RPMs
-are the same RPMs included in the ISO and include 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.
+skip the ISO step and simply install the (``python34-opnfv-apex*.rpm``) RPM.
``opnfv-deploy`` instantiates a Triple-O Undercloud VM server using libvirt
as its provider. This VM is then configured and used to provision the
diff --git a/docs/release/installation/references.rst b/docs/release/installation/references.rst
index 935be03..b8b177d 100644
--- a/docs/release/installation/references.rst
+++ b/docs/release/installation/references.rst
@@ -21,7 +21,7 @@ OPNFV
OpenStack
---------
-`OpenStack Pike Release artifacts <http://www.openstack.org/software/pike>`_
+`OpenStack Queens Release artifacts <http://www.openstack.org/software/queens>`_
`OpenStack documentation <http://docs.openstack.org>`_
diff --git a/docs/release/installation/requirements.rst b/docs/release/installation/requirements.rst
index 9aefa21..239db19 100644
--- a/docs/release/installation/requirements.rst
+++ b/docs/release/installation/requirements.rst
@@ -6,7 +6,7 @@ Jump Host Requirements
The Jump Host requirements are outlined below:
-1. CentOS 7 (from ISO or self-installed).
+1. CentOS 7 (self-installed) or Fedora (with Snapshot deployment).
2. Root access.
@@ -15,7 +15,7 @@ The Jump Host requirements are outlined below:
4. minimum 1 networks and maximum 5 networks, multiple NIC and/or VLAN
combinations are supported. This is virtualized for a VM deployment.
-5. The Fraser Apex RPMs and their dependencies.
+5. The Gambia Apex RPM and its dependencies.
6. 16 GB of RAM for a bare metal deployment, 64 GB of RAM for a Virtual
Deployment.
diff --git a/docs/release/installation/upstream.rst b/docs/release/installation/upstream.rst
index b98b0c1..f18c4b1 100644
--- a/docs/release/installation/upstream.rst
+++ b/docs/release/installation/upstream.rst
@@ -1,14 +1,11 @@
-Deploying Directly from Upstream - (Beta)
-=========================================
+Deploying Directly from Upstream
+================================
-In addition to deploying with OPNFV tested artifacts included in the
-opnfv-apex-undercloud and opnfv-apex RPMs, it is now possible to deploy
+When installing the Undercloud and Overcloud, the disk images are now downloaded
directly from upstream artifacts. Essentially this deployment pulls the latest
RDO overcloud and undercloud artifacts at deploy time. This option is useful
-for being able to deploy newer versions of OpenStack that are not included
-with this release, and offers some significant advantages for some users.
-Please note this feature is currently in beta for the Fraser release and will
-be fully supported in the next OPNFV release.
+for being able to pull the latest Queens and other OPNFV components which have
+been promoted via a TripleO pipeline and deemed to be stable.
Upstream Deployment Key Features
--------------------------------
@@ -39,19 +36,15 @@ in order to download and prepare the cached artifacts.
Scenarios and Deploy Settings for Upstream Deployments
------------------------------------------------------
-Some deploy settings files are already provided which have been tested by the
-Apex team. These include (under /etc/opnfv-apex/):
-
- - os-nosdn-queens_upstream-noha.yaml
- - os-nosdn-master_upstream-noha.yaml
- - os-odl-queens_upstream-noha.yaml
- - os-odl-master_upstream-noha.yaml
-
-Each of these scenarios has been tested by Apex over the Fraser release, but
-none are guaranteed to work as upstream is a moving target and this feature is
-relatively new. Still it is the goal of the Apex team to provide support
-and move to an upstream based deployments in the future, so please file a bug
-when encountering any issues.
+The deploy settings and scenarios included with the Gambia release of Apex will
+be supported as deemed by the `OPNFV Scenarios in Apex`_ section of this guide.
+Each of these scenarios has been tested by Apex over the Gambia release, and
+using those deploy settings will control which upstream artifacts are pulled
+at deploy time. By specifying different versions of OpenStack, ODL, or other
+components in the deploy settings, different upstream artifacts may be downloaded
+and are not considered to be supported. For deploying newer versions of components
+it is advised to use the master branch of OPNFV Apex as part of our continuous
+integration effort to support those components.
Including Upstream Patches with Deployment
------------------------------------------------------
@@ -83,8 +76,7 @@ Running ``opnfv-deploy``
Deploying is similar to the typical method used for baremetal and virtual
deployments with the addition of a few new arguments to the ``opnfv-deploy``
-command. In order to use an upstream deployment, please use the ``--upstream``
-argument. Also, the artifacts for each upstream deployment are only
+command. The artifacts for each upstream deployment are only
downloaded when a newer version is detected upstream. In order to explicitly
disable downloading new artifacts from upstream if previous artifacts are
already cached, please use the ``--no-fetch`` argument.
@@ -105,3 +97,5 @@ container with a bash shell. Note the containers do not use systemd, unlike
the traditional deployment model and are instead started as the first process
in the container. To restart a service, use the ``docker restart <container>``
command.
+
+.. _`OPNFV Scenarios in Apex`: architecture.html#opnfv-scenarios-in-apex