Merge pull request #57 from itk-dev/feature/nfs

Added nfs support and version command

Author: cableman

README.md

@@ -20,6 +20,17 @@ docker preferences in the via the dock icon.
 * Disk (Ensure the file has type `raw`)
 * Advanced (CPU's, Memory)
 
+From version 2.x this tool supports the usage of NFS mounted name-volumes, which
+gives faster file synchronisation during composer install and cache clear etc.
+
+It comes with a command `nfs:enable` that exports the Users directory through
+NFS to localhost, so docker can map directories into the containers. It also
+requires some changes to the docker-compose.yml files which have been updated
+to support NFS.
+
+If your project don't want to use NFS mounts you simply can remove the `nfsapp`
+volume and change the mappings back to `./` in the docker-compose.yml files.
+
 ## Usage
 
 ### Requirement for all commands to work

completion/bash/itkdev-docker-compose-completion.bash

@@ -9,7 +9,7 @@ _idc_completions()
   fi
 
   # Keep the suggestions in a local variable
-  local suggestions=($(compgen -W "url open drush template:install traefik:start traefik:stop traefik:open traefik:url mailhog:open mailhog:url sql:connect sql:port sql:open xdebug xdebug2 xdebug3 hosts:insert sync sync:db sync:files images:pull composer" -- "${COMP_WORDS[1]}"))
+  local suggestions=($(compgen -W "url open drush nfs:enable template:install traefik:start traefik:stop traefik:open traefik:url mailhog:open mailhog:url sql:connect sql:port sql:open xdebug xdebug2 xdebug3 hosts:insert sync sync:db sync:files images:pull composer version bin/console" -- "${COMP_WORDS[1]}"))
 
   COMPREPLY=("${suggestions[@]}")
 

completion/zsh/_itkdev-docker-compose

@@ -30,6 +30,7 @@ _itkdev-docker-compose() {
               'url[Print url to site.]' \
               'open[Open url in default browser.]' \
               'drush[Run drush command.]' \
+              'nfs\:enable[Enable NFS volume sharing.]' \
               'sync[Sync both database and files.]' \
               'sync\:db[Sync database base.]' \
               'sync\:files[Sync files base.]' \
@@ -49,6 +50,7 @@ _itkdev-docker-compose() {
               'hosts\:insert[Insert the docker site url into the hosts file.]' \
               'images\:pull[Update/pull all docker images.]' \
               'composer[Run composer command inside phpfpm container.]' \
+              'version[Display this tool'\''s current version.]' \
         && ret=0
 
       # 'bin'{bin/*,vendor/bin/*}'[Run command command inside phpfpm container]' \

scripts/itkdev-docker-compose

@@ -1,4 +1,5 @@
 #!/usr/bin/env bash
+VERSION=2.0.0
 set -o errexit -o errtrace -o noclobber -o nounset -o pipefail
 IFS=$'\n\t'
 
@@ -104,6 +105,26 @@ EOF
   fi
 }
 
+function enableNFS {
+  echo "Setting up NFS..."
+  U=`id -u`
+  G=`id -g`
+
+  LINE="/System/Volumes/Data/Users -alldirs -mapall=$U:$G localhost"
+  FILE=/etc/exports
+  sudo touch $FILE
+  grep -qF -- "$LINE" "$FILE" || sudo echo "$LINE" | sudo tee -a $FILE > /dev/null
+
+  LINE="nfs.server.mount.require_resv_port = 0"
+  FILE=/etc/nfs.conf
+  grep -qF -- "$LINE" "$FILE" || sudo echo "$LINE" | sudo tee -a $FILE > /dev/null
+
+  echo "Restarting nfsd..."
+  sudo nfsd restart
+
+  echo "You should restart docker to ensure NFS mounts works..."
+}
+
 bold=$(tput bold)
 normal=$(tput sgr0)
 
@@ -125,6 +146,9 @@ Commands:
                 container. Otherwise, the drush container is used to
                 run the command.
 
+  nfs:enable
+                Enable support for NFS shares (performance boost on Macs)
+
   sync
                 Sync both database and files.
 
@@ -196,6 +220,9 @@ Commands:
   down
                 Stop and remove containers, networks, images, and volumes
 
+  version
+                Display this tool's current version
+
   *
                 Pass command and arguments to `docker-compose` and
                 hope for the best.
@@ -239,6 +266,24 @@ if [[ "$#" -gt "0" && "$1" == "template:install" ]]; then
   exit
 fi
 
+# Allow nfs:enable without existence of docker-compose.yml.
+if [[ "$#" -gt "0" && "$1" == "nfs:enable" ]]; then
+  enableNFS
+  exit
+fi
+
+# Allow version without existence of docker-compose.yml.
+if [[ "$#" -gt "0" && "$1" == "version" ]]; then
+  echo Version: ${VERSION}
+  exit
+fi
+
+# Allow help without existence of docker-compose.yml.
+if [[ "$#" -gt "0" && "$1" == "--help" ]]; then
+  usage
+  exit
+fi
+
 # @see https://unix.stackexchange.com/questions/13464/is-there-a-way-to-find-a-file-in-an-inverse-recursive-search/13474
 upsearch () {
   slashes=${PWD//[^\/]/}
@@ -551,11 +596,6 @@ EOF
     docker_compose exec "$@" /usr/bin/env sh
     ;;
 
-  --help)
-    usage
-    exit
-    ;;
-
   *)
     docker_compose "$cmd" "$@"
     ;;

templates/aakbcms/docker-compose.yml

@@ -37,7 +37,7 @@ services:
     depends_on:
       - mariadb
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
       - drush-cache:/root/.drush
 
   nginx:
@@ -52,7 +52,7 @@ services:
       - '80'
     volumes:
       - ${PWD}/.docker/vhost.conf:/etc/nginx/conf.d/default.conf:ro
-      - ./:/app:delegated
+      - nfsApp:/app:delegated
     labels:
       - "traefik.enable=true"
       - "traefik.docker.network=frontend"
@@ -91,15 +91,25 @@ services:
       - drush
     volumes:
       - drush-cache:/root/.drush
-      - ./:/app
+      - nfsApp:/app
 
   node:
     image: node:6
     networks:
       - app
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
 
-# Drush cache volume to persist cache between runs.
 volumes:
+  # Drush cache volume to persist cache between runs.
   drush-cache:
+  # Named volume requires that you have NFS shares enabled (performance boost on Macs).
+  # Use `itkdev-docker-compose nfs:enable` to enable NFS shares. If you don't want to use it remove it from here and
+  # change the volume mapping to use normal shares in the containers. See
+  # https://sean-handley.medium.com/how-to-set-up-docker-for-mac-with-native-nfs-145151458adc
+  nfsApp:
+    driver: local
+    driver_opts:
+      type: nfs
+      o: addr=host.docker.internal,rw,nolock,hard,nointr,nfsvers=3
+      device: ":$PWD"

templates/ddbcms/docker-compose.yml

@@ -10,7 +10,7 @@ networks:
 
 services:
   mariadb:
-    image: ding2/ding2-mysql
+    image: ding2/ding2-mysql:master
     networks:
       - app
       - frontend
@@ -37,7 +37,7 @@ services:
     depends_on:
       - mariadb
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
       - drush-cache:/root/.drush
 
   nginx:
@@ -52,7 +52,7 @@ services:
       - '80'
     volumes:
       - ${PWD}/.docker/vhost.conf:/etc/nginx/conf.d/default.conf:ro
-      - ./:/app:delegated
+      - nfsApp:/app:delegated
     labels:
       - "traefik.enable=true"
       - "traefik.docker.network=frontend"
@@ -91,15 +91,25 @@ services:
       - drush
     volumes:
       - drush-cache:/root/.drush
-      - ./:/app
+      - nfsApp:/app
 
   node:
     image: node:6
     networks:
       - app
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
 
-# Drush cache volume to persist cache between runs.
 volumes:
+  # Drush cache volume to persist cache between runs.
   drush-cache:
+  # Named volume requires that you have NFS shares enabled (performance boost on Macs).
+  # Use `itkdev-docker-compose nfs:enable` to enable NFS shares. If you don't want to use it remove it from here and
+  # change the volume mapping to use normal shares in the containers. See
+  # https://sean-handley.medium.com/how-to-set-up-docker-for-mac-with-native-nfs-145151458adc
+  nfsApp:
+    driver: local
+    driver_opts:
+      type: nfs
+      o: addr=host.docker.internal,rw,nolock,hard,nointr,nfsvers=3
+      device: ":$PWD"

templates/drupal-7/docker-compose.yml

@@ -1,4 +1,4 @@
-# itk-version: 1.0.1
+# itk-version: 2.0.0
 version: "3"
 
 networks:
@@ -37,7 +37,7 @@ services:
       - mariadb
       - memcached
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
 
   nginx:
     image: nginx:latest
@@ -50,7 +50,7 @@ services:
       - '80'
     volumes:
       - ${PWD}/.docker/vhost.conf:/etc/nginx/conf.d/default.conf:ro
-      - ./:/app:delegated
+      - nfsApp:/app:delegated
     labels:
       - "traefik.enable=true"
       - "traefik.docker.network=frontend"
@@ -89,8 +89,18 @@ services:
       - drush
     volumes:
       - drush-cache:/root/.drush
-      - ./:/app
+      - nfsApp:/app
 
-# Drush cache volume to persist cache between runs.
 volumes:
+  # Drush cache volume to persist cache between runs.
   drush-cache:
+  # Named volume requires that you have NFS shares enabled (performance boost on Macs).
+  # Use `itkdev-docker-compose nfs:enable` to enable NFS shares. If you don't want to use it remove it from here and
+  # change the volume mapping to use normal shares in the containers. See
+  # https://sean-handley.medium.com/how-to-set-up-docker-for-mac-with-native-nfs-145151458adc
+  nfsApp:
+    driver: local
+    driver_opts:
+      type: nfs
+      o: addr=host.docker.internal,rw,nolock,hard,nointr,nfsvers=3
+      device: ":$PWD"

templates/drupal-8/docker-compose.yml

@@ -1,4 +1,4 @@
-# itk-version: 1.0.1
+# itk-version: 2.0.0
 version: "3"
 
 networks:
@@ -38,7 +38,7 @@ services:
       - mariadb
       - memcached
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
       - drush-cache:/root/.drush
 
   nginx:
@@ -52,7 +52,7 @@ services:
       - '80'
     volumes:
       - ${PWD}/.docker/vhost.conf:/etc/nginx/conf.d/default.conf:ro
-      - ./:/app:delegated
+      - nfsApp:/app:delegated
     labels:
       - "traefik.enable=true"
       - "traefik.docker.network=frontend"
@@ -80,3 +80,15 @@ services:
       - "traefik.docker.network=frontend"
       - "traefik.http.routers.${COMPOSE_PROJECT_NAME}Mailhog.rule=Host(`mailhog-${COMPOSE_DOMAIN}`)"
       - "traefik.http.services.${COMPOSE_PROJECT_NAME}Mailhog.loadbalancer.server.port=8025"
+
+volumes:
+  # Named volume requires that you have NFS shares enabled (performance boost on Macs).
+  # Use `itkdev-docker-compose nfs:enable` to enable NFS shares. If you don't want to use it remove it from here and
+  # change the volume mapping to use normal shares in the containers. See
+  # https://sean-handley.medium.com/how-to-set-up-docker-for-mac-with-native-nfs-145151458adc
+  nfsApp:
+    driver: local
+    driver_opts:
+      type: nfs
+      o: addr=host.docker.internal,rw,nolock,hard,nointr,nfsvers=3
+      device: ":$PWD"

templates/drupal-9/docker-compose.yml

@@ -1,4 +1,4 @@
-# itk-version: 1.0.1
+# itk-version: 2.0.0
 version: "3"
 
 networks:
@@ -38,7 +38,7 @@ services:
       - mariadb
       - memcached
     volumes:
-      - .:/app:delegated
+      - nfsApp:/app:delegated
       - drush-cache:/root/.drush
 
   nginx:
@@ -52,7 +52,7 @@ services:
       - '80'
     volumes:
       - ${PWD}/.docker/vhost.conf:/etc/nginx/conf.d/default.conf:ro
-      - ./:/app:delegated
+      - nfsApp:/app:delegated
     labels:
       - "traefik.enable=true"
       - "traefik.docker.network=frontend"
@@ -80,3 +80,15 @@ services:
       - "traefik.docker.network=frontend"
       - "traefik.http.routers.${COMPOSE_PROJECT_NAME}Mailhog.rule=Host(`mailhog-${COMPOSE_DOMAIN}`)"
       - "traefik.http.services.${COMPOSE_PROJECT_NAME}Mailhog.loadbalancer.server.port=8025"
+
+volumes:
+  # Named volume requires that you have NFS shares enabled (performance boost on Macs).
+  # Use `itkdev-docker-compose nfs:enable` to enable NFS shares. If you don't want to use it remove it from here and
+  # change the volume mapping to use normal shares in the containers. See
+  # https://sean-handley.medium.com/how-to-set-up-docker-for-mac-with-native-nfs-145151458adc
+  nfsApp:
+    driver: local
+    driver_opts:
+      type: nfs
+      o: addr=host.docker.internal,rw,nolock,hard,nointr,nfsvers=3
+      device: ":$PWD"