Merge "docs: Add network layout example diagrams"

6 files changed, 65 insertions, 26 deletions

diff --git a/docs/release/installation/img/README.rst b/docs/release/installation/img/README.rst
new file mode 100644
index 000000000..bc8d9bede
--- /dev/null
+++ b/docs/release/installation/img/README.rst
@@ -0,0 +1,12 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. SPDX-License-Identifier: CC-BY-4.0
+.. (c) 2017 Ericsson AB, Mirantis Inc., Enea AB and others.
+
+Image Editor
+============
+All files in this directory have been created using `draw.io <http://draw.io>`_.
+
+Image Sources
+=============
+Image sources are embedded in each `png` file.
+To edit an image, import the `png` file using `draw.io <http://draw.io>`_.
diff --git a/docs/release/installation/img/arm_pod5.png b/docs/release/installation/img/arm_pod5.png
new file mode 100644
index 000000000..4d38f808f
--- /dev/null
+++ b/docs/release/installation/img/arm_pod5.png
diff --git a/docs/release/installation/img/fuel_baremetal.png b/docs/release/installation/img/fuel_baremetal.png
new file mode 100644
index 000000000..3ef534d36
--- /dev/null
+++ b/docs/release/installation/img/fuel_baremetal.png
diff --git a/docs/release/installation/img/fuel_virtual.png b/docs/release/installation/img/fuel_virtual.png
new file mode 100644
index 000000000..d7664865d
--- /dev/null
+++ b/docs/release/installation/img/fuel_virtual.png
diff --git a/docs/release/installation/img/lf_pod2.png b/docs/release/installation/img/lf_pod2.png
new file mode 100644
index 000000000..bc4ab5f84
--- /dev/null
+++ b/docs/release/installation/img/lf_pod2.png
diff --git a/docs/release/installation/installation.instruction.rst b/docs/release/installation/installation.instruction.rst
index d48ca3032..88ca180bb 100644
--- a/docs/release/installation/installation.instruction.rst
+++ b/docs/release/installation/installation.instruction.rst
@@ -219,6 +219,12 @@ For virtual deploys all the targets are VMs on the Jumpserver. The deploy script
    - Install Openstack on the targets
       - Leverage Salt to install & configure Openstack services
 
+.. figure:: img/fuel_virtual.png
+   :align: center
+   :alt: Fuel@OPNFV Virtual POD Network Layout Examples
+
+   Fuel@OPNFV Virtual POD Network Layout Examples
+
 
 Automatic Installation of a Baremetal POD
 =========================================
@@ -237,6 +243,12 @@ The installation is done automatically with the deploy script, which will:
       - Leverage Salt to configure the operatign system on the baremetal nodes
       - Leverage Salt to install & configure Openstack services
 
+.. figure:: img/fuel_baremetal.png
+   :align: center
+   :alt: Fuel@OPNFV Baremetal POD Network Layout Example
+
+   Fuel@OPNFV Baremetal POD Network Layout Example
+
 
 Steps to Start the Automatic Deploy
 ===================================
@@ -271,49 +283,64 @@ These steps are common both for virtual and baremetal deploys.
 
        $ ci/deploy.sh -l <lab_name> \
                       -p <pod_name> \
-                      -b <URI to the PDF file> \
+                      -b <URI to configuration repo containing the PDF file> \
                       -s <scenario> \
-                      -B <list of admin, public and management bridges>
+                      -B <list of admin, management, private and public bridges>
 
 Examples
 --------
 #. Virtual deploy
 
-To start a virtual deployment, it is required to have the `virtual` keyword while specifying the pod name
-to the installer script. It will create the required bridges and networks, configure Salt Master and install
-OpenStack.
+   To start a virtual deployment, it is required to have the `virtual` keyword
+   while specifying the pod name to the installer script.
 
-   .. code-block:: bash
+   It will create the required bridges and networks, configure Salt Master and
+   install OpenStack.
+
+      .. code-block:: bash
 
-      $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
-                     -l ericsson \
-                     -p virtual_kvm \
-                     -s os-nosdn-nofeature-noha
+         $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
+                        -l ericsson \
+                        -p virtual_kvm \
+                        -s os-nosdn-nofeature-noha
 
-Once the deployment is complete, OpenStack Dashboard, Horizon is available at http://10.16.0.101:8078
-The administrator credentials are **admin** / **opnfv_secret**.
+   Once the deployment is complete, the OpenStack Dashboard, Horizon is
+   available at http://<controller VIP>:8078, e.g. http://10.16.0.101:8078.
+   The administrator credentials are **admin** / **opnfv_secret**.
 
 #. Baremetal deploy
 
-A x86 deploy on pod1 from Ericsson lab
+   A x86 deploy on pod2 from Linux Foundation lab
 
-   .. code-block:: bash
+      .. code-block:: bash
 
-      $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
-                     -l ericsson \
-                     -p pod1 \
-                     -s os-nosdn-nofeature-ha \
-                     -B pxebr
+          $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
+                         -l lf \
+                         -p pod2 \
+                         -s os-nosdn-nofeature-ha \
+                         -B pxebr,br-ctl
 
-An aarch64 deploy on pod5 from Arm lab
+      .. figure:: img/lf_pod2.png
+         :align: center
+         :alt: Fuel@OPNFV LF POD2 Network Layout
 
-   .. code-block:: bash
+         Fuel@OPNFV LF POD2 Network Layout
+
+   An aarch64 deploy on pod5 from Arm lab
+
+      .. code-block:: bash
+
+         $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
+                        -l arm \
+                        -p pod5 \
+                        -s os-nosdn-nofeature-ha \
+                        -B admin7_br0,mgmt7_br0,,public7_br0
+
+      .. figure:: img/arm_pod5.png
+         :align: center
+         :alt: Fuel@OPNFV ARM POD5 Network Layout
 
-      $ ci/deploy.sh -b file:///home/jenkins/tmpdir/securedlab \
-                     -l arm \
-                     -p pod5 \
-                     -s os-nosdn-nofeature-ha \
-                     -B pxebr
+         Fuel@OPNFV ARM POD5 Network Layout
 
 
 =============