Add minimal Vagrant environment development documentation

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

diff --git a/bootstrap/vagrant-minimal-onap/HACKING.rst b/bootstrap/vagrant-minimal-onap/HACKING.rst
new file mode 100644 (file)
index 0000000..dcac465
--- /dev/null
+++ b/bootstrap/vagrant-minimal-onap/HACKING.rst
@@ -0,0 +1,20 @@
+=========================
+ Development environment
+=========================
+
+Modifications made within this environment focus mainly on adjusting environment and override files
+[#]_ located in `oom` repository. This repository is cloned to the Operator's machine and used
+during initial provisioning. Editing said files on the host machine (instead of using remote editor
+within `vagrant ssh operator` or Emacs TRAMP) requires synchronizing them from guest (operator) to
+host using reverse_ SSHFS [#]_.
+
+When Operator's machine is up, repository content is available in `./oom` directory on the host. It
+vanishes if machine is halted, but then it is no longer relevant.
+
+.. [#] Used by `helm deploy` command
+.. [#] Other mechanisms_ considered: rsync (unidirectional, synchronized on machine reload) and NFS
+       (requires privilege_ elevation to edit host configuration files for synchronization)
+
+.. _reverse: https://github.com/dustymabe/vagrant-sshfs#options-specific-to-reverse-mounting-guesthost-mount
+.. _mechanisms: https://github.com/vagrant-libvirt/vagrant-libvirt#synced-folders
+.. _privilege: https://www.vagrantup.com/docs/synced-folders/nfs.html