summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorYifei Xue <xueyifei@huawei.com>2018-03-19 10:54:01 +0800
committerYifei Xue <xueyifei@huawei.com>2018-03-27 09:35:49 +0800
commit5dc83b5989cc4af52bfbf2b9444ba9f28898919c (patch)
tree8f7c97d131f34f8067be0072695a054fc40d2016 /docs
parent9c5ae544e3f1adbc5bb0df1fc7388012bdf642fa (diff)
Documentation Update for Fraser release
JIRA: - Update the document for the latest Fraser release. Change-Id: Ifec8630ba7a87e2245ae6294b1f39b09ee2a8b6f Signed-off-by: Yifei Xue <xueyifei@huawei.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/release/installation/featureTable.rst82
-rw-r--r--docs/release/installation/installation.rst12
-rw-r--r--docs/release/installation/introduction.rst2
-rw-r--r--docs/release/installation/k8s-deploy.rst2
-rw-r--r--docs/release/installation/preconditions.rst10
-rw-r--r--docs/release/installation/vmdeploy.rst6
-rw-r--r--docs/release/release-notes/release-notes.rst42
-rw-r--r--docs/release/scenarios/k8s-nosdn-nofeature-ha.rst6
-rw-r--r--docs/release/scenarios/os-nosdn-nofeature-ha.rst10
-rw-r--r--docs/release/scenarios/os-odl-nofeature-ha.rst10
-rw-r--r--docs/release/scenarios/os-odl-sfc-ha.rst10
11 files changed, 90 insertions, 102 deletions
diff --git a/docs/release/installation/featureTable.rst b/docs/release/installation/featureTable.rst
index 2cd74a2b..1239aa4d 100644
--- a/docs/release/installation/featureTable.rst
+++ b/docs/release/installation/featureTable.rst
@@ -4,51 +4,51 @@ Features
Supported Openstack Version and OS
----------------------------------
-+---------------+----------+-----------+-----------+-----------+-----------+
-| | OS | OpenStack | OpenStack | OpenStack | OpenStack |
-| | only | Liberty | Mitaka | Newton | Ocata |
-+---------------+----------+-----------+-----------+-----------+-----------+
-| CentOS 7 | yes | yes | yes | yes | no |
-+---------------+----------+-----------+-----------+-----------+-----------+
-| Ubuntu trusty | yes | yes | yes | no | no |
-+---------------+----------+-----------+-----------+-----------+-----------+
-| Ubuntu xenial | yes | no | yes | yes | yes |
-+---------------+----------+-----------+-----------+-----------+-----------+
++---------------+----------+-----------+-----------+-----------+-----------+-----------+
+| | OS | OpenStack | OpenStack | OpenStack | OpenStack | OpenStack |
+| | only | Liberty | Mitaka | Newton | Ocata | Pike |
++---------------+----------+-----------+-----------+-----------+-----------+-----------+
+| CentOS 7 | yes | yes | yes | yes | no | yes |
++---------------+----------+-----------+-----------+-----------+-----------+-----------+
+| Ubuntu trusty | yes | yes | yes | no | no | no |
++---------------+----------+-----------+-----------+-----------+-----------+-----------+
+| Ubuntu xenial | yes | no | yes | yes | yes | yes |
++---------------+----------+-----------+-----------+-----------+-----------+-----------+
Supported Openstack Flavor and Features
---------------------------------------
-+---------------+--------------+--------------+---------------+---------------+
-| | OpenStack | OpenStack | OpenStack | OpenStack |
-| | Liberty | Mitaka | Newton | Ocata |
-+---------------+--------------+--------------+---------------+---------------+
-| Virtual | Yes | Yes | Yes | Yes |
-| Deployment | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| Baremetal | Yes | Yes | Yes | Yes |
-| Deployment | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| HA | Yes | Yes | Yes | Yes |
-| | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| Ceph | Yes | Yes | Yes | Yes |
-| | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| SDN | Yes | Yes | Yes | Yes* |
-| ODL/ONOS | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| Compute Node | Yes | Yes | Yes | No |
-| Expansion | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| Multi-Nic | Yes | Yes | Yes | Yes |
-| Support | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| Boot | Yes | Yes | Yes | Yes |
-| Recovery | | | | |
-+---------------+--------------+--------------+---------------+---------------+
-| SFC | No | No | Yes | Yes |
-| | | | | |
-+---------------+--------------+--------------+---------------+---------------+
++---------------+--------------+--------------+---------------+---------------+---------------+
+| | OpenStack | OpenStack | OpenStack | OpenStack | OpenStack |
+| | Liberty | Mitaka | Newton | Ocata | Pike |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| Virtual | Yes | Yes | Yes | Yes | Yes |
+| Deployment | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| Baremetal | Yes | Yes | Yes | Yes | Yes |
+| Deployment | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| HA | Yes | Yes | Yes | Yes | Yes |
+| | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| Ceph | Yes | Yes | Yes | Yes | Yes |
+| | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| SDN | Yes | Yes | Yes | Yes* | Yes* |
+| ODL/ONOS | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| Compute Node | Yes | Yes | Yes | No | No |
+| Expansion | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| Multi-Nic | Yes | Yes | Yes | Yes | Yes |
+| Support | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| Boot | Yes | Yes | Yes | Yes | Yes |
+| Recovery | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
+| SFC | No | No | Yes | Yes | Yes |
+| | | | | | |
++---------------+--------------+--------------+---------------+---------------+---------------+
* ONOS will not be supported in this release.
diff --git a/docs/release/installation/installation.rst b/docs/release/installation/installation.rst
index 05c5e2ef..2fb51641 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 Euphrates release of OPNFV when using Compass4nfv as a
+configure the Fraser 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 Euphrates release of OPNFV,
+Before starting the installation of the Fraser 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/Euphrates" to locate the ISO image.
+NOTE: Search the keyword "compass4nfv/Fraser" to locate the ISO image.
E.g.
-compass4nfv/Euphrates/opnfv-2017-09-18_08-15-13.tar.gz
+compass4nfv/Fraser/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 /Euphrates release, you can use the following command:
+To get stable /Fraser release, you can use the following command:
-- git checkout Euphrates.1.0
+- git checkout Fraser.1.0
Setup Requirements
------------------
diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst
index 6ffc3d17..5f0b0b28 100644
--- a/docs/release/installation/introduction.rst
+++ b/docs/release/installation/introduction.rst
@@ -5,7 +5,7 @@
Abstract
========
-This document describes how to install the Euphrates release of OPNFV when
+This document describes how to install the Fraser 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 49025ee3..0c1ffbd0 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/euphrates/quickstart_k8s.sh | bash
+ curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/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 3ba42ab6..9264c793 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 Euphrates release of OPNFV,
+Before starting the installation of the Fraser 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/Euphrates" to locate the tarball.
+NOTE: Search the keyword "compass4nfv/Fraser" to locate the tarball.
E.g.
-compass4nfv/euphrates/opnfv-2017-03-29_08-55-09.tar.gz
+compass4nfv/fraser/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/euphrates release, you can use the following command:
+To get stable/fraser release, you can use the following command:
-- git checkout Euphrates.1.0
+- git checkout Fraser.1.0
Setup Requirements
------------------
diff --git a/docs/release/installation/vmdeploy.rst b/docs/release/installation/vmdeploy.rst
index 5db934be..63c3cc5e 100644
--- a/docs/release/installation/vmdeploy.rst
+++ b/docs/release/installation/vmdeploy.rst
@@ -12,7 +12,7 @@ Only 1 command to try virtual deployment, if you have Internet access. Just Past
.. code-block:: bash
- curl https://raw.githubusercontent.com/opnfv/compass4nfv/euphrates/quickstart.sh | bash
+ curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart.sh | bash
If you want to deploy noha with1 controller and 1 compute, run the following command
@@ -20,7 +20,7 @@ If you want to deploy noha with1 controller and 1 compute, run the following com
export SCENARIO=os-nosdn-nofeature-noha.yml
export VIRT_NUMBER=2
- curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/euphrates/quickstart.sh | bash
+ curl https://raw.githubusercontent.com/opnfv/compass4nfv/stable/fraser/quickstart.sh | bash
Nodes Configuration (Virtual Deployment)
----------------------------------------
@@ -146,7 +146,7 @@ Start Deployment (Virtual Deployment)
1. Edit deploy.sh
1.1. Set OS version for deployment nodes.
- Compass4nfv supports ubuntu and centos based openstack ocata.
+ Compass4nfv supports ubuntu and centos based openstack pike.
E.g.
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 73825062..b6096568 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 Euphrates release of OPNFV when using Compass4nfv as a deployment tool.
+Release Note for the Fraser release of OPNFV when using Compass4nfv as a deployment tool.
Abstract
========
@@ -25,16 +25,16 @@ Release Data
| **Project** | Compass4nfv |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | Compass4nfv/Euphrates.1.0 |
+| **Repo/tag** | Compass4nfv/Fraser.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | Euphrates.1.0 |
+| **Release designation** | Fraser.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | October 2017 |
+| **Release date** | March 2018 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | OPNFV Euphrates release |
+| **Purpose of the delivery** | OPNFV Fraser release |
| | |
+--------------------------------------+--------------------------------------+
@@ -44,16 +44,16 @@ Deliverables
Software deliverables
~~~~~~~~~~~~~~~~~~~~~
- - Compass4nfv/Euphrates.1.0 tarball, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_
+ - Compass4nfv/Fraser.1.0 tarball, please get it from `OPNFV software download page <https://www.opnfv.org/software/>`_
.. _document-label:
Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
- - OPNFV(Euphrates) Compass4nfv installation instructions
+ - OPNFV(Fraser) Compass4nfv installation instructions
- - OPNFV(Euphrates) Compass4nfv Release Notes
+ - OPNFV(Fraser) Compass4nfv Release Notes
Version change
--------------
@@ -62,16 +62,16 @@ Version change
Module version change
~~~~~~~~~~~~~~~~~~~~~
-This is the Euphrates release of compass4nfv as a deployment toolchain in OPNFV, the following
+This is the Fraser release of compass4nfv as a deployment toolchain in OPNFV, the following
upstream components supported with this release.
- - Ubuntu 16.04/Centos 7.3
+ - Ubuntu 16.04.3/Centos 7.4
- - Openstack (Ocata release)
+ - Openstack (Pike release)
- - Kubernates (1.7.3)
+ - Kubernates (1.9)
- - Opendaylight (Nitrogen release)
+ - Opendaylight (Nitrogen SR1 release)
Reason for new version
@@ -135,27 +135,15 @@ System Limitations
Scenario Limitations
--------------------
-**ODL SFC:** In the Euphrates1.0, Compass doesn't integrate OpenStack Tacker
-Project yet. However, the SFC related test cases in Functest always use Tacker
-as NFVO to delivery VNFFG or SFC related requests to ODL via networking-sfc.
-So the odl-sfc scenario of Compass cannot pass the SFC testcases in Functest.
-But if you want to use verify SFC in the cluster deployed by Compass, you can
-use neutron CLI to achieve the same effect.
Known issues
------------
-+-----------------------+---------------------------------+-----------------------+
-| **Scenario** | **Issue** | **Workarounds** |
-+-----------------------+---------------------------------+-----------------------+
-| Ceph Related Scenario | After a power failure or reboot,| Deploy without Ceph |
-| | the cluster cannot heal itself | |
-+-----------------------+---------------------------------+-----------------------+
Test Result
===========
-The Euphrates release with the Compass4nfv deployment toolchain has undergone QA test
+The Fraser release with the Compass4nfv deployment toolchain has undergone QA test
runs with the following results:
-Functest: http://testresults.opnfv.org/reporting/euphrates/functest/status-compass.html
+Functest: http://testresults.opnfv.org/reporting/fraser/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 d9925cb7..e52889fa 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 Euphrates 1.0 of
+This document introduces scenario descriptions for Fraser 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 Euphrates release, please visit
-http://www.opnfv.org/euphrates
+For more information on the OPNFV Fraser release, please visit
+http://www.opnfv.org/fraser
diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha.rst b/docs/release/scenarios/os-nosdn-nofeature-ha.rst
index 6ff3b85c..5fc3e6d4 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 Euphrates 1.0 of
+This document introduces scenario descriptions for Fraser 1.0 of
deployment with no SDN controller and no feature enabled.
.. contents::
@@ -13,8 +13,8 @@ deployment with no SDN controller and no feature enabled.
os-nosdn-nofeature-ha
=====================
-This scenario is used to deploy an Ocata OpenStack deployment with
-Ceph Jewel, and without SDN controller nor any NFV feature enabled.
+This scenario is used to deploy a Pike OpenStack deployment with
+Ceph Luminous, and without SDN controller nor any NFV feature enabled.
Scenario components and composition
===================================
@@ -37,5 +37,5 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Euphrates release, please visit
-http://www.opnfv.org/euphrates
+For more information on the OPNFV Fraser release, please visit
+http://www.opnfv.org/fraser
diff --git a/docs/release/scenarios/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha.rst
index 64e74e04..df6cfa6a 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 Euphrates 1.0 of
+This document introduces scenario descriptions for Fraser 1.0 of
deployment with the OpenDaylight controller and no feature enabled.
.. contents::
@@ -13,8 +13,8 @@ deployment with the OpenDaylight controller and no feature enabled.
os-odl-nofeature-ha
===================
-This scenario is used to deploy an Ocata OpenStack deployment with
-OpenDaylight Nitrogen, Ceph Jewel, and without any NFV feature enabled.
+This scenario is used to deploy a Pike OpenStack deployment with
+OpenDaylight Nitrogen SR1, Ceph Luminous, and without any NFV feature enabled.
Scenario components and composition
===================================
@@ -39,5 +39,5 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Euphrates release, please visit
-http://www.opnfv.org/euphrates
+For more information on the OPNFV Fraser release, please visit
+http://www.opnfv.org/fraser
diff --git a/docs/release/scenarios/os-odl-sfc-ha.rst b/docs/release/scenarios/os-odl-sfc-ha.rst
index 7dca2417..3be817a2 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 Euphrates 1.0 of
+This document introduces scenario descriptions for Fraser 1.0 of
deployment with the OpenDaylight controller and SFC feature enabled.
.. contents::
@@ -13,8 +13,8 @@ deployment with the OpenDaylight controller and SFC feature enabled.
os-odl-sfc-ha
=============
-This scenario is used to deploy an Ocata OpenStack deployment with
-OpenDaylight Nitrogen, Ceph Jewel, and SFC feature enabled.
+This scenario is used to deploy a Pike OpenStack deployment with
+OpenDaylight Nitrogen SR1, Ceph Luminous, and SFC feature enabled.
Scenario components and composition
===================================
@@ -41,5 +41,5 @@ Limitations, Issues and Workarounds
References
==========
-For more information on the OPNFV Euphrates release, please visit
-http://www.opnfv.org/euphrates
+For more information on the OPNFV Fraser release, please visit
+http://www.opnfv.org/fraser