diff options
| -rw-r--r-- | bootstrap/vagrant-onap/README.md | 2 | ||||
| -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 | ||||
| -rwxr-xr-x | bootstrap/vagrant-onap/lib/_onap_functions | 1 | ||||
| -rwxr-xr-x | bootstrap/vagrant-onap/lib/aai | 2 |
5 files changed, 95 insertions, 2 deletions
diff --git a/bootstrap/vagrant-onap/README.md b/bootstrap/vagrant-onap/README.md index cab72c5e9..9e7054c66 100644 --- a/bootstrap/vagrant-onap/README.md +++ b/bootstrap/vagrant-onap/README.md @@ -69,7 +69,7 @@ tool. This results in the creation of a new *doc/build/html* folder with the documentation converted in HTML pages that can be viewed through -the prefered Web Browser. +the preferred Web Browser. ## Contributing 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. diff --git a/bootstrap/vagrant-onap/lib/_onap_functions b/bootstrap/vagrant-onap/lib/_onap_functions index 12ac1768b..9e06010ed 100755 --- a/bootstrap/vagrant-onap/lib/_onap_functions +++ b/bootstrap/vagrant-onap/lib/_onap_functions @@ -66,6 +66,7 @@ function _configure_maven { fi fi + mkdir -p $(dirname $mvn_conf_file) if [ ! -f $mvn_conf_file ]; then if [[ "$enable_oparent" == "True" ]]; then clone_repo oparent diff --git a/bootstrap/vagrant-onap/lib/aai b/bootstrap/vagrant-onap/lib/aai index faf916d9b..2b7f98106 100755 --- a/bootstrap/vagrant-onap/lib/aai +++ b/bootstrap/vagrant-onap/lib/aai @@ -183,7 +183,7 @@ function init_aai { compile_aai_repos setup_titan - start_aai_microservices + #start_aai_microservices mkdir -p /opt/openecomp/aai/logs mkdir -p /opt/openecomp/aai/data |