Varnish Support

- Works now by invoking vagrant reload or by running "m-varnish -c enable" command.

Author: Hayder Sharhan

CHANGELOG.md

@@ -27,6 +27,7 @@ This project adheres to [Semantic Versioning](http://semver.org/).
  - Added ability to modify guest config files (PHP, Apache etc) directly from host IDE
  - Added ability to choose if PhpStorm configs should be removed during project reinitialization
  - Added ability to switch PHP version without destroying the project ("vagrant reload" is required)
+ - Added ability to use Varnish full page caching automatically. (Using "vagrant reload" or m-varnish script)
 
 ## [v2.0.0] - 2016-02-05
 

README.md

@@ -228,7 +228,7 @@ PHP version will be applied after "vagrant reload".
 ### Activating Varnish
 
 Set "use_varnish: 1" to use varnish along apache in [config.yaml](etc/config.yaml.dist).
-Running m-reinstall script will apply your preference.
+Running vagrant reload will apply your preference. Or by using m-varnish script.
 It will use default file etc/magento2_default_varnish.vcl.dist generated from a Magento instance.
 Varnish Version: 3.0.5
 

etc/config.yaml.dist

@@ -1,20 +1,26 @@
 repository_url:
+  # [Changeable: init-project -c]
   ce: "git@github.com:magento/magento2.git"
   ee: ""
 guest:
-  # NFS will be used for folder synchronization on *nix and OSX hosts by default
+  # [Changeable: init-project -f]
+  # NFS will be used for folder synchronization on *nix and OSX hosts by default.
   use_nfs: 1
-  # Default is 2Gb, around 3Gb is necessary to run functional tests
+  # Default is 2Gb, around 3Gb is necessary to run functional tests.
+  # [Changeable: vagrant reload]
   memory: 2048
   ip_address: "192.168.10.2"
   forwarded_ssh_port: 3000
 environment:
-  # If set to 0, PHP 5 will be installed. [Changeable: vagrant reload]
+  # [Changeable: vagrant reload]
+  # If set to 0, PHP 5 will be installed.
   use_php7: 1
   composer_prefer_source: 0
   use_varnish: 0
 magento:
+  # [Changeable: init-project -f]
   host_name: "magento2.vagrant2"
+  # [Changeable: m-reinstall]
   admin_frontname: "admin"
   language: "en_US"
   timezone: "America/Chicago"

m-varnish

@@ -0,0 +1,41 @@
+#!/usr/bin/env bash
+
+set -ex
+
+# Get args
+while getopts 'fh:c:' flag; do
+  case "${flag}" in
+    h) help=1 ;;
+    c) command=$OPTARG ;;
+    f) force_restart_services=1 ;;
+    *) help=1 ;;
+  esac
+done
+
+if [ $help ]; then
+    echo "Usage: ./m-varnish -c enable/disable (-f to force restart services)"
+    exit 0
+fi
+
+# Check if user created config.yaml file
+if [ ! -f ./etc/config.yaml ]; then
+    echo "Please make sure you have create a config.yaml file copy from etc/config.yaml.dist"
+    exit 0
+fi
+
+if [[ $command == "enable" ]]; then
+    sed -ie "s/use_varnish:.*/use_varnish: 1/" ./etc/config.yaml
+elif [[ $command == "disable" ]]; then
+    sed -ie "s/use_varnish:.*/use_varnish: 0/" ./etc/config.yaml
+else
+    echo "Usage: ./m-varnish -c enable/disable (-f to force restart services)"
+    exit 0
+fi
+
+vagrant_dir=$(cd "$(dirname "$0")"; pwd)
+cd ${vagrant_dir}
+if [[ $force_restart_services == 1 ]]; then
+    vagrant ssh -c "sudo bash /vagrant/scripts/guest/configure_varnish -f"
+else
+    vagrant ssh -c "sudo bash /vagrant/scripts/guest/configure_varnish"
+fi

scripts/guest/m-reinstall-scripts/configure_varnish renamed to scripts/guest/configure_varnish

@@ -3,6 +3,14 @@
 # Enable trace printing and exit on the first error
 set -ex
 
+# Get args
+while getopts 'f' flag; do
+  case "${flag}" in
+    f) force_restart_services=1 ;;
+    *) error "Unexpected option ${flag}" ;;
+  esac
+done
+
 # Init environment variables
 vagrant_dir="/vagrant"
 
@@ -29,6 +37,7 @@ if [ $use_varnish -eq 1 ]; then
     mysql -D magento -e "INSERT INTO core_config_data
         ( scope, scope_id, path, value ) VALUES
         ( 'default', '0', 'system/full_page_cache/caching_application', '2' )
+         ON DUPLICATE KEY UPDATE value = 2
     ;"
 else
 
@@ -45,9 +54,20 @@ else
         sudo sed -ie "s/Listen 8080/Listen 80/" /etc/apache2/ports.conf
         restart_services=1
     fi
+
+    # Update Magento database to not use varnish FPC
+    mysql -D magento -e "INSERT INTO core_config_data
+        ( scope, scope_id, path, value ) VALUES
+        ( 'default', '0', 'system/full_page_cache/caching_application', '1' )
+         ON DUPLICATE KEY UPDATE value = 1
+    ;"
 fi
 
 # Check if need restart services
+if [[ $force_restart_services == 1 ]]; then
+    echo "Force restarting Apache and Varnish"
+    restart_services=1
+fi
 if [ $restart_services -eq 1 ]; then
     if [ "$(ps -ax | pgrep varnish)" ]; then
         sudo pkill varnishd

scripts/guest/m-reinstall

@@ -77,9 +77,6 @@ php ${install_cmd}
 # Comment out the line above and uncomment the one below to debug Magento Setup script
 # php -d xdebug.remote_host=192.168.10.1 -d xdebug.idekey=PHPSTORM -d xdebug.remote_connect_back=0 -d xdebug.remote_autostart=1 ${install_cmd}
 
-# Configure Varnish FPC, if enabled
-sh ${vagrant_dir}/scripts/guest/m-reinstall-scripts/configure_varnish
-
 # Enable Magento cron jobs
 echo "* * * * * php ${MAGENTO_ROOT}/bin/magento cron:run &" | crontab -u vagrant -
 

scripts/provision/configure_environment.sh

@@ -29,15 +29,6 @@ a2ensite magento2.conf
 # Disable default virtual host
 sudo a2dissite 000-default
 
-# Copy varnish vcl file
-custom_vcl_config="${vagrant_dir}/etc/magento2_default_varnish.vcl"
-default_vcl_config="${vagrant_dir}/etc/magento2_default_varnish.vcl.dist"
-if [ -f ${custom_vcl_config} ]; then
-    cp ${custom_vcl_config}  /etc/varnish/default.vcl
-else
-    cp ${default_vcl_config}  /etc/varnish/default.vcl
-fi
-
 # Configure composer
 composer_auth_json="${vagrant_dir}/etc/composer/auth.json"
 if [ -f ${composer_auth_json} ]; then

scripts/provision/configure_environment_recurring.sh

@@ -54,6 +54,18 @@ if [ -f ${vagrant_dir}/.idea/deployment.xml ]; then
     sed -i.back "s|magento2ce/var/generation|magento2ce/var|g" "${vagrant_dir}/.idea/deployment.xml"
 fi
 
+# Copy varnish vcl file
+custom_vcl_config="${vagrant_dir}/etc/magento2_default_varnish.vcl"
+default_vcl_config="${vagrant_dir}/etc/magento2_default_varnish.vcl.dist"
+if [ -f ${custom_vcl_config} ]; then
+    cp ${custom_vcl_config}  /etc/varnish/default.vcl
+else
+    cp ${default_vcl_config}  /etc/varnish/default.vcl
+fi
+
+# Configure Varnish FPC, if enabled
+bash ${vagrant_dir}/scripts/guest/configure_varnish -f
+
 # Setup PHP
 php_ini_paths=( /etc/php/7.0/cli/php.ini /etc/php/5.6/cli/php.ini )
 process_php_config ${php_ini_paths}