Colorado documentation: scenario install procedure

JIRA: DOCS-134

Adding structure of docs for installation
procedure for virtual deployment.

Introducing a scenario-specific directory level.

Change-Id: I01de7d3b876ba9d5f7b71b91c857842fd3badeef
signed-off-by: Tim Irnich <tim.irnich@ericsson.com>

7 files changed, 195 insertions, 0 deletions

diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/abstract.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/abstract.rst
new file mode 100644
index 0000000..189f9ff
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/abstract.rst
@@ -0,0 +1,9 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) Tim Irnich <tim.irnich@ericsson.com>
+
+This document will give the user instructions on how to deploy
+the SDN VPN scenarios verfied for the Colorado release of the OPNFV
+platform, using the Fuel installer.
+
+A sister document covers installation using the APEX installer.
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst
new file mode 100644
index 0000000..31cac1d
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst
@@ -0,0 +1,27 @@
+.. 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
+
+Hardware requirements
+=====================
+
+Bare metal deployment on Pharos Lab
+-----------------------------------
+
+Hardware requirements for bare-metal deployments of the OPNFV infrastucture are specified
+by the Pharos project. The Pharos project provides an OPNFV hardware specification for
+configuring your hardware at: http://artifacts.opnfv.org/pharos/docs/pharos-spec.html.
+
+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.
+
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/index.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/index.rst
new file mode 100755
index 0000000..150fbf5
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/index.rst
@@ -0,0 +1,21 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+.. (c) 2016 Tim Irnich <tim.irnich@ericsson.com>
+
+================================
+SDNVPN Colorado documentation
+================================
+
+.. toctree::
+   :maxdepth: 2
+
+   ./abstract.rst
+   ./introduction.rst
+   ./hardware.requirements.rst
+   ./preparation.rst
+   ./installation.rst
+   ./references.rst
+
+Indices
+=======
+* :ref:`search`
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst
new file mode 100644
index 0000000..ecb4e52
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst
@@ -0,0 +1,47 @@
+.. 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
+
+Fuel server 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
+os-odl_l2-bgpvpn-noha OPNFV reference platform stack across a server cluster.
+
+Preparation
+-----------
+
+clone fuel repo
+download opnfv iso
+create dea.yaml and dha.yaml based on existing examples from FUel repo
+
+Installation procedures
+-----------------------
+
+We describe several alternative procedures in the following.
+
+Full automatic jumphost installation and deployment
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+call deploy.sh with scenario string
+
+Automatic Fuel server installation and manual scenario deployment
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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
+
+Update Fuel server settings without re-installation
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+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.
+
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/introduction.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/introduction.rst
new file mode 100644
index 0000000..b91e19d
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/introduction.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License. .. http://creativecommons.org/licenses/by/4.0 ..
+.. (c) Tim Irnich and Nikolas Hermanns, Ericsson AB
+
+Introduction
+============
+
+This document provides guidelines on how to install and configure the
+os-odl_l2_bgpvpn_ha and os-odl_l2_bgpvpn_ha scenarios of OPNFV including
+required software and hardware configurations.
+
+Description of bgpvpn scenarios
+Internal transport tunnel mesh
+Install Neutron BGPVPN additions (networking-bgpvpn)
+Neutron odl additions (networking-odl)
+install and configure Quagga (incl. config on ODL side)
+configure OVS to connect to ODL and set up the right bridges (network architecture)
+set up iptables to allow connections between OVS and ODL
+set up HA proxy so that ODL can be reached
+
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst
new file mode 100644
index 0000000..f0510cf
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst
@@ -0,0 +1,20 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International
+.. License. .. http://creativecommons.org/licenses/by/4.0 ..
+.. (c) Tim Irnich (Ericsson AB) and others
+
+Preparing your host to install Fuel by script
+=================================================
+.. Not all of these options are relevant for all scenario's.  I advise following the
+.. instructions applicable to the deploy tool used in the scenario.
+
+Before starting the installation of the <scenario> scenario some preparation of the
+machine that will host the Fuel VM must be done.
+
+
+Setting up the host
+-------------------
+
+
+Installation of required packages
+---------------------------------
+
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/references.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/references.rst
new file mode 100644
index 0000000..5cafbab
--- /dev/null
+++ b/docs/installationprocedure/os-odl_l2-bgpvpn/references.rst
@@ -0,0 +1,51 @@
+.. 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
+
+
+References
+==========
+
+OPNFV
+-----
+
+1) `OPNFV Home Page <http://www.opnfv.org>`_
+
+2) `OPNFV documentation- and software downloads <https://www.opnfv.org/software/download>`_
+
+OpenStack
+---------
+
+3) `OpenStack Liberty Release artifacts <http://www.openstack.org/software/liberty>`_
+
+4) `OpenStack documentation <http://docs.openstack.org>`_
+
+OpenDaylight
+------------
+
+5) `OpenDaylight artifacts <http://www.opendaylight.org/software/downloads>`_
+
+Fuel
+----
+6) `The Fuel OpenStack project <https://wiki.openstack.org/wiki/Fuel>`_
+
+7) `Fuel documentation overview <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/>`_
+
+8) `Fuel planning guide <https://docs.fuel-infra.org/openstack/fuel/fuel-8.0/mos-planning-guide.html>`_
+
+9) `Fuel quick start guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/quickstart-guide.html>`_
+
+10) `Fuel operations guide <https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html>`_
+
+11) `Fuel Plugin Developers Guide <https://wiki.openstack.org/wiki/Fuel/Plugins>`_
+
+12) `Fuel OpenStack Hardware Compatibility List <https://www.mirantis.com/products/openstack-drivers-and-plugins/hardware-compatibility-list>`_
+
+Fuel in OPNFV
+-------------
+
+13) `OPNFV Installation instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/installation-instruction.html>`_
+
+14) `OPNFV Build instruction for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/build-instruction.html>`_
+
+15) `OPNFV Release Note for the Brahmaputra release of OPNFV when using Fuel as a deployment tool <http://artifacts.opnfv.org/fuel/brahmaputra/docs/release-notes.html>`_