Add Hound code search environment quickstart documentation

Issue-ID: ONAPARC-540
Change-Id: I618fcd994f2c6575ee4e388a78606ec59ec4fd02
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>

diff --git a/bootstrap/codesearch/README.rst b/bootstrap/codesearch/README.rst
index 8e3278d..78262b2 100644 (file)
--- a/bootstrap/codesearch/README.rst
+++ b/bootstrap/codesearch/README.rst
@@ -15,3 +15,59 @@ future, though.
 
 .. _Hound: https://github.com/hound-search/hound
 .. _`Upstream Docker image`: https://hub.docker.com/r/etsy/hound
+
+
+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/codesearch`).
+
+.. code-block:: sh
+   vagrant up --provider=libvirt
+
+This will:
+
+#. Start and prepare virtual machine
+#. Generate required authorization and configuration files
+#. Run Hound instance as a tmux_ session named `codesearch`
+
+.. _tmux: https://github.com/tmux/tmux/wiki
+
+
+Usage
+-----
+
+Once ready (cloning repositories and building index might initially take some time) code search will
+be available at http://localhost:6080