Skip to content

onap/integration-devtool

Repository files navigation

Devtool for ONAP

This project pretends to collect information about a way to developing/building services for ONAP project providing an automated development environment.

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

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

Execution:

Deploying a single application

  • Windows

    PS C:> cd devtool PS C:\devtool> Set-ExecutionPolicy Bypass -Scope CurrentUser PS C:\devtool> .\tools\Run.ps1 <app_name>

  • Linux or Mac OS

    $ cd devtool $ ./tools/run.sh <app_name>

current options include:

app_name description
aai Active and Available Inventory
appc Application Controller
ccsdk Common Controller SDK
dcae Data Collection Analytics & Events
dmaap Data Movement as a Platform
integration Integration
mr Message Router
mso Master Service Orchestrator
msb Microservices Bus Project
multicloud Multi Cloud
oom ONAP Operations Manager
policy Policy
portal Portal
robot Robot
sdc Service Design & Creation
sdnc Software Defined Network Controller
vfc Virtual Function Controller
vid Virtual Infrastructure Development
vnfsdk VNF SDK
vvp VNF Validation Program
app_name description
testing Unit Test VM
app_name description
openstack OpenStack Deployment

Generating 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 to HTML using Sphinix python tool.

$ 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.

Contributing

Bug reports and patches are most welcome. See the contribution guidelines.

License

Apache-2.0