summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/FAQ/faq.rst8
-rw-r--r--docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst6
-rw-r--r--docs/FAQ/index.rst2
-rw-r--r--docs/installationprocedure/bmdeploy.rst (renamed from docs/configguide/bmdeploy.rst)183
-rw-r--r--docs/installationprocedure/index.rst (renamed from docs/configguide/index.rst)6
-rw-r--r--docs/installationprocedure/installation.instruction.rst (renamed from docs/configguide/installerconfig.rst)22
-rw-r--r--docs/installationprocedure/introduction.rst (renamed from docs/configguide/introduction.rst)8
-rw-r--r--docs/installationprocedure/postinstall.rst (renamed from docs/configguide/postinstall.rst)0
-rw-r--r--docs/installationprocedure/references.rst (renamed from docs/configguide/references.rst)2
-rw-r--r--docs/installationprocedure/vmdeploy.rst (renamed from docs/configguide/vmdeploy.rst)127
-rw-r--r--docs/release-notes/index.rst4
-rw-r--r--docs/release-notes/release-notes.rst56
12 files changed, 255 insertions, 169 deletions
diff --git a/docs/FAQ/faq.rst b/docs/FAQ/faq.rst
index 4697d537..feae4142 100644
--- a/docs/FAQ/faq.rst
+++ b/docs/FAQ/faq.rst
@@ -68,7 +68,7 @@ The public virtual IP is configured in "compass4nfv/deploy/conf/network_cfg.yaml
How to access BM nodes after deployment
=======================================
-1. First you should login Compass VM via ssh command on JumpHost by default user/pass root/root.
+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:
.. code-block:: bash
@@ -99,7 +99,7 @@ which are configured in "compass4nfv/deploy/conf/base.conf", defined as below:
+---+VM+--+ | +-------------+
+--------------------+ |
| | | +-------------+
- | JumpHost | | | |
+ | Jumphost | | | |
| | +----------+ host3 |
+--------------------+ | |
+-------------+
@@ -111,8 +111,8 @@ Where is OpenStack RC file
It is located /opt/admin-openrc.sh in each BM node as default. Please source it first if you want to use
OpenStack CLI.
-How to recovery network connection after jumpserver reboot
-==========================================================
+How to recovery network connection after Jumphost reboot
+========================================================
.. code-block:: bash
diff --git a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst b/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst
index 37db1aed..f12d38d0 100644
--- a/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst
+++ b/docs/FAQ/how-to-deploy-while-jumphost-cannot-access-internet.rst
@@ -1,10 +1,10 @@
.. two dots create a comment. please leave this logo at the top of each of your rst files.
-How to deploy while jumphost cannot access internet
+How to deploy while Jumphost cannot access internet
===================================================
-If your jumphost cannot access internet, don't worry, you can definitely deploy compass without internet access.
+If your Jumphost cannot access internet, don't worry, you can definitely deploy compass without internet access.
-You can download compass.iso first from OPNFV artifacts repository (http://artifacts.opnfv.org/, search compass4nfv and select an appropriate ISO file) via wget or curl. Then copy the compass.iso and the compass4nfv repository to your jumphost and editor the ISO_URL to your local path.
+You can download compass.iso first from OPNFV artifacts repository (http://artifacts.opnfv.org/, search compass4nfv and select an appropriate ISO file) via wget or curl. Then copy the compass.iso and the compass4nfv repository to your Jumphost and editor the ISO_URL to your local path.
After that you can deploy compass without internet access.
diff --git a/docs/FAQ/index.rst b/docs/FAQ/index.rst
index d152895a..7b349d0e 100644
--- a/docs/FAQ/index.rst
+++ b/docs/FAQ/index.rst
@@ -2,7 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
=========================================================
-OPNFV(Brahmaputra) Compass4nfv Frequently Asked Questions
+OPNFV(Colorado) Compass4nfv Frequently Asked Questions
=========================================================
Contents:
diff --git a/docs/configguide/bmdeploy.rst b/docs/installationprocedure/bmdeploy.rst
index d8430adc..6ec70fa4 100644
--- a/docs/configguide/bmdeploy.rst
+++ b/docs/installationprocedure/bmdeploy.rst
@@ -10,10 +10,12 @@ Nodes Configuration (Bare Metal Deployment)
The below file is the inventory template of deployment nodes:
-"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/[dha].yml"
+"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/dha.yml"
You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
+ - name -- Host name for deployment node after installation.
+
- ipmiVer -- IPMI interface version for deployment node support. IPMI 1.0
or IPMI 2.0 is available.
@@ -26,10 +28,26 @@ You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
- mac -- MAC Address of deployment node PXE NIC .
- - name -- Host name for deployment node after installation.
-
- roles -- Components deployed.
+**Set TYPE/FLAVOR and POWER TOOL**
+
+E.g.
+.. code-block:: yaml
+
+ TYPE: baremetal
+ FLAVOR: cluster
+ POWER_TOOL: ipmitool
+
+**Set ipmiUser/ipmiPass and ipmiVer**
+
+E.g.
+
+.. code-block:: yaml
+
+ ipmiUser: USER
+ ipmiPass: PASSWORD
+ ipmiVer: '2.0'
**Assignment of different roles to servers**
@@ -39,11 +57,19 @@ E.g. Openstack only deployment roles setting
hosts:
- name: host1
+ mac: 'F8:4A:BF:55:A2:8D'
+ interfaces:
+ - eth1: 'F8:4A:BF:55:A2:8E'
+ ipmiIp: 172.16.130.26
roles:
- controller
- ha
- name: host2
+ mac: 'D8:49:0B:DA:5A:B7'
+ interfaces:
+ - eth1: 'D8:49:0B:DA:5A:B8'
+ ipmiIp: 172.16.130.27
roles:
- compute
@@ -56,6 +82,10 @@ E.g. Openstack and ceph deployment roles setting
hosts:
- name: host1
+ mac: 'F8:4A:BF:55:A2:8D'
+ interfaces:
+ - eth1: 'F8:4A:BF:55:A2:8E'
+ ipmiIp: 172.16.130.26
roles:
- controller
- ha
@@ -63,6 +93,10 @@ E.g. Openstack and ceph deployment roles setting
- ceph-mon
- name: host2
+ mac: 'D8:49:0B:DA:5A:B7'
+ interfaces:
+ - eth1: 'D8:49:0B:DA:5A:B8'
+ ipmiIp: 172.16.130.27
roles:
- compute
- ceph-osd
@@ -73,12 +107,20 @@ E.g. Openstack and ODL deployment roles setting
hosts:
- name: host1
+ mac: 'F8:4A:BF:55:A2:8D'
+ interfaces:
+ - eth1: 'F8:4A:BF:55:A2:8E'
+ ipmiIp: 172.16.130.26
roles:
- controller
- ha
- odl
- name: host2
+ mac: 'D8:49:0B:DA:5A:B7'
+ interfaces:
+ - eth1: 'D8:49:0B:DA:5A:B8'
+ ipmiIp: 172.16.130.27
roles:
- compute
@@ -88,21 +130,29 @@ E.g. Openstack and ONOS deployment roles setting
hosts:
- name: host1
+ mac: 'F8:4A:BF:55:A2:8D'
+ interfaces:
+ - eth1: 'F8:4A:BF:55:A2:8E'
+ ipmiIp: 172.16.130.26
roles:
- controller
- ha
- onos
- name: host2
+ mac: 'D8:49:0B:DA:5A:B7'
+ interfaces:
+ - eth1: 'D8:49:0B:DA:5A:B8'
+ ipmiIp: 172.16.130.27
roles:
- compute
-
Network Configuration (Bare Metal Deployment)
---------------------------------------------
-Before deployment, there are some network configuration to be checked based on your network topology.
-Compass4nfv network default configuration file is "compass4nfv/deploy/conf/network_cfg.yaml".
+Before deployment, there are some network configuration to be checked based
+on your network topology.Compass4nfv network default configuration file is
+"compass4nfv/deploy/conf/hardware_environment/huawei-pod1/network.yml".
You can write your own reference to it.
**The following figure shows the default network configuration.**
@@ -155,107 +205,124 @@ You can write your own reference to it.
Start Deployment (Bare Metal Deployment)
----------------------------------------
-1. Set PXE/Installation NIC for Jumphost. (set eth1 E.g.)
-
-.. code-block:: bash
-
- export INSTALL_NIC=eth1
-
-
-2.Set OS version and OpenStack version for deployment nodes.
+1. Edit run.sh
+Set OS version and OpenStack version for deployment nodes.
Compass4nfv Colorado supports three OS version based openstack mitaka.
-Ubuntu 14.04 mitaka:
+E.g.
.. code-block:: bash
+ ########## Ubuntu14.04 Mitaka ##########
export OS_VERSION=trusty
export OPENSTACK_VERSION=mitaka
-Ubuntu 16.04 mitaka:
+ ########## Ubuntu16.04 Mitaka ##########
+ # export OS_VERSION=xenial
+ # export OPENSTACK_VERSION=mitaka_xenial
-.. code-block:: bash
+ ########## Centos7 Mitaka ##########
+ # export OS_VERSION=centos7
+ # export OPENSTACK_VERSION=mitaka
- export OS_VERSION=xenial
- export OPENSTACK_VERSION=mitaka_xenial
+Set ISO image that you want to deploy
-Centos 7 mitaka:
+E.g.
.. code-block:: bash
- export OS_VERSION=centos7
- export OPENSTACK_VERSION=mitaka
+ # ISO_URL is your iso's absolute path
+ export ISO_URL=file:///home/compass/compass4nfv.iso
+ # or
+ # export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
-3. Set ISO image that you want to deploy
+Set Jumphost PXE NIC. (set eth1 E.g.)
+
+E.g.
.. code-block:: bash
- export ISO_URL=file:///${YOUR_OWN}/compass.iso
- or
- export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
+ ########## Hardware Deploy Jumphost PXE NIC ##########
+ # you need comment out it when virtual deploy
+ export INSTALL_NIC=eth1
-4. Run ``deploy.sh`` with inventory and network configuration
+Set scenario that you want to deploy
+
+E.g.
+
+nosdn-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-nosdn-nofeature-ha.yml
-E.g.
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
-1. nosdn-nofeature scenario deploy sample
+ocl-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-nosdn-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # 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
-2. ocl-nofeature scenario deploy sample
+odl_l2-moon scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-ocl-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network_ocl.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-moon-ha.yml
-3. odl_l2-moon scenario deploy sample
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
+
+odl_l2-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-moon-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-nofeature-ha.yml
+
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network.yml
- 4. odl_l2-nofeature scenario deploy template
+odl_l3-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-odl_l2-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-odl_l3-nofeature-ha.yml
-5. 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
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-odl_l3-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network.yml
+ # 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
-6. onos-nofeature scenario deploy sample
+onos-sfc deploy scenario sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-onos-nofeature-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml
-7. onos-sfc deploy scenario sample
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
-.. code-block:: bash
+2. Run ``run.sh``
- ./deploy.sh \
- --dha ./deploy/conf/hardware_environment/huawei-pod1/os-onos-sfc-ha.yml \
- --network ./deploy/conf/hardware_environment/huawei-pod1/network_onos.yml
+.. code-block:: bash
+ ./run.sh
diff --git a/docs/configguide/index.rst b/docs/installationprocedure/index.rst
index fa212a03..6416e35d 100644
--- a/docs/configguide/index.rst
+++ b/docs/installationprocedure/index.rst
@@ -1,8 +1,8 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
********************************************************
-OPNFV(Colorado) Compass4nfv installation instructions
+OPNFV(Colorado) Compass4nfv Installation Instructions
********************************************************
.. toctree::
@@ -10,7 +10,7 @@ OPNFV(Colorado) Compass4nfv installation instructions
:maxdepth: 4
introduction.rst
- installerconfig.rst
+ installation.instruction.rst
bmdeploy.rst
vmdeploy.rst
references.rst
diff --git a/docs/configguide/installerconfig.rst b/docs/installationprocedure/installation.instruction.rst
index 21cd0825..87c8a55c 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/installationprocedure/installation.instruction.rst
@@ -36,13 +36,12 @@ The stable release ISO can be retrieved via `OPNFV software download page <https
The daily build ISO can be retrieved via OPNFV artifacts repository:
-http://artifacts.opnfv.org/
+http://artifacts.opnfv.org/compass4nfv.html
NOTE: Search the keyword "compass4nfv/Colorado" to locate the ISO image.
E.g.
-compass4nfv/colorado/opnfv-2016-01-16_15-03-18.iso
-compass4nfv/colorado/opnfv-2016-01-16_15-03-18.properties
+compass4nfv/colorado/opnfv-2016-09-18_08-15-13.iso
The name of iso image includes the time of iso building, you can get the daily
ISO according the building time.
@@ -57,26 +56,12 @@ To retrieve the repository of Compass4nfv on Jumphost use the following command:
- git clone https://gerrit.opnfv.org/gerrit/compass4nfv
-NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN root DIRECTORY.
+NOTE: PLEASE DO NOT GIT CLONE COMPASS4NFV IN ROOT DIRECTORY(INCLUDE SUBFOLDERS).
To get stable /colorado release, you can use the following command:
- git checkout colorado.1.0
-If you don't have a Linux foundation user id, get it first by the url:
-
-https://wiki.opnfv.org/developer/getting_started
-
-If you want to use a daily release ISO, please checkout the corresponding sha1 to
-get the deployment scripts:
-
-E.g.
-Git sha1 in file "opnfv-2016-01-16_15-03-18.properties" is
-d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-
-- git checkout d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-
-
Setup Requirements
------------------
@@ -167,4 +152,3 @@ In order to execute a deployment, one must gather the following information:
2. IPMI login information for the nodes (user/pass).
3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes.
-..
diff --git a/docs/configguide/introduction.rst b/docs/installationprocedure/introduction.rst
index 820cb29a..835a5788 100644
--- a/docs/configguide/introduction.rst
+++ b/docs/installationprocedure/introduction.rst
@@ -5,7 +5,7 @@
Abstract
========
-This document describes how to install the Brahmaputra release of OPNFV when
+This document describes how to install the Colorado release of OPNFV when
using Compass4nfv as a deployment tool covering it's limitations, dependencies
and required system resources.
@@ -16,6 +16,12 @@ Version history
| **Date** | **Ver.** | **Author** | **Comment** |
| | | | |
+--------------------+--------------------+--------------------+---------------------------+
+| 2016-09-13 | 2.1.0 | Yuenan Li | Adjusted the docs |
+| | | (HUAWEI) | structure |
++--------------------+--------------------+--------------------+---------------------------+
+| 2016-09-12 | 2.0.0 | Yuenan Li | Rewritten for |
+| | | (HUAWEI) | Compass4nfv C release |
++--------------------+--------------------+--------------------+---------------------------+
| 2016-01-17 | 1.0.0 | Justin chi | Rewritten for |
| | | (HUAWEI) | Compass4nfv B release |
+--------------------+--------------------+--------------------+---------------------------+
diff --git a/docs/configguide/postinstall.rst b/docs/installationprocedure/postinstall.rst
index f9b7aa92..f9b7aa92 100644
--- a/docs/configguide/postinstall.rst
+++ b/docs/installationprocedure/postinstall.rst
diff --git a/docs/configguide/references.rst b/docs/installationprocedure/references.rst
index 467bf08d..c7ede9c8 100644
--- a/docs/configguide/references.rst
+++ b/docs/installationprocedure/references.rst
@@ -17,7 +17,7 @@ OPNFV
OpenStack
---------
-`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+`OpenStack Mitaka Release artifacts <http://www.openstack.org/software/mitaka>`_
`OpenStack documentation <http://docs.openstack.org>`_
diff --git a/docs/configguide/vmdeploy.rst b/docs/installationprocedure/vmdeploy.rst
index 546936d7..cb5df6fb 100644
--- a/docs/configguide/vmdeploy.rst
+++ b/docs/installationprocedure/vmdeploy.rst
@@ -10,7 +10,7 @@ Nodes Configuration (Virtual Deployment)
The below file is the inventory template of deployment nodes:
-"compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network.yml"
+"./deploy/conf/vm_environment/huawei-virtual1/network.yml"
You can write your own address/roles reference to it.
@@ -18,6 +18,14 @@ You can write your own address/roles reference to it.
- roles -- Components deployed.
+**Set TYPE and FLAVOR**
+
+E.g.
+
+.. code-block:: yaml
+
+ TYPE: virtual
+ FLAVOR: cluster
**Assignment of different roles to servers**
@@ -85,12 +93,12 @@ E.g. Openstack and ONOS deployment roles setting
roles:
- compute
-
Network Configuration (Virtual Deployment)
------------------------------------------
-Before deployment, there are some network configuration to be checked based on your network topology.
-Compass4nfv network default configuration file is "compass4nfv/deploy/conf/network_cfg.yaml".
+Before deployment, there are some network configuration to be checked based
+on your network topology.Compass4nfv network default configuration file is
+"compass4nfv/deploy/conf/vm_environment/huawei-virtual1/network.yml".
You can write your own reference to it.
**The following figure shows the default network configuration.**
@@ -133,107 +141,120 @@ You can write your own reference to it.
| External Network | |
+---------------------------+ |
+-----------------------+---+
- | PXE(Installation) Network |
+ | Installation Network |
+---------------------------+
-
Start Deployment (Virtual Deployment)
-------------------------------------
-1. Set OS version and OpenStack version for deployment nodes.
+1. Edit run.sh
+Set OS version and OpenStack version for deployment nodes.
Compass4nfv Colorado supports three OS version based openstack mitaka.
-Ubuntu 14.04 mitaka:
+E.g.
.. code-block:: bash
+ ########## Ubuntu14.04 Mitaka ##########
export OS_VERSION=trusty
export OPENSTACK_VERSION=mitaka
-Ubuntu 16.04 mitaka:
+ ########## Ubuntu16.04 Mitaka ##########
+ # export OS_VERSION=xenial
+ # export OPENSTACK_VERSION=mitaka_xenial
-.. code-block:: bash
+ ########## Centos7 Mitaka ##########
+ # export OS_VERSION=centos7
+ # export OPENSTACK_VERSION=mitaka
- export OS_VERSION=xenial
- export OPENSTACK_VERSION=mitaka_xenial
+Set ISO image that you want to deploy
-Centos 7 mitaka:
+E.g.
.. code-block:: bash
- export OS_VERSION=centos7
- export OPENSTACK_VERSION=mitaka
-
-2. Set ISO image that you want to deploy
+ # ISO_URL is your iso's absolute path
+ # export ISO_URL=file:///home/compass/compass4nfv.iso
+ # or
+ # export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
-.. code-block:: bash
+Set scenario that you want to deploy
- export ISO_URL=file:///${YOUR_OWN}/compass.iso
- or
- export ISO_URL=http://artifacts.opnfv.org/compass4nfv/colorado/opnfv-colorado.1.0.iso
+E.g.
-3. Run ``deploy.sh`` with inventory and network configuration
+nosdn-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-nosdn-nofeature-ha.yml
-E.g.
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-1. nosdn-nofeature scenario deploy sample
+ocl-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-nosdn-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # 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
-2. ocl-nofeature scenario deploy sample
+odl_l2-moon scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-ocl-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network_ocl.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-odl_l2-moon-ha.yml
+
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-3. odl_l2-moon scenario deploy sample
+odl_l2-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-odl_l2-moon-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-odl_l2-nofeature-ha.yml
-4. odl_l2-nofeature scenario deploy sample
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
+
+odl_l3-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-odl_l2-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-odl_l3-nofeature-ha.yml
+
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network.yml
-5. odl_l3-nofeature scenario deploy sample
+onos-nofeature scenario deploy sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-odl_l3-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-onos-nofeature-ha.yml
+
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
-6. onos-nofeature scenario deploy sample
+onos-sfc deploy scenario sample
.. code-block:: bash
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-onos-nofeature-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
+ # DHA is your dha.yml's path
+ export DHA=./deploy/conf/vm_environment/os-onos-sfc-ha.yml
-7. onos-sfc deploy scenario sample
+ # NETWORK is your network.yml's path
+ export NETWORK=./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
-.. code-block:: bash
+2. Run ``run.sh``
- ./deploy.sh \
- --dha ./deploy/conf/vm_environment/os-onos-sfc-ha.yml \
- --network ./deploy/conf/vm_environment/huawei-virtual1/network_onos.yml
+.. code-block:: bash
+ ./run.sh
diff --git a/docs/release-notes/index.rst b/docs/release-notes/index.rst
index 763280a5..c6050e91 100644
--- a/docs/release-notes/index.rst
+++ b/docs/release-notes/index.rst
@@ -5,11 +5,9 @@
OPNFV((Colorado) Compass4nfv Release Notes
============================================
-Contents:
-
.. toctree::
:numbered:
- :maxdepth: 4
+ :maxdepth: 3
release-notes.rst
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst
index fa8b5f0c..ff8ec500 100644
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
@@ -2,10 +2,7 @@
.. http://creativecommons.org/licenses/by/4.0
.. (c) Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-=============================================================================================
-Release Note for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
-=============================================================================================
-
+Release Note for the Colorado release of OPNFV when using Compass4nfv as a deployment tool.
Abstract
========
@@ -34,7 +31,7 @@ Release Data
| **Release designation** | Colorado.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | 2016.2.25 |
+| **Release date** | September 22 2016 |
| | |
+--------------------------------------+--------------------------------------+
| **Purpose of the delivery** | OPNFV Colorado release |
@@ -65,21 +62,21 @@ Version change
Module version change
~~~~~~~~~~~~~~~~~~~~~
-This is the first release of compass4nfv as a deployment toolchain in OPNFV, the following
+This is the Colorado release of compass4nfv as a deployment toolchain in OPNFV, the following
upstream components supported with this release.
- Ubuntu 14.04.3
- - Openstack (Liberty release)
+ - Openstack (Mitaka release)
- - Opendaylight (Beryllium rc1 release)
+ - Opendaylight (Beryllium SR2 release)
- - ONOS (Emu release)
+ - ONOS (Goldeneye release)
Document version change
~~~~~~~~~~~~~~~~~~~~~~~
-None due to first release, and you can see document :ref:`document-label`.
+Adjusted the document structure, and you can see document at `OPNFV(Colorado) Compass4nfv installation instructions <http://artifacts.opnfv.org/compass4nfv/docs/configguide/index.html>`_.
Reason for new version
----------------------
@@ -91,13 +88,13 @@ Feature additions
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+-----------------------------------------+
-| JIRA: COMPASS-34 | Support OpenStack Liberty deployment |
+| JIRA: COMPASS-438 | Add A Task Of ONOS-SFC |
| | |
+--------------------------------------+-----------------------------------------+
-| JIRA: COMPASS-307 | Integration OpenDaylight Beryllium |
+| JIRA: COMPASS-443 | Add MOON in Compass |
| | |
+--------------------------------------+-----------------------------------------+
-| | |
+| JIRA: COMPASS-444 | Add Xenial-mitaka ODL Support |
| | |
+--------------------------------------+-----------------------------------------+
@@ -111,7 +108,7 @@ Bug corrections
| **JIRA REFERENCE** | **SLOGAN** |
| | |
+--------------------------------------+--------------------------------------+
-| JIRA: | |
+| JIRA: COMPASS-459 | PXE boot may have NO SIGNAL |
| | |
+--------------------------------------+--------------------------------------+
@@ -122,9 +119,27 @@ Known Limitations, Issues and Workarounds
System Limitations
------------------
+**Max number of blades:** 1 Jumphost, 3 Controllers, 20 Compute blades
+
+**Min number of blades:** 1 Jumphost, 1 Controller, 1 Compute blade
+
+**Storage:** Ceph is the only supported storage configuration
+
+**Min Jumphost requirements:** At least 16GB of RAM, 16 core CPU
+
Known issues
------------
++---------------+----------------------------------------------+
+| **Scenario** | **Issue** |
++---------------+----------------------------------------------+
+| MOON | First ODL test FAILS because ODL/Openstack |
+| | federation done in moon is partial. Only |
+| | MD-SAL is federated (not AD-SAL) |
++---------------+----------------------------------------------+
+| | |
++---------------+----------------------------------------------+
+
**JIRA TICKETS:**
+--------------------------------------+--------------------------------------+
@@ -138,17 +153,12 @@ Known issues
Workarounds
-----------
-See JIRA: <link>
+`See JIRA <https://jira.opnfv.org/issues/?jql=project%20%3D%20COMPASS%20AND%20labels%20%3D%20C-1.0-Workaround>`_
Test Result
===========
-The Brahmaputra release with the Compass4nfv deployment toolchain has undergone QA test
+The Colorado release with the Compass4nfv deployment toolchain has undergone QA test
runs with the following results:
- - `Functest test result <http://artifacts.opnfv.org/functest/docs/results/overview.html>`_
- - `Yardstick test result <http://testresults.opnfv.org/grafana/>`_
-
-References
-==========
-For more information on the OPNFV Brahmaputra release, please visit
-http://www.opnfv.org/brahmaputra
+ - `Functest test result <http://testresults.opnfv.org/reporting/functest/release/colorado/index-status-compass.html>`_
+ - `Yardstick test result <http://testresults.opnfv.org/reporting/yardstick/release/colorado/index-status-compass.html>`_