diff options
| author |   Pawel Wieczorek <p.wieczorek2@samsung.com> | 2020-01-13 14:23:11 +0100 |
|---|---|---|
| committer | Pawel Wieczorek <p.wieczorek2@samsung.com> | 2020-01-15 10:43:51 +0100 |
| commit | 2289007753fab6d836b83022300c7b13cb782f37 (patch) | |
| tree | 4b3c3917baa82dcabd1b6a647cb6f8bdfb437559 /bootstrap | |
| parent | 1b681e360b8d083104026080c5517f237dc0945a (diff) | |
Add minimal Vagrant environment development documentation
Issue-ID: ONAPARC-551
Change-Id: I1a6f6b998df755734a9c32fbe86473a72a45aae0
Signed-off-by: Pawel Wieczorek <p.wieczorek2@samsung.com>
Diffstat (limited to 'bootstrap')
| -rw-r--r-- | bootstrap/vagrant-minimal-onap/HACKING.rst | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/bootstrap/vagrant-minimal-onap/HACKING.rst b/bootstrap/vagrant-minimal-onap/HACKING.rst new file mode 100644 index 000000000..dcac46586 --- /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 |