From aa75ba1b33e46523d43499358b3d2fb9e00ab523 Mon Sep 17 00:00:00 2001 From: Harry Huang Date: Wed, 31 Oct 2018 10:56:45 +0800 Subject: Update docs for Gambia JIRA: - Change-Id: I5c2c404f74b91c12cccd6b085e75415a6f38eb62 Signed-off-by: Harry Huang --- docs/release/installation/installation.rst | 12 ++++++------ docs/release/installation/introduction.rst | 4 +--- docs/release/installation/k8s-deploy.rst | 2 +- docs/release/installation/preconditions.rst | 10 +++++----- docs/release/installation/vmdeploy.rst | 4 ++-- docs/release/release-notes/release-notes.rst | 24 +++++++++++------------ docs/release/scenarios/k8s-nosdn-nofeature-ha.rst | 6 +++--- docs/release/scenarios/os-nosdn-nofeature-ha.rst | 6 +++--- docs/release/scenarios/os-odl-nofeature-ha.rst | 6 +++--- docs/release/scenarios/os-odl-sfc-ha.rst | 6 +++--- 10 files changed, 39 insertions(+), 41 deletions(-) diff --git a/docs/release/installation/installation.rst b/docs/release/installation/installation.rst index 2fb51641..9987c69c 100644 --- a/docs/release/installation/installation.rst +++ b/docs/release/installation/installation.rst @@ -6,7 +6,7 @@ Compass4nfv configuration ========================= This document describes providing guidelines on how to install and -configure the Fraser release of OPNFV when using Compass4nfv as a +configure the Gambia release of OPNFV when using Compass4nfv as a deployment tool including required software and hardware configurations. @@ -21,7 +21,7 @@ networking and Unix/Linux administration. Preconditions ------------- -Before starting the installation of the Fraser release of OPNFV, +Before starting the installation of the Gambia release of OPNFV, some planning must be done. @@ -37,10 +37,10 @@ The daily build tarball can be retrieved via OPNFV artifacts repository: http://artifacts.opnfv.org/compass4nfv.html -NOTE: Search the keyword "compass4nfv/Fraser" to locate the ISO image. +NOTE: Search the keyword "compass4nfv/Gambia" to locate the ISO image. E.g. -compass4nfv/Fraser/opnfv-2017-09-18_08-15-13.tar.gz +compass4nfv/Gambia/opnfv-2017-09-18_08-15-13.tar.gz The name of tarball includes the time of iso building, you can get the daily ISO according the building time. @@ -57,9 +57,9 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command: NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS). -To get stable /Fraser release, you can use the following command: +To get stable /Gambia release, you can use the following command: -- git checkout Fraser.1.0 +- git checkout Gambia.1.0 Setup Requirements ------------------ diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst index 5f0b0b28..226f68a3 100644 --- a/docs/release/installation/introduction.rst +++ b/docs/release/installation/introduction.rst @@ -5,8 +5,6 @@ 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 Compass4nfv as a deployment tool covering it's limitations, dependencies and required system resources. - - diff --git a/docs/release/installation/k8s-deploy.rst b/docs/release/installation/k8s-deploy.rst index 0c1ffbd0..50f3626d 100644 --- a/docs/release/installation/k8s-deploy.rst +++ b/docs/release/installation/k8s-deploy.rst @@ -20,7 +20,7 @@ If you want to deploy noha with1 controller and 1 compute, run the following com export SCENARIO=k8-nosdn-nofeature-noha.yml export VIRT_NUMBER=2 - curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart_k8s.sh | bash + curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/gambia/quickstart_k8s.sh | bash Installation of K8s on Bare Metal ================================= diff --git a/docs/release/installation/preconditions.rst b/docs/release/installation/preconditions.rst index 9264c793..78a63305 100644 --- a/docs/release/installation/preconditions.rst +++ b/docs/release/installation/preconditions.rst @@ -21,7 +21,7 @@ networking and Unix/Linux administration. Preconditions ------------- -Before starting the installation of the Fraser release of OPNFV, +Before starting the installation of the Gambia release of OPNFV, some planning must be done. @@ -38,10 +38,10 @@ The daily build tarball can be retrieved via OPNFV artifacts repository: http://artifacts.opnfv.org/compass4nfv.html -NOTE: Search the keyword "compass4nfv/Fraser" to locate the tarball. +NOTE: Search the keyword "compass4nfv/Gambia" to locate the tarball. E.g. -compass4nfv/fraser/opnfv-2017-03-29_08-55-09.tar.gz +compass4nfv/gambia/opnfv-2017-03-29_08-55-09.tar.gz The name of tarball includes the time of tarball building, you can get the daily tarball according the building time. @@ -58,9 +58,9 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command: NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS). -To get stable/fraser release, you can use the following command: +To get stable/gambia release, you can use the following command: -- git checkout Fraser.1.0 +- git checkout Gambia.1.0 Setup Requirements ------------------ diff --git a/docs/release/installation/vmdeploy.rst b/docs/release/installation/vmdeploy.rst index 4f1336c5..dfc8b663 100644 --- a/docs/release/installation/vmdeploy.rst +++ b/docs/release/installation/vmdeploy.rst @@ -12,14 +12,14 @@ Only 1 command to try virtual deployment, if you have Internet access. Just Past .. code-block:: bash - curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart.sh | bash + curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/gambia/quickstart.sh | bash If you want to deploy noha with1 controller and 1 compute, run the following command .. code-block:: bash export SCENARIO=os-nosdn-nofeature-noha.yml - curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart.sh | bash + curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/gambia/quickstart.sh | bash Nodes Configuration (Virtual Deployment) ---------------------------------------- diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst index b6096568..cbc3d1c9 100644 --- a/docs/release/release-notes/release-notes.rst +++ b/docs/release/release-notes/release-notes.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI) -Release Note for the Fraser release of OPNFV when using Compass4nfv as a deployment tool. +Release Note for the Gambia release of OPNFV when using Compass4nfv as a deployment tool. Abstract ======== @@ -25,16 +25,16 @@ Release Data | **Project** | Compass4nfv | | | | +--------------------------------------+--------------------------------------+ -| **Repo/tag** | Compass4nfv/Fraser.1.0 | +| **Repo/tag** | Compass4nfv/Gambia.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release designation** | Fraser.1.0 | +| **Release designation** | Gambia.1.0 | | | | +--------------------------------------+--------------------------------------+ -| **Release date** | March 2018 | +| **Release date** | November 2018 | | | | +--------------------------------------+--------------------------------------+ -| **Purpose of the delivery** | OPNFV Fraser release | +| **Purpose of the delivery** | OPNFV Gambia release | | | | +--------------------------------------+--------------------------------------+ @@ -44,16 +44,16 @@ Deliverables Software deliverables ~~~~~~~~~~~~~~~~~~~~~ - - Compass4nfv/Fraser.1.0 tarball, please get it from `OPNFV software download page `_ + - Compass4nfv/Gambia.1.0 tarball, please get it from `OPNFV software download page `_ .. _document-label: Documentation deliverables ~~~~~~~~~~~~~~~~~~~~~~~~~~ - - OPNFV(Fraser) Compass4nfv installation instructions + - OPNFV(Gambia) Compass4nfv installation instructions - - OPNFV(Fraser) Compass4nfv Release Notes + - OPNFV(Gambia) Compass4nfv Release Notes Version change -------------- @@ -62,12 +62,12 @@ Version change Module version change ~~~~~~~~~~~~~~~~~~~~~ -This is the Fraser release of compass4nfv as a deployment toolchain in OPNFV, the following +This is the Gambia release of compass4nfv as a deployment toolchain in OPNFV, the following upstream components supported with this release. - Ubuntu 16.04.3/Centos 7.4 - - Openstack (Pike release) + - Openstack (Queens release) - Kubernates (1.9) @@ -142,8 +142,8 @@ Known issues Test Result =========== -The Fraser release with the Compass4nfv deployment toolchain has undergone QA test +The Gambia release with the Compass4nfv deployment toolchain has undergone QA test runs with the following results: -Functest: http://testresults.opnfv.org/reporting/fraser/functest/status-compass.html +Functest: http://testresults.opnfv.org/reporting/gambia/functest/status-compass.html diff --git a/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst b/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst index e52889fa..ccc932a4 100644 --- a/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst +++ b/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Justin Chi (HUAWEI),Yifei Xue (HUAWEI)and Xinhui Hu (FIBERHOME) -This document introduces scenario descriptions for Fraser 1.0 of +This document introduces scenario descriptions for Gambia 1.0 of deployment with no SDN controller and no feature enabled. .. contents:: @@ -35,5 +35,5 @@ Limitations, Issues and Workarounds References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +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.rst b/docs/release/scenarios/os-nosdn-nofeature-ha.rst index 5fc3e6d4..2b835cac 100644 --- a/docs/release/scenarios/os-nosdn-nofeature-ha.rst +++ b/docs/release/scenarios/os-nosdn-nofeature-ha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Justin Chi (HUAWEI) and Yifei Xue (HUAWEI) -This document introduces scenario descriptions for Fraser 1.0 of +This document introduces scenario descriptions for Gambia 1.0 of deployment with no SDN controller and no feature enabled. .. contents:: @@ -37,5 +37,5 @@ Limitations, Issues and Workarounds References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha.rst index df6cfa6a..9fc90158 100644 --- a/docs/release/scenarios/os-odl-nofeature-ha.rst +++ b/docs/release/scenarios/os-odl-nofeature-ha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Justin Chi (HUAWEI) and Yifei Xue (HUAWEI) -This document introduces scenario descriptions for Fraser 1.0 of +This document introduces scenario descriptions for Gambia 1.0 of deployment with the OpenDaylight controller and no feature enabled. .. contents:: @@ -39,5 +39,5 @@ Limitations, Issues and Workarounds References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia diff --git a/docs/release/scenarios/os-odl-sfc-ha.rst b/docs/release/scenarios/os-odl-sfc-ha.rst index 3be817a2..bf155471 100644 --- a/docs/release/scenarios/os-odl-sfc-ha.rst +++ b/docs/release/scenarios/os-odl-sfc-ha.rst @@ -2,7 +2,7 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Justin Chi (HUAWEI) and Yifei Xue (HUAWEI) -This document introduces scenario descriptions for Fraser 1.0 of +This document introduces scenario descriptions for Gambia 1.0 of deployment with the OpenDaylight controller and SFC feature enabled. .. contents:: @@ -41,5 +41,5 @@ Limitations, Issues and Workarounds References ========== -For more information on the OPNFV Fraser release, please visit -http://www.opnfv.org/fraser +For more information on the OPNFV Gambia release, please visit +http://www.opnfv.org/gambia -- cgit 1.2.3-korg