From dd074806ad51761392a9cca3f1f04fbbebd3de22 Mon Sep 17 00:00:00 2001
From: Victor Morales <victor.morales@intel.com>
Date: Wed, 26 Jul 2017 16:06:35 -0500
Subject: Sync latest changes for vagrant-onap

Given some internal procedures was not possible to submit all the
changes.  In the meantime, those changes were placed into an
non-official project. This change syncronizes the latest changes
into the official repository.

Issue-id: INT-17

Change-Id: Ia4125f4b70273401e4ed3cc1908d2e2ad7d1c2e9
Signed-off-by: Victor Morales <victor.morales@intel.com>
---
 .../vagrant-onap/doc/source/features/features.rst  | 13 ++++
 .../vagrant-onap/doc/source/features/openstack.rst | 89 ++++++++++++++++++++++
 bootstrap/vagrant-onap/doc/source/index.rst        | 21 +++++
 3 files changed, 123 insertions(+)
 create mode 100644 bootstrap/vagrant-onap/doc/source/features/features.rst
 create mode 100644 bootstrap/vagrant-onap/doc/source/features/openstack.rst
 create mode 100644 bootstrap/vagrant-onap/doc/source/index.rst

(limited to 'bootstrap/vagrant-onap/doc')

diff --git a/bootstrap/vagrant-onap/doc/source/features/features.rst b/bootstrap/vagrant-onap/doc/source/features/features.rst
new file mode 100644
index 000000000..0b06ba04c
--- /dev/null
+++ b/bootstrap/vagrant-onap/doc/source/features/features.rst
@@ -0,0 +1,13 @@
+.. _features:
+
+=================
+Advanced features
+=================
+
+.. toctree::
+   :maxdepth: 1
+
+   openstack.rst
+
+This chapter explains how to use ONAP on Vagrant Advanced features
+like different providers.
diff --git a/bootstrap/vagrant-onap/doc/source/features/openstack.rst b/bootstrap/vagrant-onap/doc/source/features/openstack.rst
new file mode 100644
index 000000000..f44bc62f9
--- /dev/null
+++ b/bootstrap/vagrant-onap/doc/source/features/openstack.rst
@@ -0,0 +1,89 @@
+==================
+OpenStack Provider
+==================
+
+It's possible to use Vagrant to provision VMs on OpenStack using the
+`Vagrant OpenStack Cloud Provider <https://github.com/ggiamarchi/vagrant-openstack-provider/>`.
+The only requirement for the Cloud provider is to have an Ubuntu Cloud
+image accesible to your tenant and a Security Rule that allows to do
+SSH into the instance.
+
+Environment variables
+---------------------
+
+The usage of environment variables in OpenStack command-line clients
+is to avoid repeating some values.  These variables have *OS_* as
+prefix. This provider will use them for authentication to Keystone
+service.
+
+.. code-block:: console
+
+    export OS_AUTH_URL=http://<keystone_ip>:5000/v3
+    export OS_TENANT_NAME=<project_or_tenant_name>
+    export OS_PROJECT_NAME=<project_or_tenant_name>
+    export OS_USERNAME=<openstack_username>
+    export OS_PASSWORD=<openstack_password>
+    export OS_REGION_NAME=<openstack_region_name>
+    export OS_IDENTITY_API_VERSION=<keystone_version_number>
+    export OS_PROJECT_DOMAIN_ID=<openstack_domain_name>
+
+.. end
+
+OpenStack Vagrant provider needs additional information about the
+name of the image to be used and the networking where the instance
+will be provisioned.  That information can be passed using the
+following variables
+
+.. code-block:: console
+
+    export OS_IMAGE=<ubuntu_cloud_image_name>
+    export OS_NETWORK=<neutron_private_network>
+    export OS_FLOATING_IP_POOL=<neutron_floating_ip_pool>
+    export OS_SEC_GROUP=<onap-ssh-secgroup>
+
+.. end
+
+Tenant setup
+------------
+
+The *tools/setup_openstack.sh* script can be useful to get an idea
+of the process to setup the OpenStack environment with the necessary
+requirements. This script depends on the Environment Variables
+explained previously.
+
+----
+
+Devstack
+--------
+
+It's possible to use this plugin to provision instances on
+`Devstack <https://docs.openstack.org/devstack/latest/>`. This is
+an example of the *local.conf* file that can be used as input
+for Devstack
+
+.. path local.conf
+.. code-block:: ini
+
+    [[local|localrc]]
+    ADMIN_PASSWORD=<password>
+    DATABASE_PASSWORD=<password>
+    RABBIT_PASSWORD=<password>
+    SERVICE_PASSWORD=<password>
+    SERVICE_TOKEN=<token>
+
+    # Used to only upload the Ubuntu Cloud Image
+    DOWNLOAD_DEFAULT_IMAGES=False
+    IMAGE_URLS+="http://cloud-images.ubuntu.com/trusty/current/trusty-server-cloudimg-amd64-disk1.img"
+
+    # (Optional) These values helps to improve the experience deploying and using Devstack
+    GIT_BASE=https://git.openstack.org
+    FORCE_CONFIG_DRIVE="True"
+    disable_service tempest
+
+.. end
+
+.. note::
+
+    There is a validation that checks if the
+    *vagrant-openstack-provider* plugin is installed raising an error
+    for those cases when it isn't.
diff --git a/bootstrap/vagrant-onap/doc/source/index.rst b/bootstrap/vagrant-onap/doc/source/index.rst
new file mode 100644
index 000000000..88950a205
--- /dev/null
+++ b/bootstrap/vagrant-onap/doc/source/index.rst
@@ -0,0 +1,21 @@
+ONAP on Vagrant tool
+====================
+
+This project collects instructions to setup a development environment
+using different providers like VirtualBox, Libvirt or OpenStack.
+
+.. seealso::
+
+    You may want to read the `Bootstrap documentation`__ to get an idea of the
+    concepts. 
+
+    __ https://wiki.onap.org/display/DW/ONAP+on+Vagrant
+
+Advanced features
+-----------------
+
+.. toctree::
+   :maxdepth: 2
+
+   Advanced Features <features/index>
+
-- 
cgit 1.2.3-korg