From 49a76166350de5763448cbabc0bc4e3d96044966 Mon Sep 17 00:00:00 2001 From: Cristina Pauna Date: Mon, 6 May 2019 14:00:30 +0300 Subject: [docs] Update documentation for Hunter Updated the documentation for the Hunter release plus one minor change of wording in the deploy script as we no longer install just Openstack Change-Id: I853f5536b0f4a89a8c20af0a9650372690ef7c99 Signed-off-by: Cristina Pauna --- .../installation/installation.instruction.rst | 30 +++++------ docs/release/release-notes/release-notes.rst | 60 +++++++++++----------- .../os-nosdn-fdio-noha/os-nosdn-fdio-noha.rst | 4 +- .../scenarios/os-nosdn-onap-ha/os-nosdn-ovs-ha.rst | 4 +- .../os-nosdn-onap-noha/os-nosdn-ovs-noha.rst | 2 +- .../scenarios/os-nosdn-ovs-ha/os-nosdn-ovs-ha.rst | 4 +- .../os-nosdn-ovs-noha/os-nosdn-ovs-noha.rst | 4 +- .../scenarios/os-odl-ovs-noha/os-odl-ovs-noha.rst | 4 +- .../os-ovn-nofeature-ha/os-ovn-nofeature-ha.rst | 4 +- .../os-ovn-nofeature-noha.rst | 4 +- docs/release/userguide/userguide.rst | 2 +- 11 files changed, 61 insertions(+), 61 deletions(-) (limited to 'docs/release') diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst index 46a4350f5..ef343da56 100644 --- a/docs/release/installation/installation.instruction.rst +++ b/docs/release/installation/installation.instruction.rst @@ -9,7 +9,7 @@ OPNFV Fuel Installation Instruction Abstract ======== -This document describes how to install the ``Gambia`` release of +This document describes how to install the ``Hunter`` release of OPNFV when using Fuel as a deployment tool, covering its usage, limitations, dependencies and required system resources. @@ -21,20 +21,20 @@ Introduction ============ This document provides guidelines on how to install and -configure the ``Gambia`` release of OPNFV when using Fuel as a +configure the ``Hunter`` release of OPNFV when using Fuel as a deployment tool, including required software and hardware configurations. Although the available installation options provide a high degree of freedom in how the system is set up, including architecture, services and features, etc., said permutations may not provide an OPNFV compliant reference architecture. This document provides a -step-by-step guide that results in an OPNFV ``Gambia`` compliant +step-by-step guide that results in an OPNFV ``Hunter`` compliant deployment. The audience of this document is assumed to have good knowledge of networking and Unix/Linux administration. -Before starting the installation of the ``Gambia`` release of +Before starting the installation of the ``Hunter`` release of OPNFV, using Fuel as a deployment tool, some planning must be done. @@ -80,7 +80,7 @@ Hardware Requirements for ``virtual`` Deploys ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following minimum hardware requirements must be met for the ``virtual`` -installation of ``Gambia`` using Fuel: +installation of ``Hunter`` using Fuel: +------------------+------------------------------------------------------+ | **HW Aspect** | **Requirement** | @@ -101,7 +101,7 @@ Hardware Requirements for ``baremetal`` Deploys ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following minimum hardware requirements must be met for the ``baremetal`` -installation of ``Gambia`` using Fuel: +installation of ``Hunter`` using Fuel: +------------------+------------------------------------------------------+ | **HW Aspect** | **Requirement** | @@ -163,7 +163,7 @@ Hardware Requirements for ``hybrid`` (``baremetal`` + ``virtual``) Deploys ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ The following minimum hardware requirements must be met for the ``hybrid`` -installation of ``Gambia`` using Fuel: +installation of ``Hunter`` using Fuel: +------------------+------------------------------------------------------+ | **HW Aspect** | **Requirement** | @@ -255,7 +255,7 @@ three physically separated networks. infrastructure as well as the provider networks and the private tenant VLANs needs to be manually configured. -Manual configuration of the ``Gambia`` hardware platform should +Manual configuration of the ``Hunter`` hardware platform should be carried out according to the `OPNFV Pharos Specification`_. OPNFV Software Prerequisites @@ -864,7 +864,7 @@ Sample ``compute_params`` configuration block (for a single node): ``SDF`` ~~~~~~~ -Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Gambia`` +Scenario Descriptor Files are not yet implemented in the OPNFV Fuel ``Hunter`` release. Instead, embedded OPNFV Fuel scenarios files are locally available in @@ -881,7 +881,7 @@ Deployment Types .. WARNING:: - OPNFV releases previous to ``Gambia`` used to rely on the ``virtual`` + OPNFV releases previous to ``Hunter`` used to rely on the ``virtual`` keyword being part of the POD name (e.g. ``ericsson-virtual2``) to configure the deployment type as ``virtual``. Otherwise ``baremetal`` was implied. @@ -951,7 +951,7 @@ These steps are common for ``virtual``, ``baremetal`` or ``hybrid`` deploys, ``x86_64``, ``aarch64`` or ``mixed`` (``x86_64`` and ``aarch64``): - Clone the OPNFV Fuel code from gerrit -- Checkout the ``Gambia`` release tag +- Checkout the ``Hunter`` release tag - Start the deploy script .. NOTE:: @@ -971,7 +971,7 @@ These steps are common for ``virtual``, ``baremetal`` or ``hybrid`` deploys, jenkins@jumpserver:~$ git clone https://git.opnfv.org/fuel jenkins@jumpserver:~$ cd fuel - jenkins@jumpserver:~/fuel$ git checkout opnfv-7.2.0 + jenkins@jumpserver:~/fuel$ git checkout opnfv-8.0.0 jenkins@jumpserver:~/fuel$ ci/deploy.sh -l \ -p \ -b \ @@ -1377,12 +1377,12 @@ article. References ========== -For more information on the OPNFV ``Gambia`` 7.2 release, please see: +For more information on the OPNFV ``Hunter`` 8.0 release, please see: #. `OPNFV Home Page`_ #. `OPNFV Documentation`_ #. `OPNFV Software Downloads`_ -#. `OPNFV Gambia Wiki Page`_ +#. `OPNFV Hunter Wiki Page`_ #. `OpenStack Rocky Release Artifacts`_ #. `OpenStack Documentation`_ #. `OpenDaylight Artifacts`_ @@ -1401,7 +1401,7 @@ For more information on the OPNFV ``Gambia`` 7.2 release, please see: .. _`OpenStack Documentation`: https://docs.openstack.org/rocky .. _`OpenStack Rocky Release Artifacts`: https://www.openstack.org/software/rocky .. _`OPNFV Home Page`: https://www.opnfv.org -.. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia +.. _`OPNFV Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter .. _`OPNFV Documentation`: https://docs.opnfv.org .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0 diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index 49bc40c1d..b5a9de09a 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -9,10 +9,10 @@ OPNFV Fuel Release Notes Abstract ======== -This document provides the release notes for ``Gambia`` release with the Fuel +This document provides the release notes for ``Hunter`` release with the Fuel deployment toolchain. -Starting with this release, both ``x86_64`` and ``aarch64`` architectures +Starting with ``Gambia`` release, both ``x86_64`` and ``aarch64`` architectures are supported at the same time by the ``fuel`` codebase. License @@ -23,13 +23,13 @@ All Fuel and "common" entities are protected by the `Apache License 2.0`_. 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 Fuel. Fuel is based on the `MCP`_ installation tool chain. More information available at `Mirantis Cloud Platform Documentation`_. -The goal of the ``Gambia`` release and this Fuel-based deployment process is +The goal of the ``Hunter`` release and this Fuel-based deployment process is to establish a lab ready platform accelerating further development of the OPNFV infrastructure. @@ -38,7 +38,7 @@ Carefully follow the installation instructions. Summary ======= -``Gambia`` release with the Fuel deployment toolchain will establish an OPNFV +``Hunter`` release with the Fuel deployment toolchain will establish an OPNFV target system on a Pharos compliant lab infrastructure. The current definition of an OPNFV target system is OpenStack Queens combined with an SDN controller, such as OpenDaylight. The system is deployed with OpenStack High @@ -53,7 +53,7 @@ Furthermore, Fuel is capable of deploying scenarios in a ``baremetal``, ``virtual`` or ``hybrid`` fashion. ``virtual`` deployments use multiple VMs on the Jump Host and internal networking to simulate the ``baremetal`` deployment. -For ``Gambia``, the typical use of Fuel as an OpenStack installer is +For ``Hunter``, the typical use of Fuel as an OpenStack installer is supplemented with OPNFV unique components such as: - `OpenDaylight`_ @@ -62,14 +62,14 @@ supplemented with OPNFV unique components such as: As well as OPNFV-unique configurations of the Hardware and Software stack. -This ``Gambia`` artifact provides Fuel as the deployment stage tool in the +This ``Hunter`` artifact provides Fuel as the deployment stage tool in the OPNFV CI pipeline including: - Automated (Jenkins, RTD) documentation build & publish (multiple documents); - Automated (Jenkins) build & publish of Salt Master Docker image; -- Automated (Jenkins) deployment of ``Gambia`` running on baremetal or a nested +- Automated (Jenkins) deployment of ``Hunter`` running on baremetal or a nested hypervisor environment (KVM); -- Automated (Jenkins) validation of the ``Gambia`` deployment +- Automated (Jenkins) validation of the ``Hunter`` deployment Release Data ============ @@ -78,16 +78,16 @@ Release Data | **Project** | fuel | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | opnfv-7.2.0 | +| **Repo/tag** | opnfv-8.0.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Gambia 7.2 | +| **Release designation** | Hunter 8.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | January 25, 2019 | +| **Release date** | May 10, 2019 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Gambia 7.2 release | +| **Purpose of the delivery** | OPNFV Hunter 8.0 release | +--------------------------------------+--------------------------------------+ Version Change @@ -96,12 +96,12 @@ Version Change Module Version Changes ~~~~~~~~~~~~~~~~~~~~~~ -This is the first tracked version of the ``Gambia`` release with the Fuel +This is the first tracked version of the ``Hunter`` release with the Fuel deployment toolchain. It is based on following upstream versions: -- MCP (``Q2`18`` GA release) +- MCP (``Q1`19`` GA release) -- OpenStack (``Queens`` release) +- OpenStack (``Rocky`` release) - OpenDaylight (``Fluorine`` release) @@ -110,7 +110,7 @@ deployment toolchain. It is based on following upstream versions: Document Changes ~~~~~~~~~~~~~~~~ -This is the ``Gambia`` 7.2 release. +This is the ``Hunter`` 8.0 release. It comes with the following documentation: - :ref:`OPNFV Fuel Installation Instruction ` @@ -134,13 +134,13 @@ Feature Additions - ``ODL`` ``BGPVPN`` scenario; - ``IDF`` support for configuring cluster-level ``MTU``; -For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 New features`_ +For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 New features`_ filter. Bug Corrections ~~~~~~~~~~~~~~~ -For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 Bugs (fixed)`_ +For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 Bugs (fixed)`_ filter. Software Deliverables @@ -213,30 +213,30 @@ System Limitations Known Issues ------------ -For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 Known issues`_ +For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 Known issues`_ filter. Workarounds ----------- -For an exhaustive list, see the `OPNFV Fuel JIRA: Gambia 7.2 Workarounds`_ +For an exhaustive list, see the `OPNFV Fuel JIRA: Hunter 8.0 Workarounds`_ filter. Test Results ============ -The ``Gambia`` 7.2 release with the Fuel deployment tool has undergone QA test +The ``Hunter`` 8.0 release with the Fuel deployment tool has undergone QA test runs, see separate test results. References ========== -For more information on the OPNFV ``Gambia`` 7.2 release, please see: +For more information on the OPNFV ``Hunter`` 8.0 release, please see: #. `OPNFV Home Page`_ #. `OPNFV Documentation`_ #. `OPNFV Software Downloads`_ -#. `OPNFV Gambia Wiki Page`_ +#. `OPNFV Hunter Wiki Page`_ #. `OpenStack Queens Release Artifacts`_ #. `OpenStack Documentation`_ #. `OpenDaylight Artifacts`_ @@ -252,12 +252,12 @@ For more information on the OPNFV ``Gambia`` 7.2 release, please see: .. _`OpenStack Documentation`: https://docs.openstack.org/rocky .. _`OpenStack Rocky Release Artifacts`: https://www.openstack.org/software/rocky .. _`OPNFV Home Page`: https://www.opnfv.org -.. _`OPNFV Gambia Wiki Page`: https://wiki.opnfv.org/display/SWREL/Gambia +.. _`OPNFV Hunter Wiki Page`: https://wiki.opnfv.org/display/SWREL/Hunter .. _`OPNFV Documentation`: https://docs.opnfv.org .. _`OPNFV Software Downloads`: https://www.opnfv.org/software/downloads .. _`Apache License 2.0`: https://www.apache.org/licenses/LICENSE-2.0 -.. OPNFV Fuel Gambia JIRA filters -.. _`OPNFV Fuel JIRA: Gambia 7.2 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12604 -.. _`OPNFV Fuel JIRA: Gambia 7.2 New features`: https://jira.opnfv.org/issues/?filter=12605 -.. _`OPNFV Fuel JIRA: Gambia 7.2 Known issues`: https://jira.opnfv.org/issues/?filter=12606 -.. _`OPNFV Fuel JIRA: Gambia 7.2 Workarounds`: https://jira.opnfv.org/issues/?filter=12607 +.. OPNFV Fuel Hunter JIRA filters +.. _`OPNFV Fuel JIRA: Hunter 8.0 Bugs (fixed)`: https://jira.opnfv.org/issues/?filter=12705 +.. _`OPNFV Fuel JIRA: Hunter 8.0 New features`: https://jira.opnfv.org/issues/?filter=12706 +.. _`OPNFV Fuel JIRA: Hunter 8.0 Known issues`: https://jira.opnfv.org/issues/?filter=12707 +.. _`OPNFV Fuel JIRA: Hunter 8.0 Workarounds`: https://jira.opnfv.org/issues/?filter=12708 diff --git a/docs/release/scenarios/os-nosdn-fdio-noha/os-nosdn-fdio-noha.rst b/docs/release/scenarios/os-nosdn-fdio-noha/os-nosdn-fdio-noha.rst index 5e37b2331..df306d767 100644 --- a/docs/release/scenarios/os-nosdn-fdio-noha/os-nosdn-fdio-noha.rst +++ b/docs/release/scenarios/os-nosdn-fdio-noha/os-nosdn-fdio-noha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2018 Mirantis Inc., Enea Software AB and others -This document provides scenario level details for Gambia 7.2 of +This document provides scenario level details for Hunter 8.0 of deployment with no SDN controller and VPP enabled as virtual switch. Introduction @@ -35,5 +35,5 @@ Tested on virtual deploy only. References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software diff --git a/docs/release/scenarios/os-nosdn-onap-ha/os-nosdn-ovs-ha.rst b/docs/release/scenarios/os-nosdn-onap-ha/os-nosdn-ovs-ha.rst index 23b1adc40..2d2569369 100644 --- a/docs/release/scenarios/os-nosdn-onap-ha/os-nosdn-ovs-ha.rst +++ b/docs/release/scenarios/os-nosdn-onap-ha/os-nosdn-ovs-ha.rst @@ -42,7 +42,7 @@ None References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software For setup instructions visit the Auto Project at, -https://wiki.opnfv.org/display/AUTO/Auto+Documentation \ No newline at end of file +https://wiki.opnfv.org/display/AUTO/Auto+Documentation diff --git a/docs/release/scenarios/os-nosdn-onap-noha/os-nosdn-ovs-noha.rst b/docs/release/scenarios/os-nosdn-onap-noha/os-nosdn-ovs-noha.rst index 93c06749f..a6f46e4f5 100644 --- a/docs/release/scenarios/os-nosdn-onap-noha/os-nosdn-ovs-noha.rst +++ b/docs/release/scenarios/os-nosdn-onap-noha/os-nosdn-ovs-noha.rst @@ -39,7 +39,7 @@ Tested on virtual deployment only. References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software For setup instructions visit the Auto Project at, https://wiki.opnfv.org/display/AUTO/Auto+Documentation diff --git a/docs/release/scenarios/os-nosdn-ovs-ha/os-nosdn-ovs-ha.rst b/docs/release/scenarios/os-nosdn-ovs-ha/os-nosdn-ovs-ha.rst index 404198544..ce47a0b55 100644 --- a/docs/release/scenarios/os-nosdn-ovs-ha/os-nosdn-ovs-ha.rst +++ b/docs/release/scenarios/os-nosdn-ovs-ha/os-nosdn-ovs-ha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2018 Mirantis Inc., Enea Software AB and others -This document provides scenario level details for Gambia 7.2 of +This document provides scenario level details for Hunter 8.0 of deployment with no SDN controller and no extra features enabled. Introduction @@ -37,5 +37,5 @@ None References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software diff --git a/docs/release/scenarios/os-nosdn-ovs-noha/os-nosdn-ovs-noha.rst b/docs/release/scenarios/os-nosdn-ovs-noha/os-nosdn-ovs-noha.rst index d76b6c9af..7c8c7f140 100644 --- a/docs/release/scenarios/os-nosdn-ovs-noha/os-nosdn-ovs-noha.rst +++ b/docs/release/scenarios/os-nosdn-ovs-noha/os-nosdn-ovs-noha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2018 Mirantis Inc., Enea Software AB and others -This document provides scenario level details for Gambia 7.2 of +This document provides scenario level details for Hunter 8.0 of deployment with no SDN controller and no extra features enabled. Introduction @@ -35,5 +35,5 @@ Tested on virtual deploy only. References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software diff --git a/docs/release/scenarios/os-odl-ovs-noha/os-odl-ovs-noha.rst b/docs/release/scenarios/os-odl-ovs-noha/os-odl-ovs-noha.rst index 9c2c7d83b..f7ed398b7 100644 --- a/docs/release/scenarios/os-odl-ovs-noha/os-odl-ovs-noha.rst +++ b/docs/release/scenarios/os-odl-ovs-noha/os-odl-ovs-noha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2018 Mirantis Inc., Enea Software AB and others -This document provides scenario level details for Gambia 7.2 of +This document provides scenario level details for Hunter 8.0 of deployment with OpenDaylight controller and DPDK feature enabled. Introduction @@ -36,5 +36,5 @@ Tested on virtual deploy only. References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software 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 da0c60b65..fe16a527d 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) 2018 Mirantis Inc., Enea Software AB and others -This document provides scenario level details for Gambia 7.2 of deployment +This document provides scenario level details for Hunter 8.0 of deployment with Open Virtual Network (OVN) providing Layers 2 and 3 networking and no extra features enabled. @@ -36,5 +36,5 @@ None References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software diff --git a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst index 59c45c1e6..885406a78 100644 --- a/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst +++ b/docs/release/scenarios/os-ovn-nofeature-noha/os-ovn-nofeature-noha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) 2018 Mirantis Inc., Enea Software AB and others -This document provides scenario level details for Gambia 7.2 of deployment +This document provides scenario level details for Hunter 8.0 of deployment with Open Virtual Network (OVN) providing Layers 2 and 3 networking and no extra features enabled. @@ -35,5 +35,5 @@ Tested on virtual deploy only. References ========== -For more information on the OPNFV Gambia release, please visit +For more information on the OPNFV Hunter release, please visit https://www.opnfv.org/software diff --git a/docs/release/userguide/userguide.rst b/docs/release/userguide/userguide.rst index 50acf6feb..6b9b7617f 100644 --- a/docs/release/userguide/userguide.rst +++ b/docs/release/userguide/userguide.rst @@ -9,7 +9,7 @@ OPNFV Fuel User Guide Abstract ======== -This document contains details about using OPNFV Fuel ``Gambia`` release after +This document contains details about using OPNFV Fuel ``Hunter`` release after it was deployed. For details on how to deploy OpenStack, check the installation instructions in the :ref:`fuel_userguide_references` section. -- cgit 1.2.3-korg