3 This vagrant project pretends to collect information about a way to deploy
4 and build [ONAP project](https://www.onap.org/) into a development environment.
6 ### Problem Being Solved
8 * Reduce the barrier of entry to allow new ONAP developers to ramp up on to
9 active development quickly
10 * Reduce the cost to the community in responding to simple environment setup
11 questions faced by new developers
15 | Component | Requirement |
16 |------------------|---------------------------------------|
17 | Vagrant | >= 1.8.6 |
18 | Provider | VirtualBox, Libvirt or OpenStack |
19 | Operating System | Linux, Mac OS or Windows |
20 | Hard Disk | > 8 GB of free disk |
27 #### deploying a single application
31 PS C:\> cd integration\bootstrap\vagrant-onap
32 PS C:\integration\bootstrap\vagrant-onap> Set-ExecutionPolicy Bypass -Scope CurrentUser
33 PS C:\integration\bootstrap\vagrant-onap> .\tools\Run.ps1 <app_name>
37 $ cd integration/bootstrap/vagrant-onap
38 $ ./tools/run.sh <app_name>
40 current options include:
42 | app_name | description |
43 |:----------:|-------------------------------------|
44 | aai | Active and Available Inventory |
45 | appc | Application Controller |
46 | ccsdk | Common Controller SDK |
47 | dcae | Data Collection Analytics & Events |
48 | mr | Message Router |
49 | mso | Master Service Orchestrator |
50 | msb | Microservices Bus Project |
51 | multicloud | Multi Cloud |
52 | oom | ONAP Operations Manager |
56 | sdc | Service Design & Creation |
57 | sdnc | Software Defined Network Controller |
58 | vfc | Virtual Function Controller |
59 | vid | Virtual Infrastructure Development |
61 | vvp | VNF Validation Program |
63 | app_name | description |
64 |:----------:|------------------------------------------|
65 | all_in_one | All ONAP services in a VM (experimental) |
66 | testing | Unit Test VM |
68 | app_name | description |
69 |:----------:|----------------------|
70 | openstack | OpenStack Deployment |
72 #### Generating documentation
74 The documentation of this project was written in reStructuredText
75 format which is located under the [docs folder](../blob/master/doc/source/index.rst).
76 It's possible to format these documents to HTML using Sphinix python
81 This results in the creation of a new *doc/build/html* folder with
82 the documentation converted in HTML pages that can be viewed through
83 the preferred Web Browser.
87 Bug reports and patches are most welcome.
88 See the [contribution guidelines](CONTRIBUTING.md).