- Integrated vagrant host manager plugin support to allow automatic /etc/hosts update

- Refined readme.md

Author: Alexander Paliarush

README.md

@@ -1,5 +1,16 @@
 # Vagrant project for Magento 2 developers (optimized for Mac, Windows and \*nix hosts)
 
+ * [What You get](#what-you-get)
+ * [How to install](#how-to-install)
+   * [Requirements](#requirements)
+   * [Installation steps](#installation-steps)
+   * [Default credentials and settings](#default-credentials-and-settings)
+   * [GitHub limitations](#github-limitations)
+ * [Day-to-day development scenarios](#day-to-day-development-scenarios)
+   * [Reinstall Magento](#reinstall-magento)
+   * [Clear magento cache](#clear-magento-cache)
+   * [Debugging with XDebug](#debugging-with-xdebug)
+
 ## What You get
 
 It is expected that Magento 2 project source code will be located on the host and managed using [Composer](https://getcomposer.org/doc/00-intro.md). 
@@ -14,18 +25,19 @@ With current configuration Vagrant will:
  1. Install and configure all software necessary for Magento 2
  1. Install the Magento 2 application
 
-## Environment set up workflow
+## How to install
 
 If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com/v2/)
 
-### Prerequisites
+### Requirements
 - [Vagrant](https://www.vagrantup.com/downloads.html) is installed and available globally in command line
+- [Host manager plugin for Vagrant](https://github.com/smdahlen/vagrant-hostmanager)
 - [VirtualBox](https://www.virtualbox.org/wiki/Downloads)
 - [Composer](https://getcomposer.org/doc/00-intro.md) is installed and is available globally in command line
 - Make sure you have SSH keys generated and associated with your github account, see [manual](https://help.github.com/articles/generating-ssh-keys/).
 :information_source: You can use another way of getting codebase instead of cloning, it does not matter for successful installation.
 
-### To install the whole image from scratch
+### Installation steps
 
  1. Run in command line from the directory which contains your projects:
      1. Prepare Magento codebase. This step is optional, just ensure you have 'magento2ce' directory with Magento code available.
@@ -47,26 +59,18 @@ If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com
         cd vagrant-magento
         vagrant up
         ```
- 1. Add corresponding record to your `hosts` file on the host machine:
- 
-    ```
-    192.168.10.11 magento2.vagrant
-    ```
  1. For **Windows hosts only**: after the installation is complete, [set up synchronization with PHP Storm](docs/phpstorm-configuration-windows-hosts.md)
 
-### After installation
-
-Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application in console.
-See a list of [default credentials and settings](README.md#default-credentials).
-
 ### Default credentials and settings
+Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application in console.
 
-Web access:
+**Web access**:
 - Access storefront at `http://magento2.vagrant`
 - Access admin panel at `http://magento2.vagrant/admin/`
 - Magento admin user/password: `admin/123123q`
+- Rabbit MQ control panel: `http://magento2.vagrant:15672`, credentials `guest`/`guest`
 
-Codebase and DB access:
+**Codebase and DB access**:
 - Path to your Magento installation on the VM:
   - Can be retrieved from environment variable: `echo ${MAGENTO_ROOT}`
   - On Windows hosts: `/var/www/magento2ce`
@@ -75,7 +79,7 @@ Codebase and DB access:
 - MySQL DB name: `magento`, `magento_integration_tests`
 - MySQL DB user/password: just use `mysql` with no user and password (`root/password` will be used by default)
 
-### GitHub Limitations
+### GitHub limitations
 
 Be aware that you may encounter GitHub limits on the number of downloads (used by Composer to download Magento dependencies).
 

Vagrantfile

@@ -9,6 +9,8 @@ end
 
 require 'pathname.rb'
 host_magento_dir = Pathname.new(Dir.pwd + '/../magento2ce').realpath.to_s
+magento_host_name = 'magento2.vagrant'
+magento_ip_address = '192.168.10.11'
 
 # All Vagrant configuration is done below. The "2" in Vagrant.configure
 # configures the configuration version (we support older styles for
@@ -20,8 +22,6 @@ Vagrant.configure(2) do |config|
     config.vm.provider "virtualbox" do |vb|
         vb.memory = 3072 # Around 3Gb is necessary to be able to run tests
     end
-    config.vm.network :private_network, ip: '192.168.10.11'
-    config.vm.hostname = "magento2.vagrant"
 
     config.vm.synced_folder '.', '/vagrant'
     if OS.is_windows
@@ -33,12 +33,14 @@ Vagrant.configure(2) do |config|
         config.vm.synced_folder host_magento_dir, guest_magento_dir, type: "nfs"
     end
 
+    shell_script_args = [
+        OS.is_windows ? "1" : "0",
+        guest_magento_dir,
+        magento_host_name
+    ]
     config.vm.provision "install_environment", type: "shell" do |s|
         s.path = "install_environment.sh"
-        s.args = [
-            OS.is_windows ? "1" : "0",
-            guest_magento_dir
-        ]
+        s.args = shell_script_args
     end
 
     if OS.is_windows
@@ -47,9 +49,16 @@ Vagrant.configure(2) do |config|
 
     config.vm.provision "install_magento", type: "shell" do |s|
         s.path = "install_magento.sh"
-        s.args = [
-            OS.is_windows ? "1" : "0",
-            guest_magento_dir
-        ]
+        s.args = shell_script_args
+    end
+
+    # Host manager plugin configuration
+    config.hostmanager.enabled = true
+    config.hostmanager.manage_host = true
+    config.hostmanager.ignore_private_ip = false
+    config.hostmanager.include_offline = true
+    config.vm.define magento_host_name do |node|
+        node.vm.hostname = magento_host_name
+        node.vm.network :private_network, ip: magento_ip_address
     end
 end

install_environment.sh

@@ -5,25 +5,10 @@ set -ex
 
 is_windows_host=$1
 guest_magento_dir=$2
+magento_host_name=$3
 
 apt-get update
 
-# Determine external IP address
-set +x
-ip=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
-echo "IP address is '${ip}'"
-set -x
-
-# Determine hostname for Magento web-site
-host=`hostname -f`
-if [ -z ${host} ]; then
-    # Use external IP address as hostname
-    set +x
-    host=${ip}
-    echo "Use IP address '${host}' as hostname"
-    set -x
-fi
-
 # Setup Apache
 apt-get install -y apache2
 a2enmod rewrite
@@ -34,7 +19,7 @@ sed -i 's|www-data|vagrant|g' /etc/apache2/envvars
 # Enable Magento virtual host
 apache_config="/etc/apache2/sites-available/magento2.conf"
 cp /vagrant/magento2.vhost.conf  ${apache_config}
-sed -i "s|<host>|${host}|g" ${apache_config}
+sed -i "s|<host>|${magento_host_name}|g" ${apache_config}
 sed -i "s|<guest_magento_dir>|${guest_magento_dir}|g" ${apache_config}
 a2ensite magento2.conf
 

install_magento.sh

@@ -7,22 +7,7 @@ set -ex
 
 is_windows_host=$1
 guest_magento_dir=$2
-
-# Determine external IP address
-set +x
-ip=`ifconfig eth1 | grep inet | awk '{print $2}' | sed 's/addr://'`
-echo "IP address is '${ip}'"
-set -x
-
-# Determine hostname for Magento web-site
-host=`hostname -f`
-if [ -z ${host} ]; then
-    # Use external IP address as hostname
-    set +x
-    host=${ip}
-    echo "Use IP address '${host}' as hostname"
-    set -x
-fi
+magento_host_name=$3
 
 cd ${guest_magento_dir}
 
@@ -48,7 +33,7 @@ install_cmd="./bin/magento setup:install \
     --db-name=magento \
     --db-user=root \
     --backend-frontname=${admin_frontame} \
-    --base-url=http://${host}/ \
+    --base-url=http://${magento_host_name}/ \
     --language=en_US \
     --timezone=America/Chicago \
     --currency=USD \
@@ -82,10 +67,8 @@ fi
 set +x
 echo "
 Magento application was deployed to ${guest_magento_dir} and installed successfully
-Access storefront at http://${host}/
-Access admin panel at http://${host}/${admin_frontame}/
-
-Don't forget to update your 'hosts' file with '${ip} ${host}'"
+Access storefront at http://${magento_host_name}/
+Access admin panel at http://${magento_host_name}/${admin_frontame}/"
 
 if [ ${is_windows_host} -eq 1 ]; then
     echo "