Page Comparison

...

Setup

Only two components are required for using this project, an automation building tool (Vagrant) and a provider platform (supported options: VirtualBox, Libvirt and OpenStack). This section explains how to install Vagrant and VirtualBox which are the most common configuration:

Ubuntu 14.04 ("Trusty")

$ wget -q https://releases.hashicorp.com/vagrant/1.9.7/vagrant_1.9.7_x86_64.deb
$ sudo dpkg -i vagrant_1.9.7_x86_64.deb
$ echo "deb http://download.virtualbox.org/virtualbox/debian trusty contrib" >> /etc/apt/sources.list
$ wget -q https://www.virtualbox.org/download/oracle_vbox_2016.asc -O- | sudo apt-key add -
$ wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | sudo apt-key add -
$ sudo apt-get update -y
$ sudo apt-get install -y virtualbox-5.1 dkms

CentOS

$ wget -q https://releases.hashicorp.com/vagrant/1.9.7/vagrant_1.9.7_x86_64.rpm
$ sudo yum install vagrant_1.9.7_x86_64.rpm
$ wget -q http://download.virtualbox.org/virtualbox/rpm/rhel/virtualbox.repo -P /etc/yum.repos.d
$ sudo yum --enablerepo=epel install dkms
$ wget -q https://www.virtualbox.org/download/oracle_vbox.asc -O- | rpm --import -
$ sudo yum install VirtualBox-5.1

Mac OS

$ /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
$ brew cask install vagrant
$ brew cask install virtualbox

Windows 7+ (PowerShell v2+)

PS C:\> Set-ExecutionPolicy AllSigned
PS C:\> iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/install.ps1'))
PS C:\> choco install vagrant
PS C:\> choco install virtualbox

Execution

This project provides an Ubuntu Virtual Image with all the dependencies and files required to develop in ONAP. Even when it's possible to use vagrant commands(up, destroy, suspend, provision, etc), it's highly recommend to use the scripts provided into the tools folder. Their usage is

*NIX

...

Generate HTML documentation

The documentation of this project was written in reStructuredText format which is located under the docs folder. It's possible to format these documents into HTML using Sphinix python tool.

    $ git clone https://git.onap.org/integration

    $

...

cd

...

integration/bootstrap/vagrant-onap

$ ./tools/run.sh app_name [-s test_suite| -c test_case]

Windows 7+ (PowerShell v2+, run with Administrator privileges)

PS C:\> git clone https://git.onap.org/integration
PS C:\> cd bootstrap\vagrant-onap
PS C:\> .\tools\Run.ps1 app_name [-s test_suite| -c test_case]

...

** Note: Most of the components and scripts are under development    $ sudo pip install -y tox

    $ tox -e docs

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 preferred Web Browser.