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>

diff --git a/docs/developer/design/index.rst b/docs/development/design/index.rst
similarity index 100%
rename from docs/developer/design/index.rst
rename to docs/development/design/index.rst

diff --git a/docs/developer/design/multicast.rst b/docs/development/design/multicast.rst
similarity index 100%
rename from docs/developer/design/multicast.rst
rename to docs/development/design/multicast.rst

diff --git a/docs/developer/spec/multicast.rst b/docs/development/requirements/multicast.rst
similarity index 100%
rename from docs/developer/spec/multicast.rst
rename to docs/development/requirements/multicast.rst

diff --git a/docs/configurationguide/index.rst b/docs/release/configguide/index.rst
similarity index 100%
rename from docs/configurationguide/index.rst
rename to docs/release/configguide/index.rst

diff --git a/docs/configurationguide/installerconfig.rst b/docs/release/configguide/installerconfig.rst
similarity index 100%
rename from docs/configurationguide/installerconfig.rst
rename to docs/release/configguide/installerconfig.rst

diff --git a/docs/installationprocedure/bmdeploy.rst b/docs/release/installation/bmdeploy.rst
similarity index 88%
rename from docs/installationprocedure/bmdeploy.rst
rename to docs/release/installation/bmdeploy.rst
index 3879029..47a8e12 100644 (file)
--- a/docs/installationprocedure/bmdeploy.rst
+++ b/docs/release/installation/bmdeploy.rst
@@ -46,8 +46,13 @@ E.g. OpenStack only deployment roles setting
         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:
-WE JUST SUPPORT ONE CONTROLLER NODE NOW.
+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)
 ------------------------------------------
@@ -116,7 +121,8 @@ You can write your own reference into it.
 
 
 
-Note: For Flat External networks(which is used by default), a physical interface is needed on each compute node for ODL NetVirt recent versions.
+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)

diff --git a/docs/installationprocedure/index.rst b/docs/release/installation/index.rst
similarity index 100%
rename from docs/installationprocedure/index.rst
rename to docs/release/installation/index.rst

diff --git a/docs/installationprocedure/installation_guide.rst b/docs/release/installation/installation_guide.rst
similarity index 100%
rename from docs/installationprocedure/installation_guide.rst
rename to docs/release/installation/installation_guide.rst

diff --git a/docs/installationprocedure/introduction.rst b/docs/release/installation/introduction.rst
similarity index 100%
rename from docs/installationprocedure/introduction.rst
rename to docs/release/installation/introduction.rst

diff --git a/docs/installationprocedure/vmdeploy.rst b/docs/release/installation/vmdeploy.rst
similarity index 85%
rename from docs/installationprocedure/vmdeploy.rst
rename to docs/release/installation/vmdeploy.rst
index 2ed6b00..3812a40 100644 (file)
--- a/docs/installationprocedure/vmdeploy.rst
+++ b/docs/release/installation/vmdeploy.rst
@@ -42,7 +42,10 @@ E.g. OpenStack only deployment roles setting
           - compute
 
 NOTE:
-WE JUST SUPPORT ONE CONTROLLER NODE NOW.
+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
 
@@ -121,7 +124,8 @@ You can write your own reference into it.
 
 
 
-Note: For Flat External networks(which is used by default), a physical interface is needed on each compute node for ODL NetVirt recent versions.
+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)
@@ -136,7 +140,9 @@ Start Deployment (Virtual Deployment)
 (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.
-Notes: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
+
+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

diff --git a/docs/releasenotes/index.rst b/docs/release/release-notes/index.rst
similarity index 100%
rename from docs/releasenotes/index.rst
rename to docs/release/release-notes/index.rst

diff --git a/docs/releasenotes/release-notes.rst b/docs/release/release-notes/release-notes.rst
similarity index 100%
rename from docs/releasenotes/release-notes.rst
rename to docs/release/release-notes/release-notes.rst