Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents

Definition

This vagrant project collects information about to setup tools for developing on ONAP project.  That includes cloning source code, installing dependencies and building and deploying artifactsStarted as an attempt to deploy ONAP services without relying on a OpenStack deployment, this project has been re-architectured to provide an automated tool for provisioning ONAP development environment. Covering some common development tasks such as the cloning source code repositories of specific component, compile java artifacts per component and building Docker images of specific component. This has been vehicle to standardize process and dependencies through an automated provisioning mechanism, as consequence its possible to setup a development environment using only a single instruction. Adding this tool into a CI/CD pipeline can prevent any compilation failure in the future and guarantee building image process works any time.

Problem Being Solved

  • Reduce the barrier of entry to allow new ONAP developers to ramp up on to active development quickly
  • Reduce the cost to the community in responding to simple environment setup questions faced by new developers

Change log

...

Created unit tests for A&AI component

...

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

    $ sudo pip install -y tox

    $ tox -e docs

...

Minimal Requirements

ComponentRequirement
Vagrant>= 1.8.6
ProviderVirtualBox, Libvirt or OpenStack
Operating SystemLinux, Mac OS or Windows
Hard Disk> 8 GB of free disk
Memory> 12 GB

Usage

  • Windows

    PS C:> cd integration\bootstrap\vagrant-onap
    PS C:\integration\bootstrap\vagrant-onap> Set-ExecutionPolicy Bypass -Scope CurrentUser
    PS C:\integration\bootstrap\vagrant-onap> .\tools\Run.ps1 <app_name>
  • Linux or Mac OS

    $ cd integration/bootstrap/vagrant-onap $ ./tools/run.sh <app_name>

supported options:

app_namedescription
aaiActive and Available Inventory
appcApplication Controller
dcaeData Collection Analytics & Events
mrMessage Router
msoMaster Service Orchestrator
msbMicroservices Bus Project
policyPolicy
portalPortal
robotRobot
sdcService Design & Creation
sdncSoftware Defined Network Controller
vidVirtual Infrastructure Development
vfcVirtual Function Controller
vnfsdk

VNF SDK

vvpVNF Validation Program
multicloudMulti Cloud
ccsdkCommon Controller SDK
all_in_oneAll ONAP services in a VM
testingUnit Test VM

HTML documentation

For more information, see http://onap.readthedocs.io/en/latest/submodules/integration.git/bootstrap/vagrant-onap/doc/source/