aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJustin-chi <chigang@huawei.com>2016-01-22 17:31:30 +0800
committerJustin chi <chigang@huawei.com>2016-02-17 08:38:33 +0000
commitc3f89eca0c74f587f833c5884aa7f1b3d96827c3 (patch)
tree463e95610be3803257a41bb31fe2db6c7afd1335
parentfc50d4a2fac61355019a7cffbef21e96a3423fce (diff)
Document update for Brahmaputra release(WIP)
Add Network configuration for deploy Change-Id: Ief7863b3c4764949f31bca9e1a4c8aaea5306f8f Signed-off-by: Justin-chi <chigang@huawei.com>
-rw-r--r--docs/FAQ/FAQ.rst90
-rw-r--r--docs/installation-instructions/installation-instructions.rst66
2 files changed, 147 insertions, 9 deletions
diff --git a/docs/FAQ/FAQ.rst b/docs/FAQ/FAQ.rst
index e32bd503..b5ea05f8 100644
--- a/docs/FAQ/FAQ.rst
+++ b/docs/FAQ/FAQ.rst
@@ -31,10 +31,100 @@ 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/installation-instructions/installation-instructions.rst b/docs/installation-instructions/installation-instructions.rst
index 7fc3135a..ec2cff54 100644
--- a/docs/installation-instructions/installation-instructions.rst
+++ b/docs/installation-instructions/installation-instructions.rst
@@ -7,10 +7,6 @@ Installation instructions for the Brahmaputra release of OPNFV when using Compas
==========================================================================================================
-.. contents:: Table of Contents
- :backlinks: none
-
-
Abstract
========
@@ -53,8 +49,8 @@ networking and Unix/Linux administration.
Preface
=======
-Before starting the installation of the Brahmaputra release of OPNFV
-when using Compass4nfv as a deployment tool, some planning must be done.
+Before starting the installation of the Brahmaputra release of OPNFV,
+some planning must be done.
Retrieving the installation ISO image
@@ -72,7 +68,8 @@ 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.
+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.
@@ -103,8 +100,9 @@ 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 of Bare Metal
-deployment server is 3, 1 for JumpServer(Jumphost), 1 for controller, 1 for computer.
+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
@@ -218,6 +216,9 @@ You can write your own IPMI IP/User/Password/Mac address/roles reference to it.
- roles -- Components deployed.
+
+**Assignment of different roles to servers**
+
E.g. Openstack only deployment roles setting
.. code-block:: yaml
@@ -290,6 +291,53 @@ Before deployment, there are some network configuration to be checked based on y
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
----------------