Add minimal Vagrant environment quickstart documentation 32/99432/4
authorPawel Wieczorek <p.wieczorek2@samsung.com>
Tue, 10 Dec 2019 16:36:14 +0000 (17:36 +0100)
committerMorgan Richomme <morgan.richomme@orange.com>
Wed, 18 Dec 2019 07:32:03 +0000 (07:32 +0000)
Issue-ID: ONAPARC-537
Change-Id: I86f5db6331980bf7d7ea4074d6e0bbcc84843d3c
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
bootstrap/vagrant-minimal-onap/README.rst

index fc22c0c..21238d7 100644 (file)
@@ -21,3 +21,64 @@ NOTE: the Devstack instance is NOT SECURED, with default credentials:
 +-------+----------------+
 | demo  | default123456! |
 +-------+----------------+
+
+
+Requirements
+------------
+
++-------------+-----+-------+
+| Machine     | CPU |  RAM  |
++-------------+-----+-------+
+| Operator    |  1  | 1GiB  |
++-------------+-----+-------+
+| Devstack    |  2  | 6GiB  |
++-------------+-----+-------+
+| K8s Control |  1  | 1GiB  |
++-------------+-----+-------+
+| K8s Worker  |  2  | 12GiB |
++-------------+-----+-------+
+| TOTAL       |  6  | 20GiB |
++-------------+-----+-------+
+
+Table above is based on current experience and may be subject to change.
+
+
+Prerequisites
+-------------
+
+Virtualisation provider
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Environment has been tested using libvirt_ provider with vagrant-libvirt_ plugin. Plugin
+documentation provides detailed `installation instructions`_ that will guide through the process.
+
+.. note::
+   Remember to uncomment `deb-src` repositories for `apt-get build-dep` step on Debian/Ubuntu.
+
+.. _libvirt: https://libvirt.org
+.. _vagrant-libvirt: https://github.com/vagrant-libvirt/vagrant-libvirt
+.. _`installation instructions`: https://github.com/vagrant-libvirt/vagrant-libvirt#installation
+
+Virtual machine manager
+~~~~~~~~~~~~~~~~~~~~~~~
+
+Environment has been tested using latest Vagrant_ as of writing this documentation (`v2.2.6`_). Some
+features (e.g. triggers_) might not be supported on older versions.
+
+.. _Vagrant: https://www.vagrantup.com/downloads.html
+.. _`v2.2.6`: https://github.com/hashicorp/vagrant/blob/v2.2.6/CHANGELOG.md#226-october-14-2019
+.. _triggers: https://www.vagrantup.com/docs/triggers/
+
+
+Running
+-------
+
+Additional `--provider` flag or setting `VAGRANT_DEFAULT_PROVIDER` environmental variable might be
+useful in case there are multiple providers available.
+
+.. note::
+   Following command should be executed within the directory where `Vagrantfile` is stored
+   (`integration/bootstrap/vagrant-minimal-onap`).
+
+.. code-block:: sh
+   vagrant up --provider=libvirt