summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorTim Rozet <trozet@redhat.com>2019-05-08 15:00:53 -0400
committerTim Rozet <trozet@redhat.com>2019-05-08 15:00:53 -0400
commit5a60fc71848a60ee51837b7dc7a49dda741876cd (patch)
tree9f90e41e6f831c86925ac1340d700721cf18abc9
parent237dc19886b4ae03c42f584999d1dff466b6c6da (diff)
Doc update for Hunteropnfv-8.0.0stable/hunter
Change-Id: I2b03f7a5f569b98b97ce5b1390ea72f127758264 Signed-off-by: Tim Rozet <trozet@redhat.com>
-rw-r--r--docs/release/installation/abstract.rst6
-rw-r--r--docs/release/installation/baremetal.rst2
-rw-r--r--docs/release/installation/introduction.rst2
-rw-r--r--docs/release/installation/requirements.rst2
-rw-r--r--docs/release/installation/upstream.rst4
-rw-r--r--docs/release/release-notes/release-notes.rst30
-rw-r--r--docs/release/scenarios/k8s-nosdn-nofeature-noha/index.rst15
-rw-r--r--docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst46
-rw-r--r--docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst6
-rw-r--r--docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst6
-rw-r--r--docs/release/scenarios/os-odl-nofeature-ha/index.rst15
-rw-r--r--docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst49
-rw-r--r--docs/release/scenarios/os-odl-nofeature-noha/index.rst15
-rw-r--r--docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst43
-rw-r--r--docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst6
15 files changed, 32 insertions, 215 deletions
diff --git a/docs/release/installation/abstract.rst b/docs/release/installation/abstract.rst
index 2d55c15..ab78691 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 Gambia release of OPNFV when
+This document describes how to install the Hunter release of OPNFV when
using Apex as a deployment tool covering it's limitations, dependencies
and required system resources.
License
=======
-Gambia release of OPNFV when using Apex as a deployment tool Docs
+Hunter release of OPNFV when using Apex as a deployment tool Docs
(c) by Tim Rozet (Red Hat)
-Gambia release of OPNFV when using Apex as a deployment tool Docs
+Hunter 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/baremetal.rst b/docs/release/installation/baremetal.rst
index efea0f8..03657f0 100644
--- a/docs/release/installation/baremetal.rst
+++ b/docs/release/installation/baremetal.rst
@@ -90,7 +90,7 @@ Install Bare Metal Jump Host
``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/gambia/opnfv-apex.repo``
+ ``sudo curl -o /etc/yum.repos.d/opnfv-apex.repo http://artifacts.opnfv.org/apex/hunter/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
diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst
index 706e226..a2e1377 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 Gambia reference
+This document describes the steps to install an OPNFV Hunter reference
platform using the Apex installer.
The audience is assumed to have a good background in networking
diff --git a/docs/release/installation/requirements.rst b/docs/release/installation/requirements.rst
index 239db19..3da3996 100644
--- a/docs/release/installation/requirements.rst
+++ b/docs/release/installation/requirements.rst
@@ -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 Gambia Apex RPM and its dependencies.
+5. The Hunter 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 f18c4b1..59aa57c 100644
--- a/docs/release/installation/upstream.rst
+++ b/docs/release/installation/upstream.rst
@@ -36,9 +36,9 @@ in order to download and prepare the cached artifacts.
Scenarios and Deploy Settings for Upstream Deployments
------------------------------------------------------
-The deploy settings and scenarios included with the Gambia release of Apex will
+The deploy settings and scenarios included with the Hunter 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
+Each of these scenarios has been tested by Apex over the Hunter 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
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 159165d..3a1e283 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -1,11 +1,11 @@
========================================================================
-OPNFV Release Notes for the Gambia release of OPNFV Apex deployment tool
+OPNFV Release Notes for the Hunter release of OPNFV Apex deployment tool
========================================================================
Abstract
========
-This document provides the release notes for Gambia release with the Apex
+This document provides the release notes for Hunter release with the Apex
deployment toolchain.
License
@@ -17,7 +17,7 @@ All Apex and "common" entities are protected by the Apache 2.0 License
Important Notes
===============
-This is the OPNFV Gambia release that implements the deploy stage of the
+This is the OPNFV Hunter release that implements the deploy stage of the
OPNFV CI pipeline via Apex.
Apex is based on RDO's Triple-O installation tool chain.
@@ -29,14 +29,14 @@ deploy OPNFV using Apex installer.
Summary
=======
-Gambia release with the Apex deployment toolchain will establish an OPNFV
+Hunter release with the Apex deployment toolchain will establish an OPNFV
target system on a Pharos compliant lab infrastructure. The current definition
of an OPNFV target system is OpenStack Pike combined with an SDN
controller, such as OpenDaylight. The system is deployed with OpenStack High
Availability (HA) for most OpenStack services. SDN controllers are deployed
on every controller unless deploying with one the HA FD.IO scenarios. Ceph
storage is used as Cinder backend, and is the only supported storage for
-Gambia. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
+Hunter. Ceph is setup as 3 OSDs and 3 Monitors, one OSD+Mon per Controller
node in an HA setup. Apex also supports non-HA deployments, which deploys a
single controller and n number of compute nodes. Furthermore, Apex is
capable of deploying scenarios in a bare metal or virtual fashion. Virtual
@@ -46,7 +46,7 @@ simulate the a bare metal deployment.
- Documentation is built by Jenkins
- .iso image is built by Jenkins
- .rpm packages are built by Jenkins
-- Jenkins deploys a Gambia release with the Apex deployment toolchain
+- Jenkins deploys a Hunter release with the Apex deployment toolchain
bare metal, which includes 3 control+network nodes, and 2 compute nodes.
Release Data
@@ -65,7 +65,7 @@ Release Data
| **Release date** | 2018-12-14 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Gambia release |
+| **Purpose of the delivery** | OPNFV Hunter release |
| | |
+--------------------------------------+--------------------------------------+
@@ -74,7 +74,7 @@ Version change
Module version changes
~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of the Gambia release with the Apex
+This is the first tracked version of the Hunter release with the Apex
deployment toolchain. It is based on following upstream versions:
- OpenStack (Queens release)
@@ -86,13 +86,13 @@ deployment toolchain. It is based on following upstream versions:
Document Version Changes
~~~~~~~~~~~~~~~~~~~~~~~~
-This is the first tracked version of Gambia release with the Apex
+This is the first tracked version of Hunter release with the Apex
deployment toolchain.
The following documentation is provided with this release:
-- OPNFV Installation instructions for the Gambia release with the Apex
+- OPNFV Installation instructions for the Hunter release with the Apex
deployment toolchain - ver. 1.0.0
-- OPNFV Release Notes for the Gambia release with the Apex deployment
+- OPNFV Release Notes for the Hunter release with the Apex deployment
toolchain - ver. 1.0.0 (this document)
Deliverables
@@ -108,9 +108,9 @@ Software Deliverables
Documentation Deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
-- OPNFV Installation instructions for the Gambia release with the Apex
+- OPNFV Installation instructions for the Hunter release with the Apex
deployment toolchain - ver. 7.1
-- OPNFV Release Notes for the Gambia release with the Apex deployment
+- OPNFV Release Notes for the Hunter release with the Apex deployment
toolchain - ver. 7.1 (this document)
Known Limitations, Issues and Workarounds
@@ -175,9 +175,9 @@ Apex installer.
References
==========
-For more information on the OPNFV Gambia release, please see:
+For more information on the OPNFV Hunter release, please see:
-http://wiki.opnfv.org/releases/Gambia
+http://wiki.opnfv.org/releases/Hunter
:Authors: Tim Rozet (trozet@redhat.com)
:Authors: Dan Radez (dradez@redhat.com)
diff --git a/docs/release/scenarios/k8s-nosdn-nofeature-noha/index.rst b/docs/release/scenarios/k8s-nosdn-nofeature-noha/index.rst
deleted file mode 100644
index 6efd74c..0000000
--- a/docs/release/scenarios/k8s-nosdn-nofeature-noha/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. _k8s-nosdn-nofeature-noha:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-=================================================
-k8s-nosdn-nofeature-noha overview and description
-=================================================
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- k8s-nosdn-nofeature-noha.rst
diff --git a/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst b/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst
deleted file mode 100644
index 7ff21b7..0000000
--- a/docs/release/scenarios/k8s-nosdn-nofeature-noha/k8s-nosdn-nofeature-noha.rst
+++ /dev/null
@@ -1,46 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-This document provides scenario level details for Gambia 1.1 of
-Kubernetes deployment with no SDN controller, no extra features
-and no High Availability enabled. Note this scenario is *not* supported
-for Gambia initial release and will be supported in a later service release
-of Gambia.
-
-============
-Introduction
-============
-
-This scenario is used primarily to validate and deploy a Kubernetes
-deployment without any NFV features or SDN controller enabled.
-
-Scenario components and composition
-===================================
-
-This scenario deploys a Kubernetes cluster on bare metal or virtual
-environment with a single master node. TripleO is used to bootstrap
-all the nodes and set up basic services like SSH. An undercloud VM
-used similarly to Openstack deployments, however no Openstack services
-(Nova, Neutron, Keystone, etc) will be deployed to the nodes. After
-TripleO successfully executes all the bootstrapping tasks, Kubespray
-is run (using ansible) to deploy Kubernetes cluster on the nodes.
-
-
-Scenario usage overview
-=======================
-
-Simply deploy this scenario by using the k8s-nosdn-nofeature-noha.yaml deploy
-settings file.
-
-Limitations, Issues and Workarounds
-===================================
-
-None
-
-References
-==========
-
-For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/gambia
-
diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst
index 5f2839c..647e003 100644
--- a/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst
+++ b/docs/release/scenarios/os-nosdn-nofeature-ha/os-nosdn-nofeature-ha.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Gambia 1.1 of
+This document provides scenario level details for Hunter 1.1 of
deployment with no SDN controller and no extra features enabled.
============
@@ -38,6 +38,6 @@ None
References
==========
-For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/gambia
+For more information on the OPNFV Hunter release, please visit
+http://www.opnfv.org/Hunter
diff --git a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst
index e5d4c98..d1a87cc 100644
--- a/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst
+++ b/docs/release/scenarios/os-nosdn-nofeature-noha/os-nosdn-nofeature-noha.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Gambia 1.1 of
+This document provides scenario level details for Hunter 1.1 of
deployment with no SDN controller and no extra features enabled.
============
@@ -35,6 +35,6 @@ None
References
==========
-For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/gambia
+For more information on the OPNFV Hunter release, please visit
+http://www.opnfv.org/Hunter
diff --git a/docs/release/scenarios/os-odl-nofeature-ha/index.rst b/docs/release/scenarios/os-odl-nofeature-ha/index.rst
deleted file mode 100644
index 4c6a443..0000000
--- a/docs/release/scenarios/os-odl-nofeature-ha/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. _os-odl-nofeature-ha:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-============================================
-os-odl-nofeature-ha overview and description
-============================================
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- os-odl-nofeature-ha.rst
diff --git a/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst
deleted file mode 100644
index 111ba6f..0000000
--- a/docs/release/scenarios/os-odl-nofeature-ha/os-odl-nofeature-ha.rst
+++ /dev/null
@@ -1,49 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-This document provides scenario level details for Gambia 1.1 of
-deployment with the OpenDaylight SDN controller and no extra features enabled.
-
-============
-Introduction
-============
-
-This scenario is used primarily to validate and deploy a Queens OpenStack
-deployment with OpenDaylight, and without any NFV features enabled.
-
-Scenario components and composition
-===================================
-
-This scenario is composed of common OpenStack services enabled by default,
-including Nova, Neutron, Glance, Cinder, Keystone, Horizon. Optionally and
-by default, Tacker and Congress services are also enabled. Ceph is used as
-the backend storage to Cinder on all deployed nodes.
-
-All services are in HA, meaning that there are multiple cloned instances of
-each service, and they are balanced by HA Proxy using a Virtual IP Address
-per service.
-
-OpenDaylight is also enabled in HA, and forms a cluster. Neutron
-communicates with a Virtual IP Address for OpenDaylight which is load
-balanced across the OpenDaylight cluster. Every Open vSwitch node is
-connected to every OpenDaylight for High Availability.
-
-Scenario usage overview
-=======================
-
-Simply deploy this scenario by using the os-odl-nofeature-ha.yaml deploy
-settings file.
-
-Limitations, Issues and Workarounds
-===================================
-
-* `APEX-268 <https://jira.opnfv.org/browse/APEX-268>`_:
- VMs with multiple floating IPs can only access via first NIC
-
-References
-==========
-
-For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/gambia
-
diff --git a/docs/release/scenarios/os-odl-nofeature-noha/index.rst b/docs/release/scenarios/os-odl-nofeature-noha/index.rst
deleted file mode 100644
index c3576b6..0000000
--- a/docs/release/scenarios/os-odl-nofeature-noha/index.rst
+++ /dev/null
@@ -1,15 +0,0 @@
-.. _os-odl-nofeature-noha:
-
-.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-==============================================
-os-odl-nofeature-noha overview and description
-==============================================
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- os-odl-nofeature-noha.rst
diff --git a/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst b/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst
deleted file mode 100644
index 3e26d67..0000000
--- a/docs/release/scenarios/os-odl-nofeature-noha/os-odl-nofeature-noha.rst
+++ /dev/null
@@ -1,43 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) <optionally add copywriters name>
-
-This document provides scenario level details for Gambia 1.1 of
-deployment with the OpenDaylight SDN controller and no extra features enabled.
-
-============
-Introduction
-============
-
-This scenario is used primarily to validate and deploy a Queens OpenStack
-deployment with OpenDaylight, and without any NFV features enabled.
-
-Scenario components and composition
-===================================
-
-This scenario is composed of common OpenStack services enabled by default,
-including Nova, Neutron, Glance, Cinder, Keystone, Horizon. Optionally and
-by default, Tacker and Congress services are also enabled. Ceph is used as
-the backend storage to Cinder on all deployed nodes.
-
-Only a single controller is deployed in this scenario, which also includes
-the OpenDaylight service on it.
-
-Scenario usage overview
-=======================
-
-Simply deploy this scenario by using the os-odl-nofeature-noha.yaml deploy
-settings file.
-
-Limitations, Issues and Workarounds
-===================================
-
-* `APEX-268 <https://jira.opnfv.org/browse/APEX-268>`_:
- VMs with multiple floating IPs can only access via first NIC
-
-References
-==========
-
-For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/gambia
-
diff --git a/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst b/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst
index 165b5f7..7b2eb45 100644
--- a/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst
+++ b/docs/release/scenarios/os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) <optionally add copywriters name>
-This document provides scenario level details for Gambia 1.1 of
+This document provides scenario level details for Hunter 1.1 of
deployment with the OVN SDN controller and no extra features enabled.
============
@@ -34,6 +34,6 @@ None
References
==========
-For more information on the OPNFV Gambia release, please visit
-http://www.opnfv.org/gambia
+For more information on the OPNFV Hunter release, please visit
+http://www.opnfv.org/Hunter