summaryrefslogtreecommitdiffstats
path: root/bootstrap/vagrant-onap/README.md
blob: 99d2de1778675759d36069a2adbc56d849741554 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
# ONAP on Vagrant

[![Build Status](https://api.travis-ci.org/electrocucaracha/vagrant-onap.svg?branch=master)](https://api.travis-ci.org/electrocucaracha/vagrant-onap)

This vagrant project pretends to collect information about a way to deploy
and build [ONAP project](https://www.onap.org/) 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

---

| 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

    C:\> vagrant up <app_name>

* Linux or Mac OS

    $ ./tools/run.sh <app_name>

current options include:

| app_name  | description                         |
|:---------:|-------------------------------------|
| aai       | Active and Available Inventory      |
| appc      | Application Controller              |
| dcae      | Data Collection Analytics & Events  |
| mr        | Message Router                      |
| mso       | Master Service Orchestrator         |
| policy    | Policy                              |
| portal    | Portal                              |
| robot     | Robot                               |
| sdc       | Service Design & Creation           |
| sdnc      | Software Defined Network Controller |
| vid       | Virtual Infrastructure Development  |
| vfc       | Virtual Function Controller (WIP)   |

#### setting up proxy in case you are behind a firewall

add http_proxy and https_proxy to your environment variables

Linux or Mac

    $ export http_proxy=<proxy>
    $ export https_proxy=<proxy>
    $ export no_proxy=<no_proxy_urls>

Windows

    C:\> setx http_proxy <proxy>
    C:\> setx https_proxy <proxy>
    C:\> setx no_proxy <no_proxy_urls>

##### choosing vagrant provider
force VirtualBox provider

    C:\> vagrant up --provider=virtualbox

setup the default provider on Windows

    C:\> setx VAGRANT_DEFAULT_PROVIDER=virtualbox

## Contributing

Bug reports and patches are most welcome.
See the [contribution guidelines](CONTRIBUTING.md).

## License

Apache-2.0