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     PS C:\> cd integration\bootstrap\vagrant-onap
  34     PS C:\integration\bootstrap\vagrant-onap> Set-ExecutionPolicy Bypass -Scope CurrentUser
  35     PS C:\integration\bootstrap\vagrant-onap> .\tools\Run.ps1 <app_name>
  36
  37 * Linux or Mac OS
  38
  39     $ cd integration/bootstrap/vagrant-onap
  40     $ ./tools/run.sh <app_name>
  41
  42 current options include:
  43
  44 | app_name   | description                         |
  45 |:----------:|-------------------------------------|
  46 | aai        | Active and Available Inventory      |
  47 | appc       | Application Controller              |
  48 | dcae       | Data Collection Analytics & Events  |
  49 | mr         | Message Router                      |
  50 | mso        | Master Service Orchestrator         |
  51 | policy     | Policy                              |
  52 | portal     | Portal                              |
  53 | robot      | Robot                               |
  54 | sdc        | Service Design & Creation           |
  55 | sdnc       | Software Defined Network Controller |
  56 | vid        | Virtual Infrastructure Development  |
  57 | vfc        | Virtual Function Controller         |
  58 | multicloud | Multi Cloud                         |
  59 | ccsdk      | Common Controller SDK               |
  60 | all_in_one | All ONAP services in a VM           |
  61 | testing    | Unit Test VM                        |
  62
  63 #### Generating documentation
  64
  65 The documentation of this project was written in reStructuredText
  66 format which is located under the [docs folder](../blob/master/doc/source/index.rst).
  67 It's possible to format this documents to HTML using Sphinix python
  68 tool.
  69
  70     $ tox -e docs
  71
  72 This results in the creation of a new *doc/build/html* folder with
  73 the documentation converted in HTML pages that can be viewed through
  74 the preferred Web Browser.
  75
  76 ## Contributing
  77
  78 Bug reports and patches are most welcome.
  79 See the [contribution guidelines](CONTRIBUTING.md).
  80
  81 ## License
  82
  83 Apache-2.0