aboutsummaryrefslogtreecommitdiffstats
path: root/bootstrap/vagrant-onap/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'bootstrap/vagrant-onap/README.md')
-rw-r--r--bootstrap/vagrant-onap/README.md90
1 files changed, 79 insertions, 11 deletions
diff --git a/bootstrap/vagrant-onap/README.md b/bootstrap/vagrant-onap/README.md
index 86a5abd90..e25fa35f8 100644
--- a/bootstrap/vagrant-onap/README.md
+++ b/bootstrap/vagrant-onap/README.md
@@ -1,20 +1,88 @@
-# Vagrant ONAP
+# 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 [ONAP project](https://www.onap.org/) into a development environment. It was created only for didactic purposes.
+This vagrant project pretends to collect information about a way to deploy
+and build [ONAP project](https://www.onap.org/) into a development environment.
-## Requirements:
+### Problem Being Solved
-* Vagrant
-* VirtualBox or Libvirt
+* 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
-## Steps for execution:
+---
- git clone https://github.com/electrocucaracha/vagrant-onap.git
- cd vagrant-onap
- vagrant up
+| Component | Requirement |
+|------------------|---------------------------------------|
+| Vagrant | >= 1.8.6 |
+| Hypervisor | VirtualBox or Libvirt |
+| Operating System | Linux, Mac OS or Windows(In Progress) |
+| Hard Disk | > 8 GB of free disk |
+| Memory | > 12 GB |
-## Destroy:
+---
- vagrant destroy
+## 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