diff options
author | Victor Morales <victor.morales@intel.com> | 2017-08-22 19:51:35 -0500 |
---|---|---|
committer | Victor Morales <victor.morales@intel.com> | 2017-08-22 19:51:35 -0500 |
commit | 1461312e7a63dec5e20b3fafd27d67609d7870cd (patch) | |
tree | ba33c05b46954168ce7bc5a6255d2cf759721b46 /bootstrap/vagrant-onap/doc/source | |
parent | 7ae05a4cc53bf3298090ade8091485ce2388af1f (diff) |
Documented the process to use provisining scripts
It's possible to use these provisioning scripts to setup a
development environment without installing vagrant on it.
This commit specifies the steps and variables required for that
process.
Change-Id: Ica3e377f76b65c149d7ea7b805853b2e315e114c
Signed-off-by: Victor Morales <victor.morales@intel.com>
Issue-Id: INT-25
Diffstat (limited to 'bootstrap/vagrant-onap/doc/source')
-rw-r--r-- | bootstrap/vagrant-onap/doc/source/features/consuming_scripts.rst | 91 | ||||
-rw-r--r-- | bootstrap/vagrant-onap/doc/source/features/features.rst | 1 |
2 files changed, 92 insertions, 0 deletions
diff --git a/bootstrap/vagrant-onap/doc/source/features/consuming_scripts.rst b/bootstrap/vagrant-onap/doc/source/features/consuming_scripts.rst new file mode 100644 index 000000000..dd4f14ba7 --- /dev/null +++ b/bootstrap/vagrant-onap/doc/source/features/consuming_scripts.rst @@ -0,0 +1,91 @@ +============================== +Using the provisioning scripts +============================== + +Vagrant is a platform that uses prebaked images called +*vagrant boxes* to guarranty that running multiple times a +provisioning script will result in an expected output. This +mechanism is crucial for reducing the number of external factors +during the creation, development and testing of provisioning scripts. +However, it's possible to provide an ONAP development enviroment +without having to install Vagrant tool. This document explains how to +consume the provisioning scripts localed in **./lib** folder to +provision a development environment and the environment variables +that modifies their behavior. + +This project was built on an Ubuntu 14.04 ("Trusty") Operating System, +therefore it's necessary to have an user who has *sudo* permissions to +access to a Bare Metal or Virtual Machine. + +The following instructions retrieve the provisioning scripts and place +them into the */var/onap/* folder. + +.. code-block:: console + + $ sudo su - + # apt-get install git -y + # git clone https://git.onap.org/integration + # mv integration/bootstrap/vagrant-onap/lib/ /var/onap/ + +.. end + +Loading a provisioning script will be based on the desired ONAP +service, for example to setup the development environment for Active +and Available Inventory (AAI) service will be required to load the +*/var/onap/aai* script. + +.. note:: + + The **git_src_folder** environment variable specifies the + source code destination folder, it's default value is */opt/* + but it can be changed only after is loaded the provisioning + scripts. + +.. end + +.. code-block:: console + + # source /var/onap/aai + +.. end + +Lastly, every script has defined a initialization function with +*init_* as prefix. This function is the starting point to provision +the chosen ONAP service. This example uses the *init_aai* function +to provision a AAI Developement environment. + +.. note:: + + The **compile_repo** environment variable defines whether or not + the source code located on the repositories of the service. + Enabling this value can impact the provisioning time of the + service. + +.. end +.. note:: + + **nexus_docker_repo**, **nexus_username** and **nexus_password** + environment variables specify the connectivity to a private Docker + Hub. + +.. end +.. note:: + + **build_image** environment variable allows the Docker images + from source code. Enabling this value can impact the + provisioning time of the service. + +.. end + +.. code-block:: console + + # export nexus_docker_repo="nexus3.onap.org:10001" + # export nexus_username="docker" + # export nexus_password="docker" + # init_aai + +.. end + +As result, the source code is pulled into */opt/aai/* folder and the +AAI services are up and running with the proper connection to the +Titan Distributed Graph Database. diff --git a/bootstrap/vagrant-onap/doc/source/features/features.rst b/bootstrap/vagrant-onap/doc/source/features/features.rst index 0b06ba04c..949969828 100644 --- a/bootstrap/vagrant-onap/doc/source/features/features.rst +++ b/bootstrap/vagrant-onap/doc/source/features/features.rst @@ -8,6 +8,7 @@ Advanced features :maxdepth: 1 openstack.rst + consuming_scripts.rst This chapter explains how to use ONAP on Vagrant Advanced features like different providers. |