bootstrap/vagrant-onap/README.md

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