| 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
...
Minimal Requirements
| Component | Requirement |
|---|---|
| Vagrant | >= 1.8.6 |
| Provider | VirtualBox, Libvirt or OpenStack |
| Operating System | Linux, Mac OS or Windows |
| Hard Disk | > 8 GB of free disk |
| Memory | > 12 GB |
Usage
Windows
PS C:> cd integration\bootstrap\vagrant-onapPS C:\integration\bootstrap\vagrant-onap> Set-ExecutionPolicy Bypass -Scope CurrentUserPS 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_name | description |
|---|---|
| aai | Active and Available Inventory |
| appc | Application Controller |
| dcae | Data Collection Analytics & Events |
| mr | Message Router |
| mso | Master Service Orchestrator |
| msb | Microservices Bus Project |
| policy | Policy |
| portal | Portal |
| robot | Robot |
| sdc | Service Design & Creation |
| sdnc | Software Defined Network Controller |
| vid | Virtual Infrastructure Development |
| vfc | Virtual Function Controller |
| vnfsdk | VNF SDK |
| vvp | VNF Validation Program |
| multicloud | Multi Cloud |
| ccsdk | Common Controller SDK |
| all_in_one | All ONAP services in a VM |
| testing | Unit Test VM |
HTML documentation
For more information, see http://onap.readthedocs.io/en/latest/submodules/integration.git/bootstrap/vagrant-onap/doc/source/
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
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.