summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorChristopherPrice <christopher.price@ericsson.com>2016-02-22 21:26:30 +0100
committerJustin chi <chigang@huawei.com>2016-02-23 11:18:18 +0000
commit12ed03757850a229241c0ec0a07467b064459740 (patch)
tree7955fab0f7fab85545a2702af87ca1498865dc8b /docs
parent30a025381e198416c6dc8cada24b53e1657dda04 (diff)
Adding aligned structure and segmenting the configguide.
Also set heading levels for readability and added missing licence headers. Copied the header where I copied content, so please be mindful and inform me if you disagree. Removal parts of userguide duplicated with configguide. Take the others into faq.rst Removal duplicated references in installerconfig. Removal redundant png files. Release notes update for Brahmaputra release. Change-Id: I6e1a101107752f4bc7b6e3bbaea0738690d07af8 Signed-off-by: ChristopherPrice <christopher.price@ericsson.com> Signed-off-by: Justin-chi <chigang@huawei.com> (cherry picked from commit 3eab3cd722870e6c02ee1337d3536dc68f89b13e)
Diffstat (limited to 'docs')
-rw-r--r--docs/FAQ/FAQ.rst130
-rw-r--r--docs/FAQ/how-to-build-customized-iso.rst (renamed from docs/how-to-use-compass4nfv/documentation-compass4nfv.rst)252
-rw-r--r--docs/FAQ/how-to-deploy-without-internet-access.rst18
-rw-r--r--docs/FAQ/how-to-integrate-plugins.rst7
-rw-r--r--docs/FAQ/index.rst13
-rw-r--r--docs/configguide/index.rst (renamed from docs/installation-instructions/index.rst)7
-rw-r--r--docs/configguide/installerconfig.rst354
-rw-r--r--docs/configguide/introduction.rst29
-rw-r--r--docs/configguide/postinstall.rst50
-rw-r--r--docs/configguide/references.rst40
-rw-r--r--docs/configguide/vmdeploy.rst46
-rw-r--r--docs/how-to-use-compass4nfv/compass4nfv_host_network.pngbin36846 -> 0 bytes
-rw-r--r--docs/how-to-use-compass4nfv/compass4nfv_network_topology.pngbin155268 -> 0 bytes
-rw-r--r--docs/how-to-use-compass4nfv/index.rst13
-rw-r--r--docs/installation-instructions/installation-instructions.rst455
-rw-r--r--docs/release-notes/release-notes.rst80
16 files changed, 577 insertions, 917 deletions
diff --git a/docs/FAQ/FAQ.rst b/docs/FAQ/FAQ.rst
deleted file mode 100644
index b5ea05f8..00000000
--- a/docs/FAQ/FAQ.rst
+++ /dev/null
@@ -1,130 +0,0 @@
-==========================================================================================
-OPNFV FAQ for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
-==========================================================================================
-
-
-.. contents:: Table of Contents
- :backlinks: none
-
-
-Abstract
-========
-
-This document describes Frequently Asked Questions of OPNFV when using Compass4nfv
-as a deployment tool.
-
-License
-=======
-
-Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool Docs
-(c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-
-Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool Docs
-are licensed under a Creative Commons Attribution 4.0 International License.
-You should have received a copy of the license along with this.
-If not, see <http://creativecommons.org/licenses/by/4.0/>.
-
-Version history
-===============
-
-+--------------------+--------------------+--------------------+---------------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+---------------------------+
-| 2016-01-25 | 0.0.2 | Justin Chi | Add template |
-| | | (HUAWEI) | |
-+--------------------+--------------------+--------------------+---------------------------+
-| 2016-01-17 | 0.0.1 | Justin Chi | First draft |
-| | | (HUAWEI) | |
-+--------------------+--------------------+--------------------+---------------------------+
-
-General Remarks
-===============
-
-
-New Features
-============
-
-Ubuntu 14.04 support
---------------------
-
-Compass4nfv for Brahmaputra release uses Ubuntu 14.04 as its target OPNFV system base OS.
-
-Openstack Liberty release support
----------------------------------
-
-Ceph Infernalis release support
--------------------------------
-
-OpenDaylight Lithium release support
-------------------------------------
-
-ONOS Emu release support
-------------------------
-
-Opencontrail release support
-----------------------------
-
-High-availability for OpenStack
--------------------------------
-
-
-Improvements/Enhancements
-=========================
-
-
-Performance Improvements/Enhancements
--------------------------------------
-
-<First release, none at this time>
-
-
-Other Improvements/Enhancements
--------------------------------
-
-<First release, none at this time>
-
-
-Removed/Retired Features
-========================
-
-<First release, none at this time>
-
-
-Bug Fixes
-=========
-
-
-Known Issues
-============
-
-
-Installation Information
-========================
-
-
-Installation instructions can be found at:
-
-`Here <http://artifacts.opnfv.org/compass4nfv/docs/Brahmaputra_installation-instructions/index.html>`_
-
-
-Frequently Asked Questions
-==========================
-
-Frequently asked questions can be found at:
-
-`Here <http://artifacts.opnfv.org/compass4nfv/docs/Brahmaputra_FAQ/FAQ.html>`_
-
-
-Stay informed
-=============
-
-You are encouraged to subscribe to the OPNFV announcement mailing list to receive important
-notifications such as product updates and security patches.
-
-To get support you can send an email to: opnfv-users@lists.opnfv.org.
-
-
-
-:Authors: Justin Chi (HUAWEI)
-:Version: 0.0.1
diff --git a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst b/docs/FAQ/how-to-build-customized-iso.rst
index 7fbd1578..37b5c72b 100644
--- a/docs/how-to-use-compass4nfv/documentation-compass4nfv.rst
+++ b/docs/FAQ/how-to-build-customized-iso.rst
@@ -1,45 +1,5 @@
.. two dots create a comment. please leave this logo at the top of each of your rst files.
-Prerequisite
-============
-
-1. One jumpserver installed with Ubuntu14.04.
-
-
-2. If baremetal is targeted deployment environment, we suggest the environment as the following topology picture,
-jumpserver and baremetal need 3 ethernet ports, one ports(External/Tenant) connects to one switch,
-and two ports (IPMI/BMC, PXE/Installation) connects to another switch.
-
-.. image:: compass4nfv_network_topology.png
- :height: 400
- :width: 700
- :alt: OPNFV
- :align: left
-
-If jumpserver doesn't have enough ethernet ports, two ports is
-also acceptable(IPMI/BMC and PXE/Installation run through one ethernet port).
-
-If switches are not enough, one switch with 2 VLANs is also acceptable.
-
-
-3. Pre-allocate BMC IP addresses for baremetals, and get accounts and passwords of BMC on baremetals.
-
-
-4. If virtual machines is targeted deployment environment, the jumpserver also needs 100G storage and 16G RAM.
-
-
-5. Gerrit: git clone https://gerrit.opnfv.org/gerrit/compass4nfv to the jumpserver.
-
-
-6. Please don't git clone compass4nfv in the root directory.
-
-
-Attention: Compass4nfv does stick on the OPNFV communities' Operating System version requirement.
-For Brahmaputra, Ubuntu14.04 or newer and Centos7.0 or newer are requested,
-so the targeted deployment environment will be installed on Ubuntu14.04 or Centos7.1.
-
-
-
How to build a customized ISO
=============================
@@ -332,215 +292,3 @@ in the "compass4nfv/work/building" folder, that means building ISO successfully.
* Approach 3 ---- autonomous packages installation
package installed, to be continued...
-
-
-
-How to deploy baremetal and VMs
-===============================
-
-Before deployment, there are some network configuration to be checked based on your reality network topology.
-Compass4nfv network configuration file is "compass4nfv/deploy/conf/network_cfg.yaml".
-
-Based on current default network configuration, the hosts(controller,compute) network is as following picture.
-
-.. image:: compass4nfv_host_network.png
- :height: 500
- :width: 700
- :alt: OPNFV
- :align: left
-
-network_cfg.yaml
-
-.. code-block:: bash
-
- provider_net_mappings:
- - name: br-prv
- network: physnet
- interface: eth1
- type: ovs
- role:
- - controller
- - compute
- sys_intf_mappings:
- - name: mgmt
- interface: eth1
- vlan_tag: 2
- role:
- - controller
- - compute
- - name: storage
- interface: eth1
- vlan_tag: 3
- role:
- - controller
- - compute
- - name: external
- interface: br-prv
- vlan_tag: 4
- role:
- - controller
- - compute
- ip_settings:
- - name: mgmt
- ip_ranges:
- - - "172.16.1.1"
- - "172.16.1.254"
- cidr: "172.16.1.0/24"
- role:
- - controller
- - compute
- - name: storage
- ip_ranges:
- - - "172.16.2.1"
- - "172.16.2.254"
- cidr: "172.16.2.0/24"
- role:
- - controller
- - compute
- - name: external
- ip_ranges:
- - - "172.16.3.2"
- - "172.16.3.100"
- cidr: "172.16.3.0/24"
- gw: "172.16.3.1"
- role:
- - controller
- - compute
-
-
-
-"br-prv" is a bridge created by OpenvSwitch, "mgmt" "storage" and "external" are VLAN.
-
-"mgmt" "stoarge" and "br-prv" can locate on any ethernet port("interface")
-as long as the host can communicate with other hosts via this ethernet.
-
-"external" must locate on "br-prv".
-
-"mgmt" "storage" and "external" could be set subnet as you like,
-but must be in different subnets and "vlan_tag" also must be different.
-
-
-Also check the following items in file "compass4nfv/deploy/conf/base.conf"
-
-.. code-block:: bash
-
- export INSTALL_IP=${INSTALL_IP:-10.1.0.12}
- export INSTALL_MASK=${INSTALL_MASK:-255.255.255.0}
- export INSTALL_GW=${INSTALL_GW:-10.1.0.1}
-
-
-Item "INSTALL_IP" is used to install baremetal/VM during deployment.
-Compass4nfv on jumpserver creates a bridge with IP address "INSTALL_GW" and
-all baremetal/VM deployments are via this subnet. Please don't set this item
-as the same subnet as any other ip configuration in the jumpserver.
-
-
-
-
-
-* Deploy baremetal in HA mode:
-
-
-1. (optional) If you have built a new ISO before and want to use the new ISO,
-please edit compass4nfv/deploy/conf/base.conf file,
-modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso
-
-
-2. Edit compass4nfv/deploy/conf/baremetal_cluster_general.yml, to be continued...
-
-
-3. Edit compass4nfv/deploy/conf/base.conf, modify the item "export OM_NIC=${OM_NIC:-eth3}"
-as the install network ethernet port based your jumpserver.
-
-
-4. Run compass4nfv/deploy.sh baremetal_cluster_general
-
-
-
-
-* Deploy baremetal in Single mode:
-
-
-1. (optional) If you have built a new ISO before and want to use the new ISO,
-please edit compass4nfv/deploy/conf/base.conf file, modify the item "ISO_URL"
-as export ISO_URL=file:///compass4nfv/work/building/compass.iso
-
-
-2. Edit compass4nfv/deploy/conf/baremetal_five.yml , change items
-[name, mac, ipmiUser, ipmiPass, ipmiIp, roles] based on the baremetal to be deployed.
-
-
-3. Edit compass4nfv/deploy/conf/base.conf, modify the item
-"export OM_NIC=${OM_NIC:-eth3}" as the install network ethernet port based your jumpserver.
-
-
-4. Run compass4nfv/deploy.sh baremetal_five
-
-
-
-
-* Deploy VMs in HA mode:
-
-
-1. (optional) If you have built a new ISO before and want to use the new ISO,
-please edit compass4nfv/deploy/conf/base.conf file, modify the item
-"ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso
-
-
-2. (Optional) Edit compass4nfv/deploy/conf/virtual_cluster.yml, change items [name, roles] as you want,
-also you could reduce or add hosts sections as you want.
-And 3 controller in HA mode and 2 compute will be deployed without changing this yml file.
-
-
-3. Run compass4nfv/deploy.sh virtual_cluster or Run compass4nfv/deploy.sh .
-
-
-
-
-* Deploy baremetal in Single mode:
-
-
-1. (optional) If you have built a new ISO before and want to use the new ISO,
-please edit compass4nfv/deploy/conf/base.conf file,
-modify the item "ISO_URL" as export ISO_URL=file:///compass4nfv/work/building/compass.iso
-
-
-2. (Optional) Edit compass4nfv/deploy/conf/virtual_five.yml, change items [name, roles] as you want,
-also you could reduce or add hosts sections as you want.
-And 3 controller in HA mode and 2 compute will be deployed without changing this yml file.
-
-
-3. Run compass4nfv/deploy.sh virtual_five .
-
-
-Attention:
-Roles here includes controller compute network storage ha odl and onos.
-
-
-
-
-
-How to deploy without internet access
-=====================================
-
-
-If you have created your own ISO file(compass.iso), you realy could deploy without internet access,
-edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path
-(export ISO_URL=file:///compass4nfv/work/building/compass.iso).
-Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access.
-
-
-Also 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.
-After this, edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path.
-Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access.
-
-
-
-
-
-How to integration plugins
-==========================
-
-
-
diff --git a/docs/FAQ/how-to-deploy-without-internet-access.rst b/docs/FAQ/how-to-deploy-without-internet-access.rst
new file mode 100644
index 00000000..6bfcb3de
--- /dev/null
+++ b/docs/FAQ/how-to-deploy-without-internet-access.rst
@@ -0,0 +1,18 @@
+.. two dots create a comment. please leave this logo at the top of each of your rst files.
+
+How to deploy without internet access
+=====================================
+
+If you have created your own ISO file(compass.iso), you realy could deploy without internet access,
+edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path
+(export ISO_URL=file:///compass4nfv/work/building/compass.iso).
+Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access.
+
+
+Also 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.
+After this, edit "compass4nfv/deploy/conf/base.conf" file and assign item ISO_URL as your local ISO file path.
+Then execute "compass4nfv/deploy.sh" and Compass4nfv could deploy with local compass.iso without internet access.
+
+
+
diff --git a/docs/FAQ/how-to-integrate-plugins.rst b/docs/FAQ/how-to-integrate-plugins.rst
new file mode 100644
index 00000000..8e810d7d
--- /dev/null
+++ b/docs/FAQ/how-to-integrate-plugins.rst
@@ -0,0 +1,7 @@
+.. two dots create a comment. please leave this logo at the top of each of your rst files.
+
+How to integrate plugins
+========================
+
+tbd
+
diff --git a/docs/FAQ/index.rst b/docs/FAQ/index.rst
index 0a072875..dfe8de3e 100644
--- a/docs/FAQ/index.rst
+++ b/docs/FAQ/index.rst
@@ -1,6 +1,9 @@
-**********************************
-OPNFV(Brahmaputra) Compass4nfv FAQ
-**********************************
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+
+=========================================================
+OPNFV(Brahmaputra) Compass4nfv Frequently Asked Questions
+=========================================================
Contents:
@@ -8,4 +11,6 @@ Contents:
:numbered:
:maxdepth: 4
- FAQ.rst
+ how-to-build-customized-iso.rst
+ how-to-deploy-without-internet-access.rst
+ how-to-integrate-plugins.rst
diff --git a/docs/installation-instructions/index.rst b/docs/configguide/index.rst
index dc51516e..71ea3127 100644
--- a/docs/installation-instructions/index.rst
+++ b/docs/configguide/index.rst
@@ -5,11 +5,12 @@
OPNFV(Brahmaputra) Compass4nfv installation instructions
********************************************************
-Contents:
-
.. toctree::
:numbered:
:maxdepth: 4
- installation-instructions.rst
+ introduction.rst
+ installerconfig.rst
+ vmdeploy.rst
+ references.rst
diff --git a/docs/configguide/installerconfig.rst b/docs/configguide/installerconfig.rst
index dd4a4333..3d9269a4 100644
--- a/docs/configguide/installerconfig.rst
+++ b/docs/configguide/installerconfig.rst
@@ -1,23 +1,347 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-<Project> configuration
-=======================
-Add a brief introduction to configure OPNFV with this specific installer
+Compass4nfv configuration
+=========================
-Pre-configuration activities
------------------------------
-Describe specific pre-configuration activities. Refer to Installations guide and release notes
+This document describes providing guidelines on how to install and
+configure the Brahmaputra release of OPNFV when using Compass as a
+deployment tool including required software and hardware
+configurations.
-Hardware configuration
------------------------
-Describe the hardware configuration needed for this specific installer
+Installation and configuration of host OS, OpenStack, OpenDaylight,
+ONOS, Ceph etc. can be supported by Compass on VMs or Bare Metal
+nodes.
-Jumphost configuration
------------------------
-Describe intial Jumphost configuration (network and software)needed in order to deploy the installer
+The audience of this document is assumed to have good knowledge in
+networking and Unix/Linux administration.
-Platform components configuration
----------------------------------
-Describe the configuration of each component in the installer
+Preconditions
+=============
+
+Before starting the installation of the Brahmaputra release of OPNFV,
+some planning must be done.
+
+
+Retrieving the installation ISO image
+-------------------------------------
+
+First of all, The installation ISO is needed for deploying your OPNFV
+environment, it included packages of Compass,OpenStack,OpenDaylight,ONOS
+and so on. the iso can be retrieved via OPNFV artifacts repository:
+
+http://artifacts.opnfv.org/
+
+NOTE: Search the keyword "Compass4nfv/Brahmaputra" to locate the ISO image.
+
+E.g.
+compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.iso
+compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.properties
+
+The name of iso image 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.
+
+
+Getting the deployment scripts
+------------------------------
+
+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.
+
+If you don't have a Linux foundation user id, get your own by the url:
+
+https://wiki.opnfv.org/developer/getting_started
+
+Set the branch to the corresponding deployment scripts:
+
+E.g.
+Git sha1 in file "opnfv-2016-01-16_15-03-18.properties" is
+d5a13ce7cc2ce89946d34b0402ecf33c1d291851
+
+- git checkout d5a13ce7cc2ce89946d34b0402ecf33c1d291851
+
+
+Preparing the installation environment
+--------------------------------------
+
+If you have only 1 Bare Metal server, Virtual deployment is recommended. if more
+than or equal 3 servers, the Bare Metal deployment is recommended. The minimum number of
+servers for Bare metal deployment is 3, 1 for JumpServer(Jumphost), 1 for controller,
+1 for compute.
+
+
+Setup Requirements
+==================
+
+Jumphost Requirements
+---------------------
+
+The Jumphost requirements are outlined below:
+
+1. Ubuntu 14.04 (Pre-installed).
+
+2. Root access.
+
+3. libvirt virtualization support.
+
+4. Minimum 2 NICs.
+
+ - PXE installation Network (Receiving PXE request from nodes and providing OS provisioning)
+
+ - IPMI Network (Nodes power control and set boot PXE first via IPMI interface)
+
+ - External Network (Optional: Internet access)
+
+5. 16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a VM deployment.
+
+6. Minimum 100G storage.
+
+Bare Metal Node Requirements
+----------------------------
+
+Bare Metal nodes require:
+
+1. IPMI enabled on OOB interface for power control.
+
+2. BIOS boot priority should be PXE first then local hard disk.
+
+3. Minimum 3 NICs.
+
+ - PXE installation Network (Broadcasting PXE request)
+
+ - IPMI Network (Receiving IPMI command from Jumphost)
+
+ - External Network (OpenStack mgmt/external/storage/tenant network)
+
+Network Requirements
+--------------------
+
+Network requirements include:
+
+1. No DHCP or TFTP server running on networks used by OPNFV.
+
+2. 2-6 separate networks with connectivity between Jumphost and nodes.
+
+ - PXE installation Network
+
+ - IPMI Network
+
+ - Openstack mgmt Network*
+
+ - Openstack external Network*
+
+ - Openstack tenant Network*
+
+ - Openstack 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.
+
+**The networks with(*) can be share one NIC(Default configuration) or use an exclusive**
+**NIC(Reconfigurated in network.yml).**
+
+Execution Requirements (Bare Metal Only)
+----------------------------------------
+
+In order to execute a deployment, one must gather the following information:
+
+1. IPMI IP addresses for the nodes.
+
+2. IPMI login information for the nodes (user/pass).
+
+3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes.
+
+Installation Guide (BM Deployment)
+==================================
+
+Nodes Configuration (BM Deployment)
+-----------------------------------
+
+The bellow file is the inventory template of deployment nodes:
+
+"compass4nfv/deploy/conf/hardware_environment/huawei_us_lab/pod1/dha.yml"
+
+You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
+
+ - ipmiVer -- IPMI interface version for deployment node support. IPMI 1.0
+ or IPMI 2.0 is available.
+
+ - ipmiIP -- IPMI IP address for deployment node. Make sure it can access
+ from Jumphost.
+
+ - ipmiUser -- IPMI Username for deployment node.
+
+ - ipmiPass -- IPMI Password for deployment node.
+
+ - mac -- MAC Address of deployment node PXE NIC .
+
+ - name -- Host name for deployment node after installation.
+
+ - roles -- Components deployed.
+
+
+**Assignment of different roles to servers**
+
+E.g. Openstack only deployment roles setting
+
+.. code-block:: yaml
+
+ hosts:
+ - name: host1
+ roles:
+ - controller
+ - ha
+
+ - name: host2
+ roles:
+ - compute
+
+NOTE:
+IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO.
+
+E.g. Openstack and ceph deployment roles setting
+
+.. code-block:: yaml
+
+ hosts:
+ - name: host1
+ roles:
+ - controller
+ - ha
+ - ceph-admin
+ - ceph-mon
+
+ - name: host2
+ roles:
+ - compute
+ - ceph-osd
+
+E.g. Openstack and ODL deployment roles setting
+
+.. code-block:: yaml
+
+ hosts:
+ - name: host1
+ roles:
+ - controller
+ - ha
+ - odl
+
+ - name: host2
+ roles:
+ - compute
+
+E.g. Openstack and ONOS deployment roles setting
+
+.. code-block:: yaml
+
+ hosts:
+ - name: host1
+ roles:
+ - controller
+ - ha
+ - onos
+
+ - name: host2
+ roles:
+ - compute
+
+
+Network Configuration (BM 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".
+You can write your own reference to it.
+
+**The following figure shows the default network configuration.**
+
+.. code-block:: console
+
+
+ +--+ +--+ +--+
+ | | | | | |
+ | | +------------+ | | | |
+ | +------+ Jumphost +------+ | | |
+ | | +------+-----+ | | | |
+ | | | | | | |
+ | | +------------+ +-----+ |
+ | | | | | |
+ | | +------------+ | | | |
+ | +------+ host1 +------+ | | |
+ | | +------+-----+ | | | |
+ | | | | | | |
+ | | +------------+ +-----+ |
+ | | | | | |
+ | | +------------+ | | | |
+ | +------+ host2 +------+ | | |
+ | | +------+-----+ | | | |
+ | | | | | | |
+ | | +------------+ +-----+ |
+ | | | | | |
+ | | +------------+ | | | |
+ | +------+ host3 +------+ | | |
+ | | +------+-----+ | | | |
+ | | | | | | |
+ | | +------------+ +-----+ |
+ | | | | | |
+ | | | | | |
+ +-++ ++-+ +-++
+ ^ ^ ^
+ | | |
+ | | |
+ +-+-------------------------+ | |
+ | External Network | | |
+ +---------------------------+ | |
+ +-----------------------+---+ |
+ | IPMI Network | |
+ +---------------------------+ |
+ +-------------------------+-+
+ | PXE(Installation) Network |
+ +---------------------------+
+
+
+Start Deployment (BM Deployment)
+--------------------------------
+
+1. Set PXE/Installation NIC for Jumphost. (set eth1 E.g.)
+
+.. code-block:: bash
+
+ export INSTALL_NIC=eth1
+
+2. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
+
+.. code-block:: bash
+
+ export OS_VERSION=trusty
+
+3. Set OpenStack version for deployment nodes. (set liberty E.g.)
+
+.. code-block:: bash
+
+ export OPENSTACK_VERSION=liberty
+
+4. Set ISO image that you want to deploy
+
+.. code-block:: bash
+
+ export ISO_URL=file:///${YOUR_OWN}/compass.iso
+ or
+ export ISO_URL=http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-release.iso
+
+5. Run ``deploy.sh`` with inventory and network configuration
+
+.. code-block:: bash
+
+ ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
diff --git a/docs/configguide/introduction.rst b/docs/configguide/introduction.rst
new file mode 100644
index 00000000..820cb29a
--- /dev/null
+++ b/docs/configguide/introduction.rst
@@ -0,0 +1,29 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
+
+Abstract
+========
+
+This document describes how to install the Brahmaputra release of OPNFV when
+using Compass4nfv as a deployment tool covering it's limitations, dependencies
+and required system resources.
+
+Version history
+===============
+
++--------------------+--------------------+--------------------+---------------------------+
+| **Date** | **Ver.** | **Author** | **Comment** |
+| | | | |
++--------------------+--------------------+--------------------+---------------------------+
+| 2016-01-17 | 1.0.0 | Justin chi | Rewritten for |
+| | | (HUAWEI) | Compass4nfv B release |
++--------------------+--------------------+--------------------+---------------------------+
+| 2015-12-16 | 0.0.2 | Matthew Li | Minor changes & |
+| | | (HUAWEI) | formatting |
++--------------------+--------------------+--------------------+---------------------------+
+| 2015-09-12 | 0.0.1 | Chen Shuai | First draft |
+| | | (HUAWEI) | |
++--------------------+--------------------+--------------------+---------------------------+
+
+
diff --git a/docs/configguide/postinstall.rst b/docs/configguide/postinstall.rst
index 1702cea5..050f77c3 100644
--- a/docs/configguide/postinstall.rst
+++ b/docs/configguide/postinstall.rst
@@ -1,26 +1,32 @@
-<Project> post installation procedures
-======================================
-Add a brief introduction to the methods of validating the installation
-according to this specific installer or feature.
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
-Automated post installation activities
---------------------------------------
-Describe specific post installation activities performed by the OPNFV
-deployment pipeline including testing activities and reports. Refer to
-the relevant testing guides, results, and release notes.
+.. commented as there is no content for this file at this time.
-note: this section should be singular and derived from the test projects
-once we have one test suite to run for all deploy tools. This is not the
-case yet so each deploy tool will need to provide (hopefully very simillar)
-documentation of this.
+.. <Project> post installation procedures
+.. ======================================
+.. Add a brief introduction to the methods of validating the installation
+.. according to this specific installer or feature.
-<Project> post configuration procedures
---------------------------------------
-Describe any deploy tool or feature specific scripts, tests or procedures
-that should be carried out on the deployment post install and configuration
-in this section.
+.. Automated post installation activities
+.. --------------------------------------
+.. Describe specific post installation activities performed by the OPNFV
+.. deployment pipeline including testing activities and reports. Refer to
+.. the relevant testing guides, results, and release notes.
+
+.. note: this section should be singular and derived from the test projects
+.. once we have one test suite to run for all deploy tools. This is not the
+.. case yet so each deploy tool will need to provide (hopefully very simillar)
+.. documentation of this.
+
+.. <Project> post configuration procedures
+.. --------------------------------------
+.. Describe any deploy tool or feature specific scripts, tests or procedures
+.. that should be carried out on the deployment post install and configuration
+.. in this section.
+
+.. Platform components validation
+.. ---------------------------------
+.. Describe any component specific validation procedures necessary for your
+.. deployment tool in this section.
-Platform components validation
----------------------------------
-Describe any component specific validation procedures necessary for your
-deployment tool in this section.
diff --git a/docs/configguide/references.rst b/docs/configguide/references.rst
new file mode 100644
index 00000000..0f317dd5
--- /dev/null
+++ b/docs/configguide/references.rst
@@ -0,0 +1,40 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
+
+References
+==========
+
+OPNFV
+-----
+
+`OPNFV Home Page <www.opnfv.org>`_
+
+`OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_
+
+`OPNFV Compass4nfv project page <https://wiki.opnfv.org/compass4nfv>`_
+
+OpenStack
+---------
+
+`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+
+`OpenStack documentation <http://docs.openstack.org>`_
+
+OpenDaylight
+------------
+
+`OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+
+ONOS
+----
+
+`ONOS artifacts <http://onosproject.org/software/>`_
+
+Compass
+-------
+
+`Compass Home Page <http://www.syscompass.org/>`_
+
+:Authors: Justin Chi (HUAWEI)
+
diff --git a/docs/configguide/vmdeploy.rst b/docs/configguide/vmdeploy.rst
new file mode 100644
index 00000000..a7588845
--- /dev/null
+++ b/docs/configguide/vmdeploy.rst
@@ -0,0 +1,46 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
+
+Installation Guide (VM Deployment)
+==================================
+
+Nodes Configuration (VM Deployment)
+-----------------------------------
+
+Please follow the instructions in section `Installation Guide (BM Deployment)`,
+and no need to set IPMI/PXE/MAC parameters.
+
+Network Configuration (VM Deployment)
+-------------------------------------
+
+Please follow the instructions in section `Installation Guide (BM Deployment)`.
+
+Start Deployment (VM Deployment)
+--------------------------------
+
+1. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
+
+.. code-block:: bash
+
+ export OS_VERSION=trusty
+
+3. Set OpenStack version for deployment nodes. (set liberty E.g.)
+
+.. code-block:: bash
+
+ export OPENSTACK_VERSION=liberty
+
+4. Set ISO image that you want to deploy
+
+.. code-block:: bash
+
+ export ISO_URL=file:///${YOUR_OWN}/compass.iso
+ or
+ export ISO_URL=http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-release.iso
+
+5. Run ``deploy.sh`` with inventory and network configuration
+
+.. code-block:: bash
+
+ ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
diff --git a/docs/how-to-use-compass4nfv/compass4nfv_host_network.png b/docs/how-to-use-compass4nfv/compass4nfv_host_network.png
deleted file mode 100644
index 93ba8c0b..00000000
--- a/docs/how-to-use-compass4nfv/compass4nfv_host_network.png
+++ /dev/null
Binary files differ
diff --git a/docs/how-to-use-compass4nfv/compass4nfv_network_topology.png b/docs/how-to-use-compass4nfv/compass4nfv_network_topology.png
deleted file mode 100644
index 6360b8a5..00000000
--- a/docs/how-to-use-compass4nfv/compass4nfv_network_topology.png
+++ /dev/null
Binary files differ
diff --git a/docs/how-to-use-compass4nfv/index.rst b/docs/how-to-use-compass4nfv/index.rst
deleted file mode 100644
index f4a5bdeb..00000000
--- a/docs/how-to-use-compass4nfv/index.rst
+++ /dev/null
@@ -1,13 +0,0 @@
-*********************
-Compass4nfv Project
-*********************
-
-Contents:
-
-.. toctree::
- :numbered:
- :maxdepth: 4
-
- how-to-use-compass4nfv/documentation-compass4nfv.rst
- how-to-use-compass4nfv/compass4nfv_host_network.png
- how-to-use-compass4nfv/compass4nfv_network_topology.png
diff --git a/docs/installation-instructions/installation-instructions.rst b/docs/installation-instructions/installation-instructions.rst
deleted file mode 100644
index ec2cff54..00000000
--- a/docs/installation-instructions/installation-instructions.rst
+++ /dev/null
@@ -1,455 +0,0 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
-.. http://creativecommons.org/licenses/by/4.0
-.. (c) by Weidong Shao (HUAWEI) and Justin Chi (HUAWEI)
-
-==========================================================================================================
-Installation instructions for the Brahmaputra release of OPNFV when using Compass4nfv as a deployment tool
-==========================================================================================================
-
-
-Abstract
-========
-
-This document describes how to install the Brahmaputra release of OPNFV when
-using Compass4nfv as a deployment tool covering it's limitations, dependencies
-and required system resources.
-
-Version history
-===============
-
-+--------------------+--------------------+--------------------+---------------------------+
-| **Date** | **Ver.** | **Author** | **Comment** |
-| | | | |
-+--------------------+--------------------+--------------------+---------------------------+
-| 2016-01-17 | 1.0.0 | Justin chi | Rewritten for |
-| | | (HUAWEI) | Compass4nfv B release |
-+--------------------+--------------------+--------------------+---------------------------+
-| 2015-12-16 | 0.0.2 | Matthew Li | Minor changes & |
-| | | (HUAWEI) | formatting |
-+--------------------+--------------------+--------------------+---------------------------+
-| 2015-09-12 | 0.0.1 | Chen Shuai | First draft |
-| | | (HUAWEI) | |
-+--------------------+--------------------+--------------------+---------------------------+
-
-Introduction
-============
-
-This document describes providing guidelines on how to install and
-configure the Brahmaputra release of OPNFV when using Compass as a
-deployment tool including required software and hardware
-configurations.
-
-Installation and configuration of host OS, OpenStack, OpenDaylight,
-ONOS, Ceph etc. can be supported by Compass on VMs or Bare Metal
-nodes.
-
-The audience of this document is assumed to have good knowledge in
-networking and Unix/Linux administration.
-
-Preface
-=======
-
-Before starting the installation of the Brahmaputra release of OPNFV,
-some planning must be done.
-
-
-Retrieving the installation ISO image
--------------------------------------
-
-First of all, The installation ISO is needed for deploying your OPNFV
-environment, it included packages of Compass,OpenStack,OpenDaylight,ONOS
-and so on. the iso can be retrieved via OPNFV artifacts repository:
-
-http://artifacts.opnfv.org/
-
-NOTE: Search the keyword "Compass4nfv/Brahmaputra" to locate the ISO image.
-
-E.g.
-compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.iso
-compass4nfv/brahmaputra/opnfv-2016-01-16_15-03-18.properties
-
-The name of iso image 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.
-
-
-Getting the deployment scripts
-------------------------------
-
-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.
-
-If you don't have a Linux foundation user id, get your own by the url:
-
-https://wiki.opnfv.org/developer/getting_started
-
-Set the branch to the corresponding deployment scripts:
-
-E.g.
-Git sha1 in file "opnfv-2016-01-16_15-03-18.properties" is
-d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-
-- git checkout d5a13ce7cc2ce89946d34b0402ecf33c1d291851
-
-
-Preparing the installation environment
---------------------------------------
-
-If you have only 1 Bare Metal server, Virtual deployment is recommended. if more
-than or equal 3 servers, the Bare Metal deployment is recommended. The minimum number of
-servers for Bare metal deployment is 3, 1 for JumpServer(Jumphost), 1 for controller,
-1 for compute.
-
-
-Setup Requirements
-==================
-
-Jumphost Requirements
----------------------
-
-The Jumphost requirements are outlined below:
-
-1. Ubuntu 14.04 (Pre-installed).
-
-2. Root access.
-
-3. libvirt virtualization support.
-
-4. Minimum 2 NICs.
-
- - PXE installation Network (Receiving PXE request from nodes and providing OS provisioning)
-
- - IPMI Network (Nodes power control and set boot PXE first via IPMI interface)
-
- - External Network (Optional: Internet access)
-
-5. 16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a VM deployment.
-
-6. Minimum 100G storage.
-
-Bare Metal Node Requirements
-----------------------------
-
-Bare Metal nodes require:
-
-1. IPMI enabled on OOB interface for power control.
-
-2. BIOS boot priority should be PXE first then local hard disk.
-
-3. Minimum 3 NICs.
-
- - PXE installation Network (Broadcasting PXE request)
-
- - IPMI Network (Receiving IPMI command from Jumphost)
-
- - External Network (OpenStack mgmt/external/storage/tenant network)
-
-Network Requirements
---------------------
-
-Network requirements include:
-
-1. No DHCP or TFTP server running on networks used by OPNFV.
-
-2. 2-6 separate networks with connectivity between Jumphost and nodes.
-
- - PXE installation Network
-
- - IPMI Network
-
- - Openstack mgmt Network*
-
- - Openstack external Network*
-
- - Openstack tenant Network*
-
- - Openstack 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.
-
-**The networks with(*) can be share one NIC(Default configuration) or use an exclusive**
-**NIC(Reconfigurated in network.yml).**
-
-Execution Requirements (Bare Metal Only)
-----------------------------------------
-
-In order to execute a deployment, one must gather the following information:
-
-1. IPMI IP addresses for the nodes.
-
-2. IPMI login information for the nodes (user/pass).
-
-3. MAC address of Control Plane / Provisioning interfaces of the Bare Metal nodes.
-
-
-Installation Guide (BM Deployment)
-==================================
-
-Nodes Configuration
--------------------
-
-The bellow file is the inventory template of deployment nodes:
-
-"compass4nfv/deploy/conf/hardware_environment/huawei_us_lab/pod1/dha.yml"
-
-You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
-
- - ipmiVer -- IPMI interface version for deployment node support. IPMI 1.0
- or IPMI 2.0 is available.
-
- - ipmiIP -- IPMI IP address for deployment node. Make sure it can access
- from Jumphost.
-
- - ipmiUser -- IPMI Username for deployment node.
-
- - ipmiPass -- IPMI Password for deployment node.
-
- - mac -- MAC Address of deployment node PXE NIC .
-
- - name -- Host name for deployment node after installation.
-
- - roles -- Components deployed.
-
-
-**Assignment of different roles to servers**
-
-E.g. Openstack only deployment roles setting
-
-.. code-block:: yaml
-
- hosts:
- - name: host1
- roles:
- - controller
- - ha
-
- - name: host2
- roles:
- - compute
-
-NOTE:
-IF YOU SELECT MUTIPLE NODES AS CONTROLLER, THE 'ha' role MUST BE SELECT, TOO.
-
-E.g. Openstack and ceph deployment roles setting
-
-.. code-block:: yaml
-
- hosts:
- - name: host1
- roles:
- - controller
- - ha
- - ceph-admin
- - ceph-mon
-
- - name: host2
- roles:
- - compute
- - ceph-osd
-
-E.g. Openstack and ODL deployment roles setting
-
-.. code-block:: yaml
-
- hosts:
- - name: host1
- roles:
- - controller
- - ha
- - odl
-
- - name: host2
- roles:
- - compute
-
-E.g. Openstack and ONOS deployment roles setting
-
-.. code-block:: yaml
-
- hosts:
- - name: host1
- roles:
- - controller
- - ha
- - onos
-
- - name: host2
- roles:
- - compute
-
-
-Network Configuration
----------------------
-
-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".
-You can write your own reference to it.
-
-**The following figure shows the default network configuration.**
-
-.. code-block:: console
-
-
- +--+ +--+ +--+
- | | | | | |
- | | +------------+ | | | |
- | +------+ Jumphost +------+ | | |
- | | +------+-----+ | | | |
- | | | | | | |
- | | +------------+ +-----+ |
- | | | | | |
- | | +------------+ | | | |
- | +------+ host1 +------+ | | |
- | | +------+-----+ | | | |
- | | | | | | |
- | | +------------+ +-----+ |
- | | | | | |
- | | +------------+ | | | |
- | +------+ host2 +------+ | | |
- | | +------+-----+ | | | |
- | | | | | | |
- | | +------------+ +-----+ |
- | | | | | |
- | | +------------+ | | | |
- | +------+ host3 +------+ | | |
- | | +------+-----+ | | | |
- | | | | | | |
- | | +------------+ +-----+ |
- | | | | | |
- | | | | | |
- +-++ ++-+ +-++
- ^ ^ ^
- | | |
- | | |
- +-+-------------------------+ | |
- | External Network | | |
- +---------------------------+ | |
- +-----------------------+---+ |
- | IPMI Network | |
- +---------------------------+ |
- +-------------------------+-+
- | PXE(Installation) Network |
- +---------------------------+
-
-
-Start Deployment
-----------------
-
-1. Set PXE/Installation NIC for Jumphost. (set eth1 E.g.)
-
-.. code-block:: bash
-
- export INSTALL_NIC=eth1
-
-2. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
-
-.. code-block:: bash
-
- export OS_VERSION=trusty
-
-3. Set OpenStack version for deployment nodes. (set liberty E.g.)
-
-.. code-block:: bash
-
- export OPENSTACK_VERSION=liberty
-
-4. Set ISO image that you want to deploy
-
-.. code-block:: bash
-
- export ISO_URL=file:///${YOUR_OWN}/compass.iso
- or
- export ISO_URL=http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-release.iso
-
-5. Run ``deploy.sh`` with inventory and network configuration
-
-.. code-block:: bash
-
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
-
-
-Installation Guide (VM Deployment)
-==================================
-
-Nodes Configuration
--------------------
-
-Please follow the instructions in section `Installation Guide (BM Deployment)`,
-and no need to set IPMI/PXE/MAC parameters.
-
-Network Configuration
----------------------
-
-Please follow the instructions in section `Installation Guide (BM Deployment)`.
-
-Start Deployment
-----------------
-
-1. Set OS version for nodes provisioning. (set Ubuntu14.04 E.g.)
-
-.. code-block:: bash
-
- export OS_VERSION=trusty
-
-3. Set OpenStack version for deployment nodes. (set liberty E.g.)
-
-.. code-block:: bash
-
- export OPENSTACK_VERSION=liberty
-
-4. Set ISO image that you want to deploy
-
-.. code-block:: bash
-
- export ISO_URL=file:///${YOUR_OWN}/compass.iso
- or
- export ISO_URL=http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-release.iso
-
-5. Run ``deploy.sh`` with inventory and network configuration
-
-.. code-block:: bash
-
- ./deploy.sh --dha ${YOUR_OWN}/dha.yml --network ${YOUR_OWN}/network.yml
-
-References
-==========
-
-OPNFV
------
-
-`OPNFV Home Page <www.opnfv.org>`_
-
-`OPNFV Genesis project page <https://wiki.opnfv.org/get_started>`_
-
-`OPNFV Compass4nfv project page <https://wiki.opnfv.org/compass4nfv>`_
-
-OpenStack
----------
-
-`OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
-
-`OpenStack documentation <http://docs.openstack.org>`_
-
-OpenDaylight
-------------
-
-`OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
-
-ONOS
-----
-
-`ONOS artifacts <http://onosproject.org/software/>`_
-
-Compass
--------
-
-`Compass Home Page <http://www.syscompass.org/>`_
-
-:Authors: Justin Chi (HUAWEI)
-
diff --git a/docs/release-notes/release-notes.rst b/docs/release-notes/release-notes.rst
index df055d5f..9c4267a4 100644
--- a/docs/release-notes/release-notes.rst
+++ b/docs/release-notes/release-notes.rst
@@ -7,18 +7,17 @@ Release Note for the Brahmaputra release of OPNFV when using Compass4nfv as a de
=============================================================================================
-.. toctree::
- :maxdepth: 2
-
Abstract
========
This document describes release notes of OPNFV when using Compass4nfv as a
-deployment tool.
+deployment tool covering it's features, limitations and required system resources.
Introduction
============
+Compass4nfv is an OPNFV installer project based on open source project Compass,
+which provides automated deployment and management of OpenStack and other distributed systems.
Provide a brief introduction of how this release is used in OPNFV release using <XYZ> as a deployment tool
Be sure to reference your installation-instructions.
@@ -27,19 +26,19 @@ Release Data
============
+--------------------------------------+--------------------------------------+
-| **Project** | |
+| **Project** | Compass4nfv |
| | |
+--------------------------------------+--------------------------------------+
-| **Repo/tag** | |
+| **Repo/tag** | Compass4nfv/Brahmaputra.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release designation** | |
+| **Release designation** | Brahmaputra.1.0 |
| | |
+--------------------------------------+--------------------------------------+
-| **Release date** | |
+| **Release date** | 2016.2.25 |
| | |
+--------------------------------------+--------------------------------------+
-| **Purpose of the delivery** | |
+| **Purpose of the delivery** | OPNFV Brahmaputra release |
| | |
+--------------------------------------+--------------------------------------+
@@ -48,11 +47,28 @@ Deliverables
Software deliverables
~~~~~~~~~~~~~~~~~~~~~
-<XYZ>-based installer iso file <iso file version>
+
+ - Deployment Script
+
+ It is a part of Compass4nfv repository, the entry of deployment sctripts is "compass4nfv/deploy.sh",
+ to retrieve the repository of Compass4nfv by following command:
+
+ git clone https://gerrit.opnfv.org/gerrit/compass4nfv
+
+ - `Compass4nfv ISO link <http://artifacts.opnfv.org/compass4nfv/brahmaputra/opnfv-2016-02-17_14-01-01.iso>`_
+
+.. This link will be updated at final release.
+
+.. _document-label:
Documentation deliverables
~~~~~~~~~~~~~~~~~~~~~~~~~~
--
+
+ - `Installation Instructions <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_installation-instructions/index.html>`_
+
+ - `Release Notes <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_release-notes/index.html>`_
+
+ - `FAQ <http://artifacts.opnfv.org/compass4nfv/brahmaputra/docs/Brahmaputra_FAQ/index.html>`_
Version change
--------------
@@ -61,25 +77,42 @@ Version change
Module version change
~~~~~~~~~~~~~~~~~~~~~
+This is the first release of compass4nfv as a deployment toolchain in OPNFV, the following
+upstream components supported with this release.
+
+ - Ubuntu 14.04.3
+
+ - Openstack Liberty
+
+ - Opendaylight
+
+ - ONOS Emu
+
Document version change
~~~~~~~~~~~~~~~~~~~~~~~
+None due to first release, and you can see document :ref:`document-label`.
+
Reason for new version
----------------------
Feature additions
~~~~~~~~~~~~~~~~~
-+--------------------------------------+--------------------------------------+
-| **JIRA REFERENCE** | **SLOGAN** |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: | |
-| | |
-+--------------------------------------+--------------------------------------+
-| JIRA: | |
-| | |
-+--------------------------------------+--------------------------------------+
++--------------------------------------+-----------------------------------------+
+| **JIRA REFERENCE** | **SLOGAN** |
+| | |
++--------------------------------------+-----------------------------------------+
+| JIRA: COMPASS-34 | Support OpenStack Liberty deployment |
+| | |
++--------------------------------------+-----------------------------------------+
+| JIRA: COMPASS-307 | Integration OpenDaylight Beryllium |
+| | |
++--------------------------------------+-----------------------------------------+
+| JIRA: | |
+| | |
++--------------------------------------+-----------------------------------------+
+
Bug corrections
~~~~~~~~~~~~~~~
@@ -121,8 +154,9 @@ See JIRA: <link>
Test Result
===========
-Brahmaputra test result using <XYZ> as deployment tool.
-<link>
+Brahmaputra test result using <Compass4nfv> as deployment tool.
+
+ - `Functest test result <http://artifacts.opnfv.org/functest/docs/results/overview.html>`_
References
==========