aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYifei Xue <xueyifei@huawei.com>2017-09-01 17:10:44 +0800
committerJustin chi <chigang@huawei.com>2017-09-18 06:23:16 +0000
commit0337ca28259e0afe67778c778c1cc8697cd93cec (patch)
tree7f683d6c7c653c138f83171f0e7bb0053be57cc2
parentb241c1a733e57556a524165c68c9b3cd0f8348b8 (diff)
Update the documents for compass E release
JIRA: - 1. Rewrite vm and bm deployment docs to satisfy the new release 2. add some images for network architecture 3. Update release name, version, etc. Change-Id: I1e9d305de5edf60d937868d49966c153d85fd2b5 Signed-off-by: Yifei Xue <xueyifei@huawei.com> (cherry picked from commit 074eab95235e35431b0439e42d253d44b139004e)
-rw-r--r--docs/development/overview/containerized_compass.rst25
-rw-r--r--docs/development/overview/images/compass_arch.pngbin0 -> 86066 bytes
-rw-r--r--docs/release/installation/bmdeploy.rst159
-rw-r--r--docs/release/installation/featureTable.rst81
-rw-r--r--docs/release/installation/images/multi_nics.pngbin0 -> 129573 bytes
-rw-r--r--docs/release/installation/images/single_nic.pngbin0 -> 129354 bytes
-rw-r--r--docs/release/installation/installation.rst35
-rw-r--r--docs/release/installation/introduction.rst5
-rw-r--r--docs/release/installation/offline-deploy.rst22
-rw-r--r--docs/release/installation/preconditions.rst24
-rw-r--r--docs/release/installation/vmdeploy.rst46
-rw-r--r--docs/release/release-notes/release-notes.rst46
-rw-r--r--docs/release/scenarios/index.rst3
-rw-r--r--docs/release/scenarios/k8s-nosdn-nofeature-ha.rst39
-rw-r--r--docs/release/scenarios/os-nosdn-nofeature-ha.rst41
-rw-r--r--docs/release/scenarios/os-odl-nofeature-ha.rst43
-rw-r--r--docs/release/scenarios/os-odl-sfc-ha.rst45
-rw-r--r--docs/release/userguide/FAQ/faq.rst44
18 files changed, 372 insertions, 286 deletions
diff --git a/docs/development/overview/containerized_compass.rst b/docs/development/overview/containerized_compass.rst
index de3ec90..1df570d 100644
--- a/docs/development/overview/containerized_compass.rst
+++ b/docs/development/overview/containerized_compass.rst
@@ -4,3 +4,28 @@
Introduction of Containerized Compass
=====================================
+
+Containerized Compass uses five compass containers instead of a single VM.
+
+Each container stands for a micro service and compass-core function separates into these five micro services:
+
+ - Compass-deck : RESTful API and DB Handlers for Compass
+ - Compass-tasks : Registered tasks and MQ modules for Compass
+ - Compass-cobbler : Cobbler container for Compass
+ - Compass-db : Database for Compass
+ - Compass-mq : Message Queue for Compass
+
+Compass4nfv has several containers to satisfy OPNFV requirements:
+
+ - Compass-tasks-osa : compass-task's adapter for deployment OpenStack via OpenStack-ansible
+ - Compass-tasks-k8s : compass-task's adapter for deployment Kubernetes
+ - Compass-repo-osa-ubuntu : optional container to support OPNFV offfline installation via OpenStack-ansible
+ - Compass-repo-osa-centos : optional container to support OPNFV offfline installation via OpenStack-ansible
+
+Picture below shows the new architecture of compass4nfv:
+
+.. figure:: images/compass_arch.png
+ :alt: New Archietecture of Compass4nfv
+ :figclass: align-center
+
+ Fig 1. New Archietecture of Compass4nfv
diff --git a/docs/development/overview/images/compass_arch.png b/docs/development/overview/images/compass_arch.png
new file mode 100644
index 0000000..5881064
--- /dev/null
+++ b/docs/development/overview/images/compass_arch.png
Binary files differ
diff --git a/docs/release/installation/bmdeploy.rst b/docs/release/installation/bmdeploy.rst
index 7bf4071..d584e93 100644
--- a/docs/release/installation/bmdeploy.rst
+++ b/docs/release/installation/bmdeploy.rst
@@ -199,7 +199,7 @@ IP Settings
- ip_ranges -- ip addresses range provided for this network.
- - cidr -- the IPv4 address and its associated routing prefix and subnet mask„
+ - cidr -- the IPv4 address and its associated routing prefix and subnet mask?
- gw -- need to add this line only if network is external.
@@ -226,11 +226,6 @@ Public VIP
- interface -- mostly external.
-ONOS NIC
-~~~~~~~~
-
- - the NIC for ONOS, if there is no ONOS configured, leave it unchanged.
-
Public Network
~~~~~~~~~~~~~~
@@ -316,127 +311,21 @@ Public Network
**The following figure shows the interfaces and nics of JumpHost and deployment nodes in
huawei-pod1 network configuration(default one nic for openstack networks).**
-.. code-block:: console
+.. figure:: images/single_nic.png
+ :alt: Single nic scenario
+ :figclass: align-center
+ Fig 1. Single nic scenario
- +--------------JumpHost-------------+
- | |
- | +-+Compass+-+ |
- | | + +--------+ | External-network
- | | eth2+---+br-ext +-+eth0+----------------------+
- | | + +--------+ | |
- | | | | |
- | | | | |
- | | + +--------+ | Install-network |
- | | eth1+---+install +-+eth1+-----------------+ |
- | | + +--------+ | | |
- | | | | | |
- | | | | | |
- | | + | IPMI-network | |
- | | eth0 eth2+-----------+ | |
- | | + | | | |
- | +---+VM+----+ | | | |
- +-----------------------------------+ | | |
- | | |
- | | |
- | | |
- | | |
- +---------------Host1---------------+ | | |
- | | | | |
- | eth0+----------------+ |
- | | | | |
- | mgmt +--------+ | | | |
- | | | | | |
- | +-----------+ | | | | |
- | external+----+ br-prv +----+eth1+---------------------+
- | +-----------+ | | | | |
- | | | | | |
- | storage +-----+ | | | |
- | | | | |
- +-----------------------------------+ | | |
- | IPMI+-----------+ | |
- +-----------------------------------+ | | |
- | | |
- | | |
- | | |
- +---------------Host2---------------+ | | |
- | | | | |
- | eth0+----------------+ |
- | | | |
- | mgmt +--------+ | | |
- | | | | |
- | +-----------+ | | | |
- | external+----+ br-prv +----+eth1+---------------------+
- | +-----------+ | | |
- | | | |
- | storage +-----+ | |
- | | |
- +-----------------------------------+ |
- | IPMI+-----------+
- +-----------------------------------+
**The following figure shows the interfaces and nics of JumpHost and deployment nodes in
intel-pod8 network configuration(openstack networks are seperated by multiple NICs).**
-.. code-block:: console
-
+.. figure:: images/multi_nics.png
+ :alt: Multiple nics scenario
+ :figclass: align-center
- +-------------+JumpHost+------------+
- | |
- | +-+Compass+-+ |
- | | + +--------+ | External-network
- | | eth2+---+br-ext +-+eth0+----------------------+
- | | + +--------+ | |
- | | | | |
- | | | | |
- | | + +--------+ | Install-network |
- | | eth1+---+install +-+eth1+-----------------+ |
- | | + +--------+ | | |
- | | | | | |
- | | | | | |
- | | + | IPMI-network | |
- | | eth0 eth2+-----------+ | |
- | | + | | | |
- | +---+VM+----+ | | | |
- +-----------------------------------+ | | |
- | | |
- | | |
- | | |
- | | |
- +--------------+Host1+--------------+ | | |
- | | | | |
- | eth0+----------------+ |
- | | | | |
- | +--------+ | | | |
- | external+----+br-prv +-+eth1+---------------------+
- | +--------+ | | | |
- | storage +---------------+eth2+-------------------------+
- | | | | | |
- | Mgmt +---------------+eth3+----------------------------+
- | | | | | | |
- | | | | | | |
- +-----------------------------------+ | | | | |
- | IPMI+-----------+ | | | |
- +-----------------------------------+ | | | | |
- | | | | |
- | | | | |
- | | | | |
- | | | | |
- +--------------+Host2+--------------+ | | | | |
- | | | | | | |
- | eth0+----------------+ | | |
- | | | | | |
- | +--------+ | | | | |
- | external+----+br-prv +-+eth1+---------------------+ | |
- | +--------+ | | | |
- | storage +---------------+eth2+-------------------------+ |
- | | | storage-network |
- | Mgmt +---------------+eth3+----------------------------+
- | | | mgmt-network
- | | |
- +-----------------------------------+ |
- | IPMI+-----------+
- +-----------------------------------+
+ Fig 2. Multiple nics scenario
Start Deployment (Bare Metal Deployment)
@@ -457,14 +346,14 @@ E.g.
or
export OS_VERSION=centos7
-1.2. Set ISO image corresponding to your code
+1.2. Set tarball corresponding to your code
E.g.
.. code-block:: bash
# Set ISO image corresponding to your code
- export ISO_URL=file:///home/compass/compass4nfv.iso
+ export ISO_URL=file:///home/compass/compass4nfv.tar.gz
1.3. Set hardware deploy jumpserver PXE NIC. (set eth1 E.g.)
You do not need to set it when virtual deploy.
@@ -491,16 +380,6 @@ nosdn-nofeature scenario deploy sample
# NETWORK is your network.yml's path
export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
-ocl-nofeature scenario deploy sample
-
-.. code-block:: bash
-
- # DHA is your dha.yml's path
- export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-ocl-nofeature-ha.yml
-
- # NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_ocl.yml
-
odl_l2-moon scenario deploy sample
.. code-block:: bash
@@ -531,25 +410,15 @@ odl_l3-nofeature scenario deploy sample
# NETWORK is your network.yml's path
export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
-onos-nofeature scenario deploy sample
-
-.. code-block:: bash
-
- # DHA is your dha.yml's path
- export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-nofeature-ha.yml
-
- # NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
-
-onos-sfc deploy scenario sample
+odl-sfc deploy scenario sample
.. code-block:: bash
# DHA is your dha.yml's path
- export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl-sfc-ha.yml
# NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
2. Run ``deploy.sh``
diff --git a/docs/release/installation/featureTable.rst b/docs/release/installation/featureTable.rst
index e5ad977..7d91d2a 100644
--- a/docs/release/installation/featureTable.rst
+++ b/docs/release/installation/featureTable.rst
@@ -4,48 +4,51 @@ Features
Supported Openstack Version and OS
----------------------------------
-+---------------+----------+-----------+-----------+-----------+
-| | OS | OpenStack | OpenStack | OpenStack |
-| | only | Liberty | Mitaka | Newton |
-+---------------+----------+-----------+-----------+-----------+
-| CentOS 7 | yes | yes | yes | yes |
-+---------------+----------+-----------+-----------+-----------+
-| Ubuntu trusty | yes | yes | yes | no |
-+---------------+----------+-----------+-----------+-----------+
-| Ubuntu xenial | yes | no | yes | yes |
-+---------------+----------+-----------+-----------+-----------+
++---------------+----------+-----------+-----------+-----------+-----------+
+| | 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 |
++---------------+----------+-----------+-----------+-----------+-----------+
Supported Openstack Flavor and Features
---------------------------------------
-+---------------+--------------+--------------+---------------+
-| | OpenStack | OpenStack | OpenStack |
-| | Liberty | Mitaka | Newton |
-+---------------+--------------+--------------+---------------+
-| Virtual | Yes | Yes | Yes |
-| Deployment | | | |
-+---------------+--------------+--------------+---------------+
-| Baremetal | Yes | Yes | Yes |
-| Deployment | | | |
-+---------------+--------------+--------------+---------------+
-| HA | Yes | Yes | Yes |
-| | | | |
-+---------------+--------------+--------------+---------------+
-| Ceph | Yes | Yes | Yes |
-| | | | |
-+---------------+--------------+--------------+---------------+
-| SDN | Yes | Yes | Yes* |
-| ODL/ONOS | | | |
-+---------------+--------------+--------------+---------------+
-| Compute Node | Yes | Yes | Yes |
-| Expansion | | | |
-+---------------+--------------+--------------+---------------+
-| Multi-Nic | Yes | Yes | Yes |
-| Support | | | |
-+---------------+--------------+--------------+---------------+
-| Boot | Yes | Yes | Yes |
-| Recovery | | | |
-+---------------+--------------+--------------+---------------+
++---------------+--------------+--------------+---------------+---------------+
+| | 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 |
+| | | | | |
++---------------+--------------+--------------+---------------+---------------+
-* ONOS support will Release in Danube 2.0 or 3.0
+* ONOS will not be supported in this release.
diff --git a/docs/release/installation/images/multi_nics.png b/docs/release/installation/images/multi_nics.png
new file mode 100644
index 0000000..5f48b6c
--- /dev/null
+++ b/docs/release/installation/images/multi_nics.png
Binary files differ
diff --git a/docs/release/installation/images/single_nic.png b/docs/release/installation/images/single_nic.png
new file mode 100644
index 0000000..c389856
--- /dev/null
+++ b/docs/release/installation/images/single_nic.png
Binary files differ
diff --git a/docs/release/installation/installation.rst b/docs/release/installation/installation.rst
index 18bac11..7c4f99a 100644
--- a/docs/release/installation/installation.rst
+++ b/docs/release/installation/installation.rst
@@ -21,29 +21,28 @@ networking and Unix/Linux administration.
Preconditions
-------------
-Before starting the installation of the Danube release of OPNFV,
+Before starting the installation of the Euphrates release of OPNFV,
some planning must be done.
-Retrieving the installation ISO image
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieving the installation Tarball
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-First of all, The installation ISO is needed for deploying your OPNFV
-environment, it included packages of Compass, OpenStack, OpenDaylight, ONOS
-and so on.
+First of all, The installation tarball is needed for deploying your OPNFV
+environment, it included packages of compass docker images and OSA repo.
-The stable release ISO can be retrieved via `OPNFV software download page <https://www.opnfv.org/software>`_
+The stable tarball can be retrieved via `OPNFV software download page <https://www.opnfv.org/software>`_
-The daily build ISO can be retrieved via OPNFV artifacts repository:
+The daily build tarball can be retrieved via OPNFV artifacts repository:
http://artifacts.opnfv.org/compass4nfv.html
-NOTE: Search the keyword "compass4nfv/Danube" to locate the ISO image.
+NOTE: Search the keyword "compass4nfv/Euphrates" to locate the ISO image.
E.g.
-compass4nfv/Danube/opnfv-2016-09-18_08-15-13.iso
+compass4nfv/Euphrates/opnfv-2017-09-18_08-15-13.tar.gz
-The name of iso image includes the time of iso building, you can get the daily
+The name of tarball includes the time of iso building, you can get the daily
ISO according the building time.
The git url and sha1 of Compass4nfv are recorded in properties files,
According these, the corresponding deployment scripts can be retrieved.
@@ -58,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 /Danube release, you can use the following command:
+To get stable /Euphrates release, you can use the following command:
-- git checkout Danube.1.0
+- git checkout Euphrates.1.0
Setup Requirements
------------------
@@ -126,17 +125,17 @@ Network requirements include:
- IPMI Network
- - Openstack mgmt Network*
+ - br-mgmt Network*
- - Openstack external Network*
+ - br-vlan Network*
- - Openstack tenant Network*
+ - br-tenant Network*
- - Openstack storage Network*
+ - br-storage Network*
3. Lights out OOB network access from Jumphost with IPMI node enabled (Bare Metal deployment only).
-4. External network has Internet access, meaning a gateway and DNS availability.
+4. br-vlan network has Internet access, meaning a gateway and DNS availability.
**The networks with(*) can be share one NIC(Default configuration) or use an exclusive**
**NIC(Reconfigurated in network.yml).**
diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst
index 7470363..d1a4863 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 Danube release of OPNFV when
+This document describes how to install the Euphrates release of OPNFV when
using Compass4nfv as a deployment tool covering it's limitations, dependencies
and required system resources.
@@ -16,6 +16,9 @@ Version history
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+---------------------------+
+| 2017-09-01 | 4.0.0 | Yifei Xue | Rewritten for |
+| | | (HUAWEI) | Compass4nfv E release |
++--------------------+--------------------+--------------------+---------------------------+
| 2017-02-21 | 3.0.0 | Justin chi | Changes for D release |
| | | (HUAWEI) | |
+--------------------+--------------------+--------------------+---------------------------+
diff --git a/docs/release/installation/offline-deploy.rst b/docs/release/installation/offline-deploy.rst
index 0acfa18..d35d7e1 100644
--- a/docs/release/installation/offline-deploy.rst
+++ b/docs/release/installation/offline-deploy.rst
@@ -3,15 +3,15 @@
Offline Deploy
==============
-Compass4nfv uses offline approach to deploy cluster and support complete offline
-deployment on a jumphost without access internet. Here is the offline deployment
-instruction:
+Compass4nfv uses a repo docker container as distro and pip package source
+to deploy cluster and support complete offline deployment on a jumphost without
+access internet. Here is the offline deployment instruction:
Preparation for offline deploy
------------------------------
-1. Download compass.iso from OPNFV artifacts repository (Search compass4nfv in
- http://artifacts.opnfv.org/ and download an appropriate ISO. ISO can also be
+1. Download compass.tar.gz from OPNFV artifacts repository (Search compass4nfv in
+ http://artifacts.opnfv.org/ and download an appropriate tarball. Tarball can also be
generated by script build.sh in compass4nfv root directory.)
2. Download the Jumphost preparation package from our httpserver. (Download the
@@ -25,10 +25,10 @@ Preparation for offline deploy
Steps of offline deploy
-----------------------
-1. Copy the compass.iso, jh_env_package.tar.gz and the compass4nfv code
+1. Copy the compass.tar.gz, jh_env_package.tar.gz and the compass4nfv code
repository to your jumphost.
-2. Export the local path of the compass.iso and jh_env_package.tar.gz on
+2. Export the local path of the compass.tar.gz and jh_env_package.tar.gz on
jumphost. Then you can perform deployment on a offline jumphost.
E.g.
@@ -41,7 +41,13 @@ Export the compass4nfv.iso and jh_env_package.tar.gz path
export ISO_URL=file:///home/compass/compass4nfv.iso
export JHPKG_URL=file:///home/compass/jh_env_package.tar.gz
-Run deploy.sh
+3. Open the OSA offline deployment switch on jumphost.
+
+.. code-block:: bash
+
+ export OFFLINE_DEPLOY=Enable
+
+4. Run deploy.sh
.. code-block:: bash
diff --git a/docs/release/installation/preconditions.rst b/docs/release/installation/preconditions.rst
index 67c0728..3ba42ab 100644
--- a/docs/release/installation/preconditions.rst
+++ b/docs/release/installation/preconditions.rst
@@ -21,30 +21,30 @@ networking and Unix/Linux administration.
Preconditions
-------------
-Before starting the installation of the Danube release of OPNFV,
+Before starting the installation of the Euphrates release of OPNFV,
some planning must be done.
-Retrieving the installation ISO image
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Retrieving the installation tarball
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
-First of all, The installation ISO is needed for deploying your OPNFV
+First of all, The installation tarball is needed for deploying your OPNFV
environment, it included packages of Compass, OpenStack, OpenDaylight, ONOS
and so on.
-The stable release ISO can be retrieved via `OPNFV software download page <https://www.opnfv.org/software>`_
+The stable release tarball can be retrieved via `OPNFV software download page <https://www.opnfv.org/software>`_
-The daily build ISO can be retrieved via OPNFV artifacts repository:
+The daily build tarball can be retrieved via OPNFV artifacts repository:
http://artifacts.opnfv.org/compass4nfv.html
-NOTE: Search the keyword "compass4nfv/Danube" to locate the ISO image.
+NOTE: Search the keyword "compass4nfv/Euphrates" to locate the tarball.
E.g.
-compass4nfv/danube/opnfv-2017-03-29_08-55-09.iso
+compass4nfv/euphrates/opnfv-2017-03-29_08-55-09.tar.gz
-The name of iso image includes the time of iso building, you can get the daily
-ISO according the building time.
+The name of tarball includes the time of tarball building, you can get the daily
+tarball according the building time.
The git url and sha1 of Compass4nfv are recorded in properties files,
According these, the corresponding deployment scripts can be retrieved.
@@ -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 /Danube release, you can use the following command:
+To get stable/euphrates release, you can use the following command:
-- git checkout Danube.1.0
+- git checkout Euphrates.1.0
Setup Requirements
------------------
diff --git a/docs/release/installation/vmdeploy.rst b/docs/release/installation/vmdeploy.rst
index 610ff51..16fb28d 100644
--- a/docs/release/installation/vmdeploy.rst
+++ b/docs/release/installation/vmdeploy.rst
@@ -5,6 +5,22 @@
Installation on virtual machines
================================
+Quick Start
+-----------
+
+Only 1 command to try virtual deployment, if you have Internet access. Just Paste it and Run.
+
+.. code-block:: bash
+
+ curl https://raw.githubusercontent.com/opnfv/compass4nfv/euphrates/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
+ export VIRT_NUMBER=2
+ curl https://raw.githubusercontent.com/opnfv/compass4nfv/euphrates/quickstart.sh | bash
+
Nodes Configuration (Virtual Deployment)
----------------------------------------
@@ -129,7 +145,7 @@ Start Deployment (Virtual Deployment)
1. Edit deploy.sh
1.1. Set OS version for deployment nodes.
- Compass4nfv supports ubuntu and centos based openstack newton.
+ Compass4nfv supports ubuntu and centos based openstack ocata.
E.g.
@@ -148,7 +164,7 @@ E.g.
.. code-block:: bash
# Set ISO image corresponding to your code
- export ISO_URL=file:///home/compass/compass4nfv.iso
+ export ISO_URL=file:///home/compass/compass4nfv.tar.gz
1.3. Set scenario that you want to deploy
@@ -164,16 +180,6 @@ nosdn-nofeature scenario deploy sample
# NETWORK is your network.yml's path
export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-ocl-nofeature scenario deploy sample
-
-.. code-block:: bash
-
- # DHA is your dha.yml's path
- export DHA=./deploy/conf/vm_environment/os-ocl-nofeature-ha.yml
-
- # NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_ocl.yml
-
odl_l2-moon scenario deploy sample
.. code-block:: bash
@@ -204,25 +210,15 @@ odl_l3-nofeature scenario deploy sample
# NETWORK is your network.yml's path
export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-onos-nofeature scenario deploy sample
+odl-sfc deploy scenario sample
.. code-block:: bash
# DHA is your dha.yml's path
- export DHA=./deploy/conf/vm_environment/os-onos-nofeature-ha.yml
+ export DHA=./deploy/conf/vm_environment/os-odl-sfc-ha.yml
# NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
-
-onos-sfc deploy scenario sample
-
-.. code-block:: bash
-
- # DHA is your dha.yml's path
- export DHA=./deploy/conf/vm_environment/os-onos-sfc-ha.yml
-
- # NETWORK is your network.yml's path
- export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
2. Run ``deploy.sh``
diff --git a/docs/release/release-notes/release-notes.rst b/docs/release/release-notes/release-notes.rst
index 99e18b5..dc06bf0 100644
--- a/docs/release/release-notes/release-notes.rst
+++ b/docs/release/release-notes/release-notes.rst
@@ -87,16 +87,24 @@ Feature additions
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+-----------------------------------------+
-| COMPASS-504 | Open-O deployment with Compass |
+| COMPASS-549 | Real Time KVM |
| | |
+--------------------------------------+-----------------------------------------+
-| COMPASS-362 | OpenDaylight Boron Support |
+| | OpenDaylight Nitrogen Support |
| | |
+--------------------------------------+-----------------------------------------+
-| COMPASS-491 | Support OpenStack Newton |
+| COMPASS-542 | Support OpenStack Ocata |
+| | |
++--------------------------------------+-----------------------------------------+
+| | Support ODL SFC |
+| | |
++--------------------------------------+-----------------------------------------+
+| COMPASS-550 | Support OVS-DPDK |
+| | |
++--------------------------------------+-----------------------------------------+
+| COMPASS-495 | Yardstick Integration into Compass4nfv |
| | |
+--------------------------------------+-----------------------------------------+
-
Bug corrections
@@ -104,13 +112,13 @@ Bug corrections
**JIRA TICKETS:**
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| | |
-| | |
-+--------------------------------------+--------------------------------------+
++--------------------------------------+----------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+----------------------------------------+
+| | With no ceph, the cluster will heal |
+| | itself after a power failure or reboot |
++--------------------------------------+----------------------------------------+
Known Limitations, Issues and Workarounds
@@ -130,16 +138,12 @@ System Limitations
Known issues
------------
-+----------------------+-------------------------------+-----------------------+
-| **Scenario** | **Issue** | **Workarounds** |
-+----------------------+-------------------------------+-----------------------+
-| os-odl-l3-no-feature | Occasionally failed to assign | Rebuild the instance |
-| | floating IP to an instance | and reassign floating |
-| | | IP |
-+----------------------+-------------------------------+-----------------------+
-| os-odl-l2-no-feature | Occasionally failed to login | Failed in testcase, |
-| | instance via ssh | normal in usage |
-+----------------------+-------------------------------+-----------------------+
++-----------------------+---------------------------------+-----------------------+
+| **Scenario** | **Issue** | **Workarounds** |
++-----------------------+---------------------------------+-----------------------+
+| Ceph Related Scenario | After a power failure or reboot,| Deploy without Ceph |
+| | the cluster cannot heal itself | |
++-----------------------+---------------------------------+-----------------------+
Test Result
diff --git a/docs/release/scenarios/index.rst b/docs/release/scenarios/index.rst
index a00eb44..131e985 100644
--- a/docs/release/scenarios/index.rst
+++ b/docs/release/scenarios/index.rst
@@ -12,4 +12,7 @@ Compass4NFV Scenarios
os-nosdn-nofeature-ha.rst
os-odl-nofeature-ha.rst
+ os-odl-sfc-ha.rst
+ os-nosdn-kvm-ha.rst
+ k8s-nosdn-nofeature-ha.rst
diff --git a/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst b/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst
new file mode 100644
index 0000000..7e8e3b3
--- /dev/null
+++ b/docs/release/scenarios/k8s-nosdn-nofeature-ha.rst
@@ -0,0 +1,39 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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
+deployment with no SDN controller and no feature enabled.
+
+.. contents::
+ :depth: 3
+ :local:
+
+============
+Introduction
+============
+
+This scenario is used to deploy an kubernets cluster.
+
+Scenario components and composition
+===================================
+
+This scenario includes a set of kubernets services which are kubernets API Server,
+Controller Manager, kube-proxy, kubelet,kube-dns,nginx-proxy,kubernetes-dashboard.
+Nginx-proxy is used to balance all the services running on 3 control nodes behind
+a VIP (Virtual IP address).
+
+Scenario usage overview
+=======================
+
+To deploy with this scenario, you just need to assign the
+k8s-nosdn-nofeature-ha.yaml to DHA file before deployment.
+
+Limitations, Issues and Workarounds
+===================================
+
+References
+==========
+
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/scenarios/os-nosdn-nofeature-ha.rst b/docs/release/scenarios/os-nosdn-nofeature-ha.rst
new file mode 100644
index 0000000..f2dce3d
--- /dev/null
+++ b/docs/release/scenarios/os-nosdn-nofeature-ha.rst
@@ -0,0 +1,41 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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
+deployment with no SDN controller and no feature enabled.
+
+.. contents::
+ :depth: 3
+ :local:
+
+============
+Introduction
+============
+
+This scenario is used to deploy an Ocata OpenStack deployment with
+Ceph Jewel, and without SDN controller nor any NFV feature enabled.
+
+Scenario components and composition
+===================================
+
+This scenario includes a set of common OpenStack services which are Nova,
+Neutron, Glance, Cinder, Keystone, Heat, Ceilometer, Gnocchi, Aodh,
+Horizon. Ceph is used as the backend of Cinder on deployed hosts. HAproxy
+is used to balance all the services running on 3 control nodes behind a
+VIP (Virtual IP address).
+
+Scenario usage overview
+=======================
+
+To deploy with this scenario, you just need to assign the
+os-nosdn-nofeature-ha.yaml to DHA file before deployment.
+
+Limitations, Issues and Workarounds
+===================================
+
+References
+==========
+
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/scenarios/os-odl-nofeature-ha.rst b/docs/release/scenarios/os-odl-nofeature-ha.rst
new file mode 100644
index 0000000..14b02e6
--- /dev/null
+++ b/docs/release/scenarios/os-odl-nofeature-ha.rst
@@ -0,0 +1,43 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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
+deployment with the OpenDaylight controller and no feature enabled.
+
+.. contents::
+ :depth: 3
+ :local:
+
+============
+Introduction
+============
+
+This scenario is used to deploy an Ocata OpenStack deployment with
+OpenDaylight Nitrogen, Ceph Jewel, and without any NFV feature enabled.
+
+Scenario components and composition
+===================================
+
+This scenario includes a set of common OpenStack services which are Nova,
+Neutron, Glance, Cinder, Keystone, Heat, Ceilometer, Gnocchi, Aodh,
+Horizon. Ceph is used as the backend of Cinder on deployed hosts. HAproxy
+is used to balance all the services running on 3 control nodes behind a
+VIP (Virtual IP address). OpenDaylight will also be deployed in this
+scenario. ODL is also running in HA. Neutron communicates with ODL
+through a VIP.
+
+Scenario usage overview
+=======================
+
+To deploy with this scenario, you just need to assign the
+os-odl-nofeature-ha.yaml to DHA file before deployment.
+
+Limitations, Issues and Workarounds
+===================================
+
+References
+==========
+
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/scenarios/os-odl-sfc-ha.rst b/docs/release/scenarios/os-odl-sfc-ha.rst
new file mode 100644
index 0000000..2a7a9fe
--- /dev/null
+++ b/docs/release/scenarios/os-odl-sfc-ha.rst
@@ -0,0 +1,45 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. 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
+deployment with the OpenDaylight controller and SFC feature enabled.
+
+.. contents::
+ :depth: 3
+ :local:
+
+============
+Introduction
+============
+
+This scenario is used to deploy an Ocata OpenStack deployment with
+OpenDaylight Nitrogen, Ceph Jewel, and SFC feature enabled.
+
+Scenario components and composition
+===================================
+
+This scenario includes a set of common OpenStack services which are Nova,
+Neutron, Glance, Cinder, Keystone, Heat, Ceilometer, Gnocchi, Aodh,
+Horizon. Ceph is used as the backend of Cinder on deployed hosts. HAproxy
+is used to balance all the services running on 3 control nodes behind a
+VIP (Virtual IP address). OpenDaylight will also be deployed in this
+scenario. ODL is also running in HA. Neutron communicates with ODL
+through a VIP. Open vSwitch with NSH patched is used instead of native
+Open vSwitch to support ODL SFC. Neutron communicates with ODL SFC to
+create port pair, classifier, port chain and etc.
+
+Scenario usage overview
+=======================
+
+To deploy with this scenario, you just need to assign the
+os-odl-nofeature-ha.yaml to DHA file before deployment.
+
+Limitations, Issues and Workarounds
+===================================
+
+References
+==========
+
+For more information on the OPNFV Euphrates release, please visit
+http://www.opnfv.org/euphrates
diff --git a/docs/release/userguide/FAQ/faq.rst b/docs/release/userguide/FAQ/faq.rst
index 177ff0b..f2500a0 100644
--- a/docs/release/userguide/FAQ/faq.rst
+++ b/docs/release/userguide/FAQ/faq.rst
@@ -52,33 +52,38 @@ an additional tagged VLAN is added if uses default network configuration.
How to set OpenStack Dashboard login user and password
======================================================
-It uses admin/console as the default user/pass for OpenStack Dashboard, and you can set it in below file:
-compass4nfv/deploy/conf/base.conf
+It uses admin as the default user for OpenStack Dashboard. The password can be achieved as below:
+
+.. code-block:: bash
+
+ sudo docker cp compass-tasks:/opt/openrc ./
+ sudo cat openrc | grep OS_PASSWORD
How to visit OpenStack Dashboard
================================
-You can visit OpenStack Dashboard by URL: http://{puclib_vip}/horizon
+For vm deployment, because NAT bridge is used in virtual deployment, horizon can not be access directly
+in external IP address. you need to cofigure the related IPtables rule at first.
-The public virtual IP is configured in "compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml"
-or "compass4nfv_FAQ/deploy/conf/vm_environment/huawei-virtual1/network.yml", defined as below:
+.. code-block:: bash
-.. code-block:: yaml
+ iptables -t nat -A PREROUTING -d $EX_IP -p tcp --dport $PORT -j DNAT --to 192.16.1.222:443
- public_vip:
- ip: 192.168.50.240
+The $EX_IP here is the server's ip address that can be access from external.
+You can use below command to query your external IP address.
-How to access controller nodes after deployment
-===============================================
+.. code-block:: bash
-1. First you should login Compass VM via ssh command on Jumphost by default user/pass root/root.
-The default login IP of Compass VM is configured in "compass4nfv/deploy/conf/base.conf", defined as below:
+ external_nic=`ip route |grep '^default'|awk '{print $5F}'
+ ip addr show $external_nic
+The $PORT here is the one of the port [1- 65535] that does't be used in system.
-.. code-block:: bash
+After that, you can visit OpenStack Dashboard by URL: http://$EX_IP:$PORT
- export MGMT_IP=${MGMT_IP:-192.168.200.2}
+How to access controller nodes after deployment
+===============================================
-2. Then you can login the controller nodes (host1-3) by default user/pass root/root via the install
+You can login the controller nodes (host1-3) by default user/pass root/root via the install
network IPs which are configured in "compass4nfv/deploy/conf/base.conf", defined as below:
.. code-block:: bash
@@ -111,8 +116,13 @@ network IPs which are configured in "compass4nfv/deploy/conf/base.conf", defined
Where is OpenStack RC file
==========================
-It is located /opt/admin-openrc.sh in each controller node as default. Please source it first if you
-want to use OpenStack CLI.
+The RC file named openrc is located in /root in utility container on each controller node as default.
+Please source it first if you want to use OpenStack CLI.
+
+.. code-block:: bash
+
+ lxc-attach -n $(lxc-ls | grep utility)
+ source /root/openrc
How to recovery network connection after Jumphost reboot
========================================================