tree: cb473c9cfa6818b101b2a1965c728645bed379c6 [path history] [tgz]
  1. doc/
  2. etc/
  3. lib/
  4. tests/
  5. tools/
  6. vagrant_utils/
  7. .gitignore
  8. CONTRIBUTING.md
  9. LICENSE
  10. README.md
  11. tox.ini
  12. Vagrantfile
bootstrap/vagrant-onap/README.md

ONAP on Vagrant

This vagrant project pretends to collect information about a way to deploy and build ONAP project into a 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

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

Execution:

deploying a single application

  • 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>

current options include:

app_namedescription
aaiActive and Available Inventory
appcApplication Controller
ccsdkCommon Controller SDK
dcaeData Collection Analytics & Events
mrMessage Router
msoMaster Service Orchestrator
msbMicroservices Bus Project
multicloudMulti Cloud
oomONAP Operations Manager
policyPolicy
portalPortal
robotRobot
sdcService Design & Creation
sdncSoftware Defined Network Controller
vfcVirtual Function Controller
vidVirtual Infrastructure Development
vnfsdkVNF SDK
vvpVNF Validation Program
:----------:-------------------------------------
all_in_oneAll ONAP services in a VM
testingUnit Test VM
:----------:-------------------------------------
openstackOpenStack 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