diff options
| author |   Bartek Grzybowski <b.grzybowski@partner.samsung.com> | 2021-07-14 10:50:01 +0200 |
|---|---|---|
| committer | Bartek Grzybowski <b.grzybowski@partner.samsung.com> | 2021-07-14 10:50:01 +0200 |
| commit | b698cdeb43dc8c45c20aed10a6b2e2773d9c726b (patch) | |
| tree | fdc1c9b341fa9c6c56297f6e85e35347c45db0d8 /bootstrap | |
| parent | c9feb9ba3e89e255aab8f1fcc60040786694abc2 (diff) | |
[CODESEARCH] Update documentation
Change-Id: I1363c667da6e3764c397cbad5502934fcf0bdc69
Issue-ID: INT-1940
Signed-off-by: Bartek Grzybowski <b.grzybowski@partner.samsung.com>
Diffstat (limited to 'bootstrap')
| -rw-r--r-- | bootstrap/codesearch/README.rst | 24 |
1 files changed, 14 insertions, 10 deletions
diff --git a/bootstrap/codesearch/README.rst b/bootstrap/codesearch/README.rst index 10e5b8c13..d534e28cf 100644 --- a/bootstrap/codesearch/README.rst +++ b/bootstrap/codesearch/README.rst @@ -23,8 +23,9 @@ 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. +Provided vagrantfile is generic enough that it should work with any Vagrant provider. +It has been tested using default VirtualBox provider and also 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. @@ -36,34 +37,37 @@ documentation provides detailed `installation instructions`_ that will guide thr Virtual machine manager ~~~~~~~~~~~~~~~~~~~~~~~ -Environment has been tested using latest Vagrant_ as of writing this documentation (`v2.2.6`_). Some +Environment has been tested using latest Vagrant_ as of writing this documentation (`v2.2.16`_). 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 +.. _`v2.2.16`: https://github.com/hashicorp/vagrant/blob/v2.2.16/CHANGELOG.md .. _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. +If using vagrant-libvirt provider additional `--provider` flag or setting `VAGRANT_DEFAULT_PROVIDER` environmental +variable might be required in case there are multiple providers available. .. note:: - Following command should be executed within the directory where `Vagrantfile` is stored - (`integration/bootstrap/codesearch`). + One of the following commands should be executed depending on the provider you'd like to use. Run it within the + directory where `Vagrantfile` is stored (`integration/bootstrap/codesearch`). .. code-block:: sh - vagrant up --provider=libvirt + vagrant up --provider=libvirt # to leverage vagrant-libvirt provider + vagrant up # to leverage default VirtualBox provider This will: #. Start and prepare virtual machine -#. Generate required authorization and configuration files +#. Generate configuration files #. Run Hound instance as a tmux_ session named `codesearch` +At any time you can reload or stop and later start the box, it's set up to automatically run the hound process. + .. _tmux: https://github.com/tmux/tmux/wiki |