From d4036482535db1d1fc28c88960c8b05233543ace Mon Sep 17 00:00:00 2001 From: Victor Morales Date: Tue, 15 Aug 2017 17:54:14 -0500 Subject: Move Known Issues section to docs folder The known issues section should be placed in its own file for future additions. It was also included a validation that prevents the auto update feature of vagrant-vbguest plugin. Change-Id: Ibdbd89c15b657b11b346c2cbcc084176f82d8102 Signed-off-by: Victor Morales Issue-Id: INT-98 --- bootstrap/vagrant-onap/README.md | 38 +--------------- bootstrap/vagrant-onap/Vagrantfile | 25 ++++++----- bootstrap/vagrant-onap/doc/source/index.rst | 1 + .../doc/source/install/known_issues.rst | 50 ++++++++++++++++++++++ 4 files changed, 67 insertions(+), 47 deletions(-) create mode 100644 bootstrap/vagrant-onap/doc/source/install/known_issues.rst diff --git a/bootstrap/vagrant-onap/README.md b/bootstrap/vagrant-onap/README.md index 05f8cda4a..cab72c5e9 100644 --- a/bootstrap/vagrant-onap/README.md +++ b/bootstrap/vagrant-onap/README.md @@ -58,7 +58,7 @@ current options include: | all_in_one | All ONAP services in a VM | | testing | Unit Test VM | -#### generating documentation +#### Generating documentation The documentation of this project was written in reStructuredText format which is located under the [docs folder](../blob/master/doc/source/index.rst). @@ -71,42 +71,6 @@ This results in the creation of a new *doc/build/html* folder with the documentation converted in HTML pages that can be viewed through the prefered Web Browser. -#### Known Issues - -##### Virtualbox guest additions conflict with shared directories - -If the vagrant-vbguest plugin is installed on the host, then -an updated version of the Virtualbox guest additions will be installed -on the guest in the /opt directory. Once this projects -Vagrantfile mounts the ./opt directory on the host to the /opt -directory on the guest during the provisioning process, the -guest addtions on the guest are hidden and subsequent -mounts of shared directories with the host will fail. - -The simplest workaround appears to be uninstalling the -vagrant-vbguest plugin on the host system. This has been -observed to work on a Windows 10 host using virtualbox 5.1.26. - -Check if vagrant-vbguest plugin is installed - -Linux or Mac - - $ vagrant plugin list - -Windows - - C:\> vagrant plugin list - -Remove vagrant-vbguest plugin - -Linux or Mac - - $ vagrant plugin uninstall vagrant-vbguest - -Windows - - C:\> vagrant plugin uninstall vagrant-vbguest - ## Contributing Bug reports and patches are most welcome. diff --git a/bootstrap/vagrant-onap/Vagrantfile b/bootstrap/vagrant-onap/Vagrantfile index 3ee305c39..50c18c76b 100644 --- a/bootstrap/vagrant-onap/Vagrantfile +++ b/bootstrap/vagrant-onap/Vagrantfile @@ -81,6 +81,11 @@ Vagrant.configure("2") do |config| config.proxy.no_proxy = ENV['no_proxy'] end + if Vagrant.has_plugin?('vagrant-vbguest') + puts 'vagrant-vbguest auto_update feature will be disable to avoid sharing conflicts' + config.vbguest.auto_update = false + end + config.vm.box = 'ubuntu/trusty64' if provider == :libvirt config.vm.box = 'sputnik13/trusty64' @@ -214,27 +219,27 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :aai do |aai| aai.vm.hostname = 'aai' aai.vm.network :private_network, ip: '192.168.50.6' aai.vm.provider "openstack" do |v| v.server_name = 'aai' end - aai.vm.provision 'shell' do |s| + aai.vm.provision 'shell' do |s| s.path = 'vagrant_utils/postinstall.sh' s.args = ['aai'] s.env = conf end end - + config.vm.define :mso do |mso| mso.vm.hostname = 'mso' mso.vm.network :private_network, ip: '192.168.50.7' mso.vm.provider "openstack" do |v| v.server_name = 'mso' end - mso.vm.provision 'shell' do |s| + mso.vm.provision 'shell' do |s| s.path = 'vagrant_utils/postinstall.sh' s.args = ['mso'] s.env = conf @@ -253,7 +258,7 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :vid do |vid| vid.vm.hostname = 'vid' vid.vm.network :private_network, ip: '192.168.50.9' @@ -266,7 +271,7 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :sdnc do |sdnc| sdnc.vm.hostname = 'sdnc' sdnc.vm.network :private_network, ip: '192.168.50.10' @@ -279,7 +284,7 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :portal do |portal| portal.vm.hostname = 'portal' portal.vm.network :private_network, ip: '192.168.50.11' @@ -292,7 +297,7 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :dcae do |dcae| dcae.vm.hostname = 'dcae' dcae.vm.network :private_network, ip: '192.168.50.12' @@ -305,7 +310,7 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :policy do |policy| policy.vm.hostname = 'policy' policy.vm.network :private_network, ip: '192.168.50.13' @@ -318,7 +323,7 @@ Vagrant.configure("2") do |config| s.env = conf end end - + config.vm.define :appc do |appc| appc.vm.hostname = 'appc' appc.vm.network :private_network, ip: '192.168.50.14' diff --git a/bootstrap/vagrant-onap/doc/source/index.rst b/bootstrap/vagrant-onap/doc/source/index.rst index 2daccedda..af5777ccd 100644 --- a/bootstrap/vagrant-onap/doc/source/index.rst +++ b/bootstrap/vagrant-onap/doc/source/index.rst @@ -18,5 +18,6 @@ Table of contents :maxdepth: 2 Installation Guide + Known Issues Advanced Features diff --git a/bootstrap/vagrant-onap/doc/source/install/known_issues.rst b/bootstrap/vagrant-onap/doc/source/install/known_issues.rst new file mode 100644 index 000000000..84d50940b --- /dev/null +++ b/bootstrap/vagrant-onap/doc/source/install/known_issues.rst @@ -0,0 +1,50 @@ +============ +Known Issues +============ + +Virtualbox guest additions conflict with shared directories +----------------------------------------------------------- + +If the **vagrant-vbguest** plugin is installed on the host, then an +updated version of the Virtualbox guest additions will be installed +on the guest in the /opt directory. Once this projects Vagrantfile +mounts the ./opt directory on the host to the /opt directory on the +guest during the provisioning process, the guest addtions on the +guest are hidden and subsequent mounts of shared directories with the +host will fail. + +The simplest workaround appears to be uninstalling the +*vagrant-vbguest* plugin on the host system. This has been observed +to work on a Windows 10 host using virtualbox 5.1.26. + +Check if vagrant-vbguest plugin is installed + +- Linux or Mac + +.. code-block:: console + + $ vagrant plugin list +.. end + +- Windows + +.. code-block:: console + + C:\> vagrant plugin list +.. end + +Remove vagrant-vbguest plugin + +- Linux or Mac + +.. code-block:: console + + $ vagrant plugin uninstall vagrant-vbguest +.. end + +- Windows + +.. code-block:: console + + C:\> vagrant plugin uninstall vagrant-vbguest +.. end -- cgit 1.2.3-korg