Skip to content

Instantly share code, notes, and snippets.

@mcrumm
Created April 6, 2016 18:05
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
Star You must be signed in to star a gist
Save mcrumm/37aa19ed101e9f0ae269ba5b576ac671 to your computer and use it in GitHub Desktop.
#!/bin/sh
#
# The MIT License (MIT)
# Copyright © 2015 Toni Van de Voorde <toni.vdv@gmail.com>
#
# Permission is hereby granted, free of charge, to any person obtaining a copy
# of this software and associated documentation files (the “Software”), to deal
# in the Software without restriction, including without limitation the rights
# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
# copies of the Software, and to permit persons to whom the Software is
# furnished to do so, subject to the following conditions:
#
# The above copyright notice and this permission notice shall be included in
# all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
# THE SOFTWARE.
#
set -o errexit
# BEGIN _functions
# @info: Prints the usage
usage ()
{
cat <<EOF
Usage: $0 <machine-name> [options]
Options:
-f, --force Force reconfiguration of nfs
-n, --nfs-config NFS configuration to use in /etc/exports. (default to '-alldirs -mapall=\$(id -u):\$(id -g)')
-s, --shared-folder,... Folder to share (default to /Users)
Examples:
$ docker-machine-nfs test
> Configure the /Users folder with NFS
$ docker-machine-nfs test --shared-folder=/Users --shared-folder=/var/www
> Configures the /Users and /var/www folder with NFS
$ docker-machine-nfs test --shared-folder=/var/www --nfs-config="-alldirs -maproot=0"
> Configure the /var/www folder with NFS and the options '-alldirs -maproot=0'
EOF
exit 0
}
# @info: Prints error messages
# @args: error-message
echoError ()
{
echo "\033[0;31mFAIL\n\n$1 \033[0m"
}
# @info: Prints warning messages
# @args: warning-message
echoWarn ()
{
echo "\033[0;33m$1 \033[0m"
}
# @info: Prints success messages
# @args: success-message
echoSuccess ()
{
echo "\033[0;32m$1 \033[0m"
}
# @info: Prints check messages
# @args: success-message
echoInfo ()
{
printf "\033[1;34m[INFO] \033[0m$1"
}
# @info: Prints property messages
# @args: property-message
echoProperties ()
{
echo "\t\033[0;35m- $1 \033[0m"
}
# @info: Checks if a given property is set
# @return: true, if variable is not set; else false
isPropertyNotSet()
{
if [ -z ${1+x} ]; then return 0; else return 1; fi
}
# @info: Sets the default properties
setPropDefaults()
{
prop_machine_name=
prop_shared_folders=()
prop_nfs_config="-alldirs -mapall="$(id -u):$(id -g)
prop_force_configuration_nfs=false
}
# @info: Parses and validates the CLI arguments
parseCli()
{
[ "$#" -ge 1 ] || usage
prop_machine_name=$1
for i in "${@:2}"
do
case $i in
-s=*|--shared-folder=*)
local shared_folder="${i#*=}"
shift
if [ ! -d "$shared_folder" ]; then
echoError "Given shared folder '$shared_folder' does not exist!"
exit 1
fi
prop_shared_folders+=($shared_folder)
;;
-n=*|--nfs-config=*)
prop_nfs_config="${i#*=}"
;;
-f|--force)
prop_force_configuration_nfs=true
shift
;;
*)
echoError "Unknown argument '$i' given"
echo #EMPTY
usage
;;
esac
done
if [ ${#prop_shared_folders[@]} -eq 0 ]; then
prop_shared_folders+=("/Users")
fi;
echoInfo "Configuration:"
echo #EMPTY
echo #EMPTY
echoProperties "Machine Name: $prop_machine_name"
for shared_folder in "${prop_shared_folders[@]}"
do
echoProperties "Shared Folder: $shared_folder"
done
echoProperties "Force: $prop_force_configuration_nfs"
echo #EMPTY
}
# @info: Checks if the machine is present
# @args: machine-name
# @return: (none)
checkMachinePresence ()
{
echoInfo "machine presence ... \t\t\t"
if [ "" = "$(docker-machine ls | sed 1d | grep -w "$1")" ]; then
echoError "Could not find the machine '$1'!"; exit 1;
fi
echoSuccess "OK"
}
# @info: Checks if the machine is running
# @args: machine-name
# @return: (none)
checkMachineRunning ()
{
echoInfo "machine running ... \t\t\t"
machine_state=$(docker-machine ls | sed 1d | grep "^$1\s" | awk '{print $4}')
if [ "Running" != "${machine_state}" ]; then
echoError "The machine '$1' is not running but '${machine_state}'!";
exit 1;
fi
echoSuccess "OK"
}
# @info: Returns the driver used to create the machine
# @args: machine-name
# @return: The driver used to create the machine
getMachineDriver ()
{
docker-machine ls | sed 1d | grep "^$1\s" | awk '{print $3}'
}
# @info: Loads mandatory properties from the docker machine
lookupMandatoryProperties ()
{
echoInfo "Lookup mandatory properties ... "
prop_machine_ip=$(docker-machine ip $1)
prop_machine_driver=$(getMachineDriver $1)
if [ "$prop_machine_driver" = "vmwarefusion" ]; then
prop_network_id="Shared"
prop_nfshost_ip=$(ifconfig -m `route get 8.8.8.8 | awk '{if ($1 ~ /interface:/){print $2}}'` | awk 'sub(/inet /,""){print $1}')
prop_machine_ip=$prop_nfshost_ip
if [ "" = "${prop_nfshost_ip}" ]; then
echoError "Could not find the vmware fusion net IP!"; exit 1
fi
local nfsd_line="nfs.server.mount.require_resv_port = 0"
echoSuccess "\t\tOK"
echoInfo "Check NFS config settings ... \n"
if [ "$(grep -Fxq "$nfsd_line" /etc/nfs.conf)" == "0" ]; then
echoInfo "/etc/nfs.conf is setup correctly!"
else
echoWarn "\n !!! Sudo will be necessary for editing /etc/nfs.conf !!!"
# Backup /etc/nfs.conf file
sudo cp /etc/nfs.conf /etc/nfs.conf.bak && \
echo "nfs.server.mount.require_resv_port = 0" | \
sudo tee /etc/nfs.conf > /dev/null
echoWarn "\n !!! Backed up /etc/nfs.conf to /nfs.conf.bak !!!"
echoWarn "\n !!! Added 'nfs.server.mount.require_resv_port = 0' to /etc/nfs.conf !!!"
fi
echoSuccess "\n\t\t\t\t\t\tOK"
return
fi
if [ "$prop_machine_driver" = "parallels" ]; then
prop_network_id="Shared"
prop_nfshost_ip=$(prlsrvctl net info \
"${prop_network_id}" | grep 'IPv4 address' | sed 's/.*: //')
if [ "" = "${prop_nfshost_ip}" ]; then
echoError "Could not find the parallels net IP!"; exit 1
fi
echoSuccess "OK"
return
fi
if [ "$prop_machine_driver" != "virtualbox" ]; then
echoError "Unsupported docker-machine driver: $prop_machine_driver"; exit 1
fi
prop_network_id=$(VBoxManage showvminfo $1 --machinereadable |
grep hostonlyadapter | cut -d'"' -f2)
if [ "" = "${prop_network_id}" ]; then
echoError "Could not find the virtualbox net name!"; exit 1
fi
prop_nfshost_ip=$(VBoxManage list hostonlyifs |
grep "${prop_network_id}" -A 3 | grep IPAddress |
cut -d ':' -f2 | xargs);
if [ "" = "${prop_nfshost_ip}" ]; then
echoError "Could not find the virtualbox net IP!"; exit 1
fi
echoSuccess "OK"
}
# @info: Configures the NFS
configureNFS()
{
echoInfo "Configure NFS ... \n"
if isPropertyNotSet $prop_machine_ip; then
echoError "'prop_machine_ip' not set!"; exit 1;
fi
echoWarn "\n !!! Sudo will be necessary for editing /etc/exports !!!"
for shared_folder in "${prop_shared_folders[@]}"
do
# Update the /etc/exports file and restart nfsd
(
echo '\n'$shared_folder' '$prop_machine_ip' '$prop_nfs_config'\n' |
sudo tee -a /etc/exports && awk '!a[$0]++' /etc/exports |
sudo tee /etc/exports
) > /dev/null
done
sudo nfsd restart ; sleep 2 && sudo nfsd checkexports
echoSuccess "\t\t\t\t\t\tOK"
}
# @info: Configures the VirtualBox Docker Machine to mount nfs
configureBoot2Docker()
{
echoInfo "Configure Docker Machine ... \t\t"
if isPropertyNotSet $prop_machine_name; then
echoError "'prop_machine_name' not set!"; exit 1;
fi
if isPropertyNotSet $prop_nfshost_ip; then
echoError "'prop_nfshost_ip' not set!"; exit 1;
fi
# render bootlocal.sh and copy bootlocal.sh over to Docker Machine
# (this will override an existing /var/lib/boot2docker/bootlocal.sh)
local bootlocalsh='#!/bin/sh
sudo umount /Users'
for shared_folder in "${prop_shared_folders[@]}"
do
bootlocalsh="${bootlocalsh}
sudo mkdir -p "$shared_folder
done
bootlocalsh="${bootlocalsh}
sudo /usr/local/etc/init.d/nfs-client start"
for shared_folder in "${prop_shared_folders[@]}"
do
bootlocalsh="${bootlocalsh}
sudo mount -t nfs -o nolock,vers=3,udp,noatime,actimeo=2 "$prop_nfshost_ip":"$shared_folder" "$shared_folder
done
local file="/var/lib/boot2docker/bootlocal.sh"
docker-machine ssh $prop_machine_name \
"echo '$bootlocalsh' | sudo tee $file && sudo chmod +x $file && sync" > /dev/null
sleep 2
echoSuccess "OK"
}
# @info: Restarts Docker Machine
restartDockerMachine()
{
echoInfo "Restart Docker Machine ... \t\t"
if isPropertyNotSet $prop_machine_name; then
echoError "'prop_machine_name' not set!"; exit 1;
fi
docker-machine restart $prop_machine_name > /dev/null
echoSuccess "OK"
}
# @return: 'true', if NFS is mounted; else 'false'
isNFSMounted()
{
for shared_folder in "${prop_shared_folders[@]}"
do
local nfs_mount=$(docker-machine ssh $prop_machine_name "sudo df" |
grep "$prop_nfshost_ip:$prop_shared_folders")
if [ "" = "$nfs_mount" ]; then
echo "false";
return;
fi
done
echo "true"
}
# @info: Verifies that NFS is successfully mounted
verifyNFSMount()
{
echoInfo "Verify NFS mount ... \t\t\t"
local attempts=10
while [ ! $attempts -eq 0 ]; do
sleep 1
[ "$(isNFSMounted)" = "true" ] && break
attempts=$(($attempts-1))
done
if [ $attempts -eq 0 ]; then
echoError "Cannot detect the NFS mount :("; exit 1
fi
echoSuccess "OK"
}
# @info: Displays the finish message
showFinish()
{
echo "\033[0;36m"
echo "--------------------------------------------"
echo
echo " The docker-machine '$prop_machine_name'"
echo " is now mounted with NFS!"
echo
echo " ENJOY high speed mounts :D"
echo
echo "--------------------------------------------"
echo "\033[0m"
}
# END _functions
setPropDefaults
parseCli "$@"
checkMachinePresence $prop_machine_name
checkMachineRunning $prop_machine_name
lookupMandatoryProperties $prop_machine_name
if [ "$(isNFSMounted)" = "true" ] && [ "$prop_force_configuration_nfs" = false ]; then
echoSuccess "\n NFS already mounted." ; showFinish ; exit 0
fi
echo #EMPTY LINE
echoProperties "Machine IP: $prop_machine_ip"
echoProperties "Network ID: $prop_network_id"
echoProperties "NFSHost IP: $prop_nfshost_ip"
echo #EMPTY LINE
configureNFS
configureBoot2Docker
restartDockerMachine
verifyNFSMount
showFinish
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment