Moving documentation content into new template

JIRA: DOCS-103, DOCS-134, SDNVPN-40

Moving documentation content into new feature description and user guide template.

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

7 files changed, 0 insertions, 262 deletions

diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/abstract.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/abstract.rst
deleted file mode 100644
index 189f9ff..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/abstract.rst
+++ /dev/null
@@ -1,9 +0,0 @@
-.. 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
deleted file mode 100644
index affeb03..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/hardware.requirements.rst
+++ /dev/null
@@ -1,35 +0,0 @@
-.. 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), Nikolas Hermanns (Ericsson)
-
-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
---------------------------------
-
-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/index.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/index.rst
deleted file mode 100755
index 150fbf5..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/index.rst
+++ /dev/null
@@ -1,21 +0,0 @@
-.. 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
deleted file mode 100644
index 649b5a4..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/installation.rst
+++ /dev/null
@@ -1,72 +0,0 @@
-.. 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), Nikolas Hermanns (Ericsson AB) and other
-
-Fuel installation and scenario deployment
-================================================
-
-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.
-
-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.
-::
-
- 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 virtual deployment High Availablity Mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-::
-
- 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>
-
-Full automatic virtual deployment NO High Availablity Mode
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-::
-
- 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>
-
-Automatic Fuel installation and manual scenario deployment
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-::
-
- 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/introduction.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/introduction.rst
deleted file mode 100644
index b91e19d..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/introduction.rst
+++ /dev/null
@@ -1,20 +0,0 @@
-.. 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
deleted file mode 100644
index 9fc26d3..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/preparation.rst
+++ /dev/null
@@ -1,54 +0,0 @@
-.. 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.
-
-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:
-::
-
- 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
-
-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.
diff --git a/docs/installationprocedure/os-odl_l2-bgpvpn/references.rst b/docs/installationprocedure/os-odl_l2-bgpvpn/references.rst
deleted file mode 100644
index 5cafbab..0000000
--- a/docs/installationprocedure/os-odl_l2-bgpvpn/references.rst
+++ /dev/null
@@ -1,51 +0,0 @@
-.. 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>`_