bootstrap/vagrant-onap/README.md

   1 # ONAP on Vagrant
   2
   3 [![Build Status](https://api.travis-ci.org/electrocucaracha/vagrant-onap.svg?branch=master)](https://api.travis-ci.org/electrocucaracha/vagrant-onap)
   4
   5 This vagrant project pretends to collect information about a way to deploy
   6 and build [ONAP project](https://www.onap.org/) into a development environment.
   7
   8 ### Problem Being Solved
   9
  10 * Reduce the barrier of entry to allow new ONAP developers to ramp up on to
  11 active development quickly
  12 * Reduce the cost to the community in responding to simple environment setup
  13 questions faced by new developers
  14
  15 ---
  16
  17 | Component        | Requirement                           |
  18 |------------------|---------------------------------------|
  19 | Vagrant          | >= 1.8.6                              |
  20 | Provider         | VirtualBox, Libvirt or OpenStack      |
  21 | Operating System | Linux, Mac OS or Windows              |
  22 | Hard Disk        | > 8 GB of free disk                   |
  23 | Memory           | > 12 GB                               |
  24
  25 ---
  26
  27 ## Execution:
  28
  29 #### deploying a single application
  30
  31 * Windows
  32
  33     C:\> vagrant up <app_name>
  34
  35 * Linux or Mac OS
  36
  37     $ ./tools/run.sh <app_name>
  38
  39 current options include:
  40
  41 | app_name  | description                         |
  42 |:---------:|-------------------------------------|
  43 | aai       | Active and Available Inventory      |
  44 | appc      | Application Controller              |
  45 | dcae      | Data Collection Analytics & Events  |
  46 | mr        | Message Router                      |
  47 | mso       | Master Service Orchestrator         |
  48 | policy    | Policy                              |
  49 | portal    | Portal                              |
  50 | robot     | Robot                               |
  51 | sdc       | Service Design & Creation           |
  52 | sdnc      | Software Defined Network Controller |
  53 | vid       | Virtual Infrastructure Development  |
  54 | vfc       | Virtual Function Controller (WIP)   |
  55
  56 #### setting up proxy in case you are behind a firewall
  57
  58 add http_proxy and https_proxy to your environment variables
  59
  60 Linux or Mac
  61
  62     $ export http_proxy=<proxy>
  63     $ export https_proxy=<proxy>
  64     $ export no_proxy=<no_proxy_urls>
  65
  66 Windows
  67
  68     C:\> setx http_proxy <proxy>
  69     C:\> setx https_proxy <proxy>
  70     C:\> setx no_proxy <no_proxy_urls>
  71
  72 ##### choosing vagrant provider
  73 force VirtualBox provider
  74
  75     C:\> vagrant up --provider=virtualbox
  76
  77 setup the default provider on Windows
  78
  79     C:\> setx VAGRANT_DEFAULT_PROVIDER=virtualbox
  80
  81 ## Contributing
  82
  83 Bug reports and patches are most welcome.
  84 See the [contribution guidelines](CONTRIBUTING.md).
  85
  86 ## License
  87
  88 Apache-2.0