Created vagrant configuration for Magneto 2 CE developer's environment installation

Author: Alexander Paliarush

.gitignore

@@ -0,0 +1,2 @@
+/.vagrant
+/.idea

README.md

@@ -0,0 +1,118 @@
+# Vagrant for Magento CE, optimized for Windows hosts
+
+## What You get
+
+The current Vagrant configuration aims to solve performance issues of Magento installed on Virtual Box, when the host is Windows. 
+See [explanation of the proposed solution](docs/performance-issue-on-windows-hosts.md).
+
+With current configuration Vagrant will:
+
+ 1. Run Ubuntu box
+ 1. Install and configure all software necessary for Magento 2
+ 1. Install all necessary libraries
+ 1. Install the Magento 2 application
+
+## Usage
+
+If you never used Vagrant before, read [Vagrant Docs](https://docs.vagrantup.com/v2/)
+
+### Prerequisites
+- [Vagrant](https://www.vagrantup.com/downloads.html) is installed and available globally in command line
+- [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
+
+ 1. Run in command line from the directory which contains your projects:
+ 
+     ```
+    git clone git@github.com:paliarush/vagrant-magento.git vagrant-magento
+    git clone git@github.com:magento/magento2.git magento2ce
+    cd magento2ce
+    mkdir -p var/generation
+    composer install --prefer-source
+    cd ../vagrant-magento
+    vagrant up
+     ```
+ 1. At some point you will be prompted to [set up synchronization with PHP Storm](docs/phpstorm-configuration.md)
+    and install Magento using:
+ 
+     ```
+    vagrant provision --provision-with install_magento
+     ```
+    
+###To reinstall Magento
+To save some time and get clear Magento installation, you can skip installation of software like web server or php.
+The following command will clear Magento DB, Magento caches and reinstall Magento instance.
+
+Go to 'vagrant-magento' created earlier and run in command line:
+
+```
+vagrant provision --provision-with install_magento
+```
+
+### After installation
+
+Upon a successful installation, you'll see the location and URL of the newly-installed Magento 2 application:
+```
+Magento application was deployed in /var/www/magento2 and installed
+Access front store at http://${HOST}/
+Access admin panel at http://${HOST}/${backend_frontame}/
+```
+
+`/var/www/magento2` is a path to your Magento installation on the VM.
+
+### Default credentials
+
+```
+db host: localhost (not accessible remotely)
+db user/password: magento/magento
+db name: magento
+
+also available db user/password: root/password
+
+Magento admin user/password: admin/123123q
+```
+
+### Hostname
+
+The hostname of the Magento application is derived from hostname of the VM defined in the `Vagrantfile`:
+```
+config.vm.hostname = "magento2.vagrant"
+```
+
+Change this value in the `Vagrantfile` if you want to use different hostname.
+
+If Vagrant can't determine hostname of the VM for some reason, it will use its IP address (also specified in `Vagrantfile`).
+
+Also make sure you update your system `hosts` file with a record that links the IP address and hostname of the VM.
+For the following `Vagrantfile`
+```
+...
+config.vm.network :private_network, ip: '192.168.10.11'
+config.vm.hostname = "magento2.vagrant"
+...
+```
+Specify the following in your `hosts` file:
+```
+192.168.10.11    magento2.vagrant
+```
+
+### GitHub Limitations
+
+Be aware that you may encounter GitHub limits on the number of downloads (used by Composer to download Magento dependencies).
+
+These limits may significantly slow down the installation since all of the libraries will be cloned from GitHub repositories instead of downloaded as ZIP archives. In the worst case, these limitations may even terminate the installation.
+
+If you have a GitHub account, you can bypass these limitations by using an OAuth token in the Composer configuration. See [API rate limit and OAuth tokens](https://getcomposer.org/doc/articles/troubleshooting.md#api-rate-limit-and-oauth-tokens) for more information.
+
+For the Vagrant configuration you may specify your token in `local.config/github.oauth.token` file after cloning the repository. The file is a basic text file and is ignored by Git, so you'll need to create it yourself. Simply write your OAuth token in this file making sure to avoid any empty spaces, and it will be read during deployment. You should see the following message in the Vagrant log:
+```
+Installing GitHub OAuth token from /vagrant/local.config/github.oauth.token
+```
+
+## Related Repositories
+
+- https://github.com/buskamuza/magento2-product-vagrant

Vagrantfile

@@ -0,0 +1,28 @@
+# -*- mode: ruby -*-
+# vi: set ft=ruby :
+
+# All Vagrant configuration is done below. The "2" in Vagrant.configure
+# configures the configuration version (we support older styles for
+# backwards compatibility). Please don't change it unless you know what
+# you're doing.
+Vagrant.configure(2) do |config|
+  config.vm.box = "ubuntu/trusty64"
+
+  config.vm.provider "virtualbox" do |vb|
+     vb.memory = 2048
+  end
+  config.vm.network :private_network, ip: '192.168.10.11'
+  config.vm.hostname = "magento2.vagrant"
+
+  config.vm.synced_folder '.', '/vagrant'
+  config.vm.synced_folder '../magento2ce/var/generation', '/var/www/magento2/var/generation', owner: "www-data", group: "www-data", mount_options: ["dmode=775", "fmode=775"]
+  config.vm.synced_folder '../magento2ce/app/etc', '/var/www/magento2/app/etc', owner: "www-data", group: "www-data", mount_options: ["dmode=775", "fmode=775"]
+
+  config.vm.provision "install_environment", type: "shell" do |s|
+      s.path = "bootstrap.sh"
+  end
+
+  config.vm.provision "install_magento", type: "shell" do |s|
+      s.path = "install_magento.sh"
+  end
+end

bootstrap.sh

@@ -0,0 +1,77 @@
+#!/usr/bin/env bash
+
+set -ex
+
+apt-get update
+
+# Check arguments
+#
+# Default values
+reinstall='';
+with_sample_data='';
+deploy_static_view_files='';
+for var in "$@"
+do
+    if [ "${var}" == "reinstall" ]; then
+        reinstall=true;
+    fi
+    if [ "${var}" == "with_sample_data" ]; then
+        with_sample_data=true;
+    fi
+    if [ "${var}" == "deploy_static_view_files" ]; then
+        deploy_static_view_files=true;
+    fi
+done
+
+# 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
+apache_config="/etc/apache2/sites-available/magento2.conf"
+cp /vagrant/magento2.vhost.conf  ${apache_config}
+sed -i "s/<host>/${HOST}/g" ${apache_config}
+# Enable Magento virtual host
+a2ensite magento2.conf
+# Disable default virtual host
+sudo a2dissite 000-default
+
+# Setup PHP
+apt-get install -y php5 php5-mhash php5-mcrypt php5-curl php5-cli php5-mysql php5-gd php5-intl php5-xsl curl
+if [ ! -f /etc/php5/apache2/conf.d/20-mcrypt.ini ]; then
+    ln -s /etc/php5/mods-available/mcrypt.ini /etc/php5/apache2/conf.d/20-mcrypt.ini
+fi
+if [ ! -f /etc/php5/cli/conf.d/20-mcrypt.ini ]; then
+    ln -s /etc/php5/mods-available/mcrypt.ini /etc/php5/cli/conf.d/20-mcrypt.ini
+fi
+echo "date.timezone = America/Chicago" >> /etc/php5/cli/php.ini
+
+# Restart Apache
+service apache2 restart
+
+# Setup MySQL
+debconf-set-selections <<< 'mysql-server mysql-server/root_password password password'
+debconf-set-selections <<< 'mysql-server mysql-server/root_password_again password password'
+apt-get install -q -y mysql-server-5.6 mysql-client-5.6
+
+# Setup Composer
+apt-get install -y git
+if [ ! -f /usr/local/bin/composer ]; then
+    cd /tmp
+    curl -sS https://getcomposer.org/installer | php
+    mv composer.phar /usr/local/bin/composer
+fi

docs/images/automatic-upload.png

@@ -0,0 +1,34 @@
+Desired developer experience
+----------------------------
+
+Vagrant provides convenient way to set up development environment consistently on different hosts (see [more](https://docs.vagrantup.com/v2/why-vagrant/)). Typically it uses Virtual Box as a provider with *nix system as guest OS.
+This allows Magento developers who use Windows machines to run their Magento instance in *nix environment similar to those on Bamboo or production.
+Project files editing, work with Git and running tests is usually done on host OS (Windows), since this approach provides better user experience. However, in this case project files must be synchronized between host and guest OSs to allow code modifications be visible on the running Magento instance as well as provide access to auto-generated files (e.g. view materialized files, generated classes) in the IDE. So two-way synchronization is required.
+
+Existing problem for Windows users
+----------------------------------
+
+Developers, who use Magento installed on Vagrant for daily development in Windows environment, complaint about Magento performance issues.
+The main reason for performance degradation is that default synchronization (Virtual box shared folders) is used for project files synchronization on host and on guest OSs. **PHP requests all source files from the host,** also lost of files are created by the Magento instance on the fly in non-production mode, which are immediately synchronized with the host.
+There are several other types of files synchronization available, but all of them have issues, which spoil developer experience:
+
+ - SMB - on some machines does not work (various errors, unstable
+   implementation). Also when EE is linked to CE on the host using
+   symlinks (our current workflow), **symlinks are not created properly** on
+   the guest. SSH connection to the guest OS is aborted from time to
+   time when SMB is enabled. 
+ - RSync - requires extra software to be installed on the Windows,
+   provides **one-way synchronization only**
+ - NFS - is recommended and performant option for *nix hosts, but is
+   **unavailable for Windows** hosts
+   
+Proposed solution
+-----------------
+
+Even though there are no out-of-the-box solution which satisfies our developer experience requirements, we can apply hybrid approach, which:
+
+ - is reasonably complex
+ - does not break developer experience
+ - has negligible performance degradation caused by files synchronization
+
+To solve performance degradation problem, local copy of the project should be stored on host (for good indexing performance in IDE) and on the guest (to avoid delays caused by PHP requesting remote files via network). This cannot be achieved with built-in Vagrant synchronization capabilities. However, this can be done using one-way PHPStorm project deployment to remote host or by using rsync.  This approach has one drawback: all files generated on the guest, will not be visible to IDE and as a result autocomplete for auto-generated classes will be unavailable. This issue can be overcome by enabling two-way Vagrant synchronization for those files which should be downloaded from guest OS.

docs/images/deployment-configuration.png

@@ -0,0 +1,31 @@
+Synchronization with local PHP Storm
+-----------------
+
+This solution is applicable to any Vagrant configuration for Magento instance, several tweaks should be done:
+
+ 1. Set up synchronization in vagrant config file only for those directories, which require guest-to-host synchronization (can be of any type, even default). Recommended directories are already configured in Vagrant config:
+    
+    ```
+    Vagrant.configure(2) do |config|
+      config.vm.synced_folder '../magento2ce/var/generation', '/var/www/magento2/var/generation'
+      config.vm.synced_folder '../magento2ce/app/etc', '/var/www/magento2/app/etc'
+    end
+    ```
+ 1. Open your project on host machine in PHPStorm and set up deployment configuration, which will upload to the guest machine everything except for those folders which are synchronized by Vagrant.  :information_source: Note that rsync can be used instead of PHP Storm deployment.
+     1. Go to Tools -> Deployment -> Configuration
+         ![](images/deployment-configuration.png)
+     1. Add new SFTP server and mark it as default when added (using button in top left corner)
+         ![](images/new-sftp-server.png)
+     1. Fill out connection settings using the information taken from vagrant ssh config
+         - Go to the 'vagrant-magento' directory (contains your vagrant project) in console and execute 'vagrant ssh-config'
+             ![](images/ssh-config.png)
+         - Use private key Auth type instead of password
+             ![](images/private-key-auth-type.png)
+     1. Set up mapping between your local and remote versions of the project, for remote project use '/var/www/magento2'
+         ![](images/projects-mapping.png)
+     1. Add remote paths excluded from synchronization by PHPStorm. You should add those paths which are specified in Vagrant config for synchronization. 
+         ![](images/exclude-paths-from-mapping.png)
+     1. Go to Tools -> Deployment -> Options... and enable automatic upload to default server and check "Upload external changes"
+         ![](images/automatic-upload.png)
+ 1. Upload Magento code base to the virtual machine from the host machine using context menu on the root of the project in PHPStorm
+     ![](images/upload-magento-codebase.png)