[DOC] Automatic Installation

Change-Id: I067046949d9cd4a764c279c053a2f54b30645fda
Signed-off-by: Nikolas Hermanns <nikolas.hermanns@ericsson.com>

3 files changed, 105 insertions, 38 deletions

diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst
index 31cac1d..affeb03 100644
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst
@@ -1,6 +1,6 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International
 .. License. .. http://creativecommons.org/licenses/by/4.0 ..
-.. (c) Christopher Price (Ericsson AB) and others
+.. (c) Christopher Price (Ericsson AB), Nikolas Hermanns (Ericsson)
 
 Hardware requirements
 =====================
@@ -18,10 +18,18 @@ Virtual deployment hardware requirements
 To perform a virtual deployment of an OPNFV scenario on a single host, that host has to
 meet the hardware requirements outlined in the <missing spec>.
 
-.. Additional Hardware requirements
-.. --------------------------------
-..
-.. Your scenario may require specific capabilities that are not explicitly stated in
-.. the Pharos spec.  If this is the case add your specific hardware requirements to this
-.. section of the document under sub-headings.
+Additional Hardware requirements
+--------------------------------
+
+When ODL is used as SDN Controller in an OPNFV, virtual deployment, ODL is
+running on the OpenStack Controller VMs. it is therefore recommmended to
+increase the amount of resources these VMs have.
+
+Our recommendation is to have 2 more virtual cores and 8GB more virtual memory. Together with the commonly used recommendation this sums up to:
+::
+
+ 4 virtual cores
+ 16 GB virtual memory
+
+See in Installation section how to configure this.
 
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst
index ecb4e52..649b5a4 100644
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst
@@ -1,47 +1,72 @@
 .. This work is licensed under a Creative Commons Attribution 4.0 International
 .. License. .. http://creativecommons.org/licenses/by/4.0 ..
-.. (c) Christopher Price (Ericsson AB) and others
+.. (c) Christopher Price (Ericsson AB), Nikolas Hermanns (Ericsson AB) and other
 
-Fuel server installation and scenario deployment
+Fuel installation and scenario deployment
 ================================================
 
-.. Let's figure out how to structure this to highlight both virtual and
-.. bare metal deployments.  I need some help from the scenrio  owners to get
-.. that right.
-
-This section describes the installation of the OPNFV installation
-server (jumphost) as well as the deployment of the os-odl_l2-bgpvpn-ha or
+This section describes the installation of the os-odl_l2-bgpvpn-ha or
 os-odl_l2-bgpvpn-noha OPNFV reference platform stack across a server cluster.
 
-Preparation
------------
+Scenario Preparation
+--------------------
+dea.yaml and dha.yaml need to be copied and changed according to the lap/host
+where you deploy.
+Copy the full lab config from:
+::
+
+ cp <path-to-opnfv-fuel-repo>/deploy/config/labs/devel-pipeline/elx \
+    <path-to-opnfv-fuel-repo>/deploy/config/labs/devel-pipeline/<your-lab-name>
+
+Add at the bottom of dha.yaml.
+::
 
-clone fuel repo
-download opnfv iso
-create dea.yaml and dha.yaml based on existing examples from FUel repo
+ disks:
+   fuel: 100G
+   controller: 100G
+   compute: 100G
+
+ define_vms:
+   controller:
+     vcpu:
+       value: 4
+     memory:
+       attribute_equlas:
+         unit: KiB
+       value: 16388608
+     currentMemory:
+       attribute_equlas:
+         unit: KiB
+       value: 16388608
+
+Check if dea.yaml contains all your needed changes.
 
 Installation procedures
 -----------------------
 
 We describe several alternative procedures in the following.
+Go to
+::
+
+ cd <opnfv-fuel-repo>/ci
 
-Full automatic jumphost installation and deployment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Full automatic virtual deployment High Availablity Mode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
 
-call deploy.sh with scenario string
+ sudo bash ./deploy.sh -b file://<path-to-opnfv-fuel-repo>/config/ -l devel-pipeline -p <your-lab-name> -s os-odl_l2-bgpvpn-ha -i file://<path-to-fuel-iso>
 
-Automatic Fuel server installation and manual scenario deployment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Full automatic virtual deployment NO High Availablity Mode
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
 
-call deploy.sh with -e option to only install FUel server i.e. no platform deployment
-Log into Fuel web GUI and configure scenario options, including activation of SDN VPN feature
-PXE boot compute nodes from Fuel server
-Trigger deployment through web GUI
+ sudo bash ./deploy.sh -b file://<path-to-opnfv-fuel-repo>/config/ -l devel-pipeline -p <your-lab-name> -s os-odl_l2-bgpvpn-noha -i file://<path-to-fuel-iso>
 
-Update Fuel server settings without re-installation
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Automatic Fuel installation and manual scenario deployment
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+::
 
-In case of having to change the jumphost settings without having the reinstall the
-whole jumphost, it is possible to call deploy-sh with the -f option, which will only
-update the settings without reinstalling the host, saving a lot of time.
+ sudo bash ./deploy.sh -b file://<path-to-opnfv-fuel-repo>/config/ -l devel-pipeline -p <your-lab-name> -s os-odl_l2-bgpvpn-ha -i file://<path-to-fuel-iso> -e
 
+With -e option the installer does not launch environment deployment, so
+a user can do some modification before the scenario is really deployed. Another interesting option is the -f option which deploys the scenario  on existing Fuel.
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst
index f0510cf..9fc26d3 100644
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst
@@ -10,11 +10,45 @@ Preparing your host to install Fuel by script
 Before starting the installation of the <scenario> scenario some preparation of the
 machine that will host the Fuel VM must be done.
 
+Installation of required packages
+---------------------------------
+To be able to run the installation of the basic opnfv fuel installation the
+Jumphost (or the host which serves the VMs for the virtual deployment) needs to
+install the following packages:
+::
 
-Setting up the host
--------------------
+ sudo apt-get install -y git make curl libvirt-bin libpq-dev qemu-kvm \
+                         qemu-system tightvncserver virt-manager sshpass \
+                         fuseiso genisoimage blackbox xterm python-pip \
+                         python-git python-dev python-oslo.config \
+                         python-pip python-dev libffi-dev libxml2-dev \
+                        libxslt1-dev libffi-dev libxml2-dev libxslt1-dev \
+                        expect curl python-netaddr p7zip-full
 
+ sudo pip install GitPython pyyaml netaddr paramiko lxml scp \
+                  python-novaclient python-neutronclient python-glanceclient \
+                  python-keystoneclient debtcollector netifaces enum
 
-Installation of required packages
----------------------------------
+Download the source code and artifact
+-------------------------------------
+To be able to install the scenario os-odl_l2-bgpvpn one can follow the way
+CI is deploying the scenario.
+First of all the opnfv-fuel repo needs to be cloned:
+::
+
+ git clone ssh://<user>@gerrit.opnfv.org:29418/fuel
+
+This command downloads the whole repo fuel. We need now to switch it to
+the stable Brahmaputra branch:
+::
+
+ cd fuel
+ git checkout stable/brahmaputra
+
+Now download the appropriate OPNFV Fuel ISO into an appropriate folder:
+::
+
+ wget http://artifacts.opnfv.org/fuel/brahmaputra/opnfv-brahmaputra.3.0.iso
 
+The ISO version may change.
+Check https://www.opnfv.org/opnfv-brahmaputra-fuel-users to get the latest ISO.