Jira: DAISY-36 Update doc structure

This PS update doc structure according to [1].

Note: This PS also add content to doc for describing the
mapping methods for map role to discovered nodes.

[1] http://docs.opnfv.org/en/stable-danube/how-to-use-docs/documentation-guide.html?highlight=templates#document-structure-and-contribution

Change-Id: I7b2ef916753cddd8cd845abae8c7d5865c49e1ac
Signed-off-by: Zhijiang Hu <hu.zhijiang@zte.com.cn>

5 files changed, 509 insertions, 0 deletions

diff --git a/docs/release/installation/bmdeploy.rst b/docs/release/installation/bmdeploy.rst
new file mode 100644
index 00000000..47a8e121
--- /dev/null
+++ b/docs/release/installation/bmdeploy.rst
@@ -0,0 +1,150 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation Guide (Bare Metal Deployment)
+==========================================
+
+Nodes Configuration (Bare Metal Deployment)
+-------------------------------------------
+
+The below file is the inventory template of deployment nodes:
+
+"./deploy/config/bm_environment/zte-baremetal1/deploy.yml"
+
+You can write your own name/roles reference into it.
+
+        - name -- Host name for deployment node after installation.
+
+        - roles -- Components deployed. CONTROLLER_LB is for Controller,
+COMPUTER is for Compute role. Currently only these two role is supported.
+The first CONTROLLER_LB is also used for ODL controller. 3 hosts in
+inventory will be chosen to setup the Ceph storage cluster.
+
+**Set TYPE and FLAVOR**
+
+E.g.
+
+.. code-block:: yaml
+
+    TYPE: virtual
+    FLAVOR: cluster
+
+**Assignment of different roles to servers**
+
+E.g. OpenStack only deployment roles setting
+
+.. code-block:: yaml
+
+    hosts:
+      - name: host1
+        roles:
+          - CONTROLLER_LB
+      - name: host2
+        roles:
+          - COMPUTER
+      - name: host3
+        roles:
+          - COMPUTER
+
+
+NOTE:
+For B/M, Daisy uses MAC address defined in deploy.yml to map discovered nodes to node items definition in deploy.yml, then assign role described by node item to the discovered nodes by name pattern. Currently, controller01, controller02, and controller03 will be assigned with Controler role while computer01, 'computer02, computer03, and computer04 will be assigned with Compute role.
+
+NOTE:
+For V/M, There is no MAC address defined in deploy.yml for each virtual machine. Instead, Daisy will fill that blank by getting MAC from "virsh dump-xml".
+
+
+Network Configuration (Bare Metal Deployment)
+------------------------------------------
+
+Before deployment, there are some network configurations to be checked based
+on your network topology. The default network configuration file for Daisy is
+"./deploy/config/bm_environment/zte-baremetal1/network.yml".
+You can write your own reference into it.
+
+**The following figure shows the default network configuration.**
+
+.. code-block:: console
+
+
+    +-B/M--------+------------------------------+
+    |Jumperserver+                              |
+    +------------+                       +--+   |
+    |                                    |  |   |
+    |                +-V/M--------+      |  |   |
+    |                | Daisyserver+------+  |   |
+    |                +------------+      |  |   |
+    |                                    |  |   |
+    +------------------------------------|  |---+
+                                         |  |
+                                         |  |
+          +--+                           |  |
+          |  |       +-B/M--------+      |  |
+          |  +-------+ Controller +------+  |
+          |  |       | ODL(Opt.)  |      |  |
+          |  |       | Network    |      |  |
+          |  |       | CephOSD1   |      |  |
+          |  |       +------------+      |  |
+          |  |                           |  |
+          |  |                           |  |
+          |  |                           |  |
+          |  |       +-B/M--------+      |  |
+          |  +-------+  Compute1  +------+  |
+          |  |       |  CephOSD2  |      |  |
+          |  |       +------------+      |  |
+          |  |                           |  |
+          |  |                           |  |
+          |  |                           |  |
+          |  |       +-B/M--------+      |  |
+          |  +-------+  Compute2  +------+  |
+          |  |       |  CephOSD3  |      |  |
+          |  |       +------------+      |  |
+          |  |                           |  |
+          |  |                           |  |
+          |  |                           |  |
+          +--+                           +--+
+            ^                             ^
+            |                             |
+            |                             |
+           /---------------------------\  |
+           |      External Network     |  |
+           \---------------------------/  |
+                  /-----------------------+---\
+                  |    Installation Network   |
+                  |    Public/Private API     |
+                  |      Internet Access      |
+                  |      Tenant Network       |
+                  |     Storage Network       |
+                  |     HeartBeat Network     |
+                  \---------------------------/
+
+
+
+
+Note:
+For Flat External networks(which is used by default), a physical interface is needed on each compute node for ODL NetVirt recent versions.
+HeartBeat network is selected,and if it is configured in network.yml,the keepalived interface will be the heartbeat interface.
+
+Start Deployment (Bare Metal Deployment)
+----------------------------------------
+
+(1) Git clone the latest daisy4nfv code from opnfv: "git clone https://gerrit.opnfv.org/gerrit/daisy"
+
+(2) Download latest bin file(such as opnfv-2017-06-06_23-00-04.bin) of daisy from http://artifacts.opnfv.org/daisy.html and change the bin file name(such as opnfv-2017-06-06_23-00-04.bin) to opnfv.bin
+
+(3) Make sure the opnfv.bin file is in daisy4nfv code dir
+
+(4) Create folder of labs/zte/pod2/daisy/config in daisy4nfv code dir
+
+(5) Move the ./deploy/config/bm_environment/zte-baremetal1/deploy.yml and ./deploy/config/bm_environment/zte-baremetal1/network.yml to labs/zte/pod2/daisy/config dir.
+
+(6) Config the bridge in jumperserver,make sure the daisy vm can connect to the targetnode,use the command below:
+brctl addbr br7
+brctl addif br7 enp3s0f3(the interface for jumperserver to connect to daisy vm)
+ifconfig br7 10.20.7.1 netmask 255.255.255.0 up
+service network restart
+
+(7) Run the script deploy.sh in daisy/ci/deploy/ with command:
+sudo ./ci/deploy/deploy.sh -b ../daisy  -l zte -p pod2 -s os-nosdn-nofeature-noha
+
+(8) When deploy successfully,the floating ip of openstack is 10.20.7.11,the login account is "admin" and the password is "keystone"
diff --git a/docs/release/installation/index.rst b/docs/release/installation/index.rst
new file mode 100644
index 00000000..8c5a3da7
--- /dev/null
+++ b/docs/release/installation/index.rst
@@ -0,0 +1,18 @@
+.. _daisy-installation:
+
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+**********************************
+OPNFV Daisy4nfv Installation Guide
+**********************************
+
+.. toctree::
+      :numbered:
+   :maxdepth: 4
+
+   introduction.rst
+   installation_guide.rst
+   bmdeploy.rst
+   vmdeploy.rst
+
diff --git a/docs/release/installation/installation_guide.rst b/docs/release/installation/installation_guide.rst
new file mode 100644
index 00000000..5afd73aa
--- /dev/null
+++ b/docs/release/installation/installation_guide.rst
@@ -0,0 +1,168 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Daisy4nfv configuration
+=======================
+
+This document provides guidelines on how to install and configure the Danube
+release of OPNFV when using Daisy as a deployment tool including required
+software and hardware configurations.
+
+Installation and configuration of host OS, OpenStack etc. can be supported by
+Daisy on Virtual nodes and Bare Metal nodes.
+
+The audience of this document is assumed to have good knowledge in
+networking and Unix/Linux administration.
+
+Prerequisites
+-------------
+
+Before starting the installation of the Danube release of OPNFV, some plannings
+must be done.
+
+
+Retrieve the installation bin image
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+First of all, the installation bin which includes packages of Daisy, OS,
+OpenStack, and so on is needed for deploying your OPNFV environment.
+
+The stable release bin image can be retrieved via `OPNFV software download page <https://www.opnfv.org/software>`_
+
+The daily build bin image can be retrieved via OPNFV artifact repository:
+
+http://artifacts.opnfv.org/daisy.html
+
+NOTE: Search the keyword "daisy/Danube" to locate the bin image.
+
+E.g.
+daisy/opnfv-gerrit-27155.bin
+
+The git url and sha1 of bin image are recorded in properties files.
+According to these, the corresponding deployment scripts can be retrieved.
+
+
+Retrieve the deployment scripts
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+To retrieve the repository of Daisy on Jumphost use the following command:
+
+- git clone https://gerrit.opnfv.org/gerrit/daisy
+
+To get stable Danube release, you can use the following command:
+
+- git checkout danube.1.0
+
+
+Setup Requirements
+------------------
+
+If you have only 1 Bare Metal server, Virtual deployment is recommended. if you have more
+than 3 servers, the Bare Metal deployment is recommended. The minimum number of
+servers for each role in Bare metal deployment is listed below.
+
++------------+------------------------+
+| **Role**   | **Number of Servers**  |
+|            |                        |
++------------+------------------------+
+| Jump Host  | 1                      |
+|            |                        |
++------------+------------------------+
+| Controller | 1                      |
+|            |                        |
++------------+------------------------+
+| Compute    | 1                      |
+|            |                        |
++------------+------------------------+
+
+
+Jumphost Requirements
+~~~~~~~~~~~~~~~~~~~~~
+
+The Jumphost requirements are outlined below:
+
+1.     CentOS 7.2 (Pre-installed).
+
+2.     Root access.
+
+3.     Libvirt virtualization support(For virtual deployment).
+
+4.     Minimum 1 NIC(or 2 NICs for virtual deployment).
+
+       -  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)
+
+       -  Internet access (For getting latest OS updates)
+
+       -  External Interface(For virtual deployment, exclusively used by instance traffic to access the rest of the Internet)
+
+5.     16 GB of RAM for a Bare Metal deployment, 64 GB of RAM for a Virtual deployment.
+
+6.     CPU cores: 32, Memory: 64 GB, Hard Disk: 500 GB, (Virtual deployment needs 1 TB Hard Disk)
+
+
+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 1 NIC for Compute nodes, 2 NICs for Controller nodes.
+
+       -  PXE installation Network (Broadcasting PXE request)
+
+       -  IPMI Network (Receiving IPMI command from Jumphost)
+
+       -  Internet access (For getting latest OS updates)
+
+       -  External Interface(For virtual deployment, exclusively used by instance traffic to access the rest of the Internet)
+
+
+
+
+Network Requirements
+--------------------
+
+Network requirements include:
+
+1.     No DHCP or TFTP server running on networks used by OPNFV.
+
+2.     2-7 separate networks with connectivity between Jumphost and nodes.
+
+       -  PXE installation Network
+
+       -  IPMI Network
+
+       -  Internet access Network
+
+       -  OpenStack Public API Network
+
+       -  OpenStack Private API Network
+
+       -  OpenStack External Network
+
+       -  OpenStack Tenant Network(currently, VxLAN only)
+
+
+3.     Lights out OOB network access from Jumphost with IPMI node enabled (Bare Metal deployment only).
+
+4.     Internet access Network has Internet access, meaning a gateway and DNS availability.
+
+5.     OpenStack External Network has Internet access too if you want instances to access the Internet.
+
+Note: **All networks except OpenStack External Network can 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 of the nodes.
+
+2.     IPMI login information for the nodes (user/password).
diff --git a/docs/release/installation/introduction.rst b/docs/release/installation/introduction.rst
new file mode 100644
index 00000000..4781ab7d
--- /dev/null
+++ b/docs/release/installation/introduction.rst
@@ -0,0 +1,23 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+
+Abstract
+========
+
+This document describes how to install the Danube release of OPNFV when using
+Daisy4nfv as a deployment tool covering it's limitations, dependencies and
+required resources.
+
+Version history
+===============
+
++--------------------+--------------------+--------------------+---------------------------+
+| **Date**           | **Ver.**           | **Author**         | **Comment**               |
+|                    |                    |                    |                           |
++--------------------+--------------------+--------------------+---------------------------+
+| 2017-02-07         | 0.0.1              | Zhijiang Hu        | Initial version           |
+|                    |                    | (ZTE)              |                           |
++--------------------+--------------------+--------------------+---------------------------+
+
+
+
diff --git a/docs/release/installation/vmdeploy.rst b/docs/release/installation/vmdeploy.rst
new file mode 100644
index 00000000..3812a40e
--- /dev/null
+++ b/docs/release/installation/vmdeploy.rst
@@ -0,0 +1,150 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International Licence.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation Guide (Virtual Deployment)
+=======================================
+
+Nodes Configuration (Virtual Deployment)
+----------------------------------------
+
+The below file is the inventory template of deployment nodes:
+
+"./deploy/conf/vm_environment/zte-virtual1/deploy.yml"
+
+You can write your own name/roles reference into it.
+
+        - name -- Host name for deployment node after installation.
+
+        - roles -- Components deployed.
+
+**Set TYPE and FLAVOR**
+
+E.g.
+
+.. code-block:: yaml
+
+    TYPE: virtual
+    FLAVOR: cluster
+
+**Assignment of different roles to servers**
+
+E.g. OpenStack only deployment roles setting
+
+.. code-block:: yaml
+
+    hosts:
+      - name: host1
+        roles:
+          - controller
+
+      - name: host2
+        roles:
+          - compute
+
+NOTE:
+For B/M, Daisy uses MAC address defined in deploy.yml to map discovered nodes to node items definition in deploy.yml, then assign role described by node item to the discovered nodes by name pattern. Currently, controller01, controller02, and controller03 will be assigned with Controler role while computer01, 'computer02, computer03, and computer04 will be assigned with Compute role.
+
+NOTE:
+For V/M, There is no MAC address defined in deploy.yml for each virtual machine. Instead, Daisy will fill that blank by getting MAC from "virsh dump-xml".
+
+E.g. OpenStack and ceph deployment roles setting
+
+.. code-block:: yaml
+
+    hosts:
+      - name: host1
+        roles:
+          - controller
+
+      - name: host2
+        roles:
+          - compute
+
+Network Configuration (Virtual Deployment)
+------------------------------------------
+
+Before deployment, there are some network configurations to be checked based
+on your network topology. The default network configuration file for Daisy is
+"daisy/deploy/config/vm_environment/zte-virtual1/network.yml".
+You can write your own reference into it.
+
+**The following figure shows the default network configuration.**
+
+.. code-block:: console
+
+
+    +-B/M--------+------------------------------+
+    |Jumperserver+                              |
+    +------------+                       +--+   |
+    |                                    |  |   |
+    |                +-V/M--------+      |  |   |
+    |                | Daisyserver+------+  |   |
+    |                +------------+      |  |   |
+    |                                    |  |   |
+    |     +--+                           |  |   |
+    |     |  |       +-V/M--------+      |  |   |
+    |     |  +-------+ Controller +------+  |   |
+    |     |  |       | ODL(Opt.)  |      |  |   |
+    |     |  |       | Network    |      |  |   |
+    |     |  |       | Ceph1      |      |  |   |
+    |     |  |       +------------+      |  |   |
+    |     |  |                           |  |   |
+    |     |  |                           |  |   |
+    |     |  |                           |  |   |
+    |     |  |       +-V/M--------+      |  |   |
+    |     |  +-------+  Compute1  +------+  |   |
+    |     |  |       |  Ceph2     |      |  |   |
+    |     |  |       +------------+      |  |   |
+    |     |  |                           |  |   |
+    |     |  |                           |  |   |
+    |     |  |                           |  |   |
+    |     |  |       +-V/M--------+      |  |   |
+    |     |  +-------+  Compute2  +------+  |   |
+    |     |  |       |  Ceph3     |      |  |   |
+    |     |  |       +------------+      |  |   |
+    |     |  |                           |  |   |
+    |     |  |                           |  |   |
+    |     |  |                           |  |   |
+    |     +--+                           +--+   |
+    |       ^                             ^     |
+    |       |                             |     |
+    |       |                             |     |
+    |      /---------------------------\  |     |
+    |      |      External Network     |  |     |
+    |      \---------------------------/  |     |
+    |             /-----------------------+---\ |
+    |             |    Installation Network   | |
+    |             |    Public/Private API     | |
+    |             |      Internet Access      | |
+    |             |      Tenant Network       | |
+    |             |     Storage Network       | |
+    |             |     HeartBeat Network     | |
+    |             \---------------------------/ |
+    +-------------------------------------------+
+
+
+
+Note:
+For Flat External networks(which is used by default), a physical interface is needed on each compute node for ODL NetVirt recent versions.
+HeartBeat network is selected,and if it is configured in network.yml,the keepalived interface will be the heartbeat interface.
+
+Start Deployment (Virtual Deployment)
+-------------------------------------
+
+(1) Git clone the latest daisy4nfv code from opnfv: "git clone https://gerrit.opnfv.org/gerrit/daisy"
+
+(2) Download latest bin file(such as opnfv-2017-06-06_23-00-04.bin) of daisy from http://artifacts.opnfv.org/daisy.html and change the bin file name(such as opnfv-2017-06-06_23-00-04.bin) to opnfv.bin
+
+(3) Make sure the opnfv.bin file is in daisy4nfv code dir
+
+(4) Create folder of labs/zte/virtual1/daisy/config in daisy4nfv code dir
+
+(5) Move the daisy/deploy/config/vm_environment/zte-virtual1/deploy.yml and daisy/deploy/config/vm_environment/zte-virtual1/network.yml to labs/zte/virtual1/daisy/config dir.
+
+Note:
+zte-virtual1 config file is just for all-in-one deployment,if you want to deploy openstack with five node(1 lb node and 4 computer nodes),change the zte-virtual1 to zte-virtual2
+
+(6) Run the script deploy.sh in daisy/ci/deploy/ with command:
+sudo ./ci/deploy/deploy.sh -b ../daisy  -l zte -p virtual1 -s os-nosdn-nofeature-noha
+
+(7) When deploy successfully,the floating ip of openstack is 10.20.11.11,the login account is "admin" and the password is "keystone"