7 # Docker doesn't like uppercase characters, spaces or special characters, catch it now before we build everything out and then find out
8 re
='[A-Z/ !@#$%^&*()+~`=]'
9 if [[ $config =~
$re ]];
12 echo "ERROR: Config name must not contain upper case characters, spaces or special characters. Correct config name and rerun $0."
19 docker_min_version
='1.6.0'
20 docker_rec_version
='1.6.0'
22 config_file
=containers
/"$config".yml
23 cidbootstrap
=cids
/"$config"_bootstrap.cid
24 local_discourse
=local_discourse
25 image
=discourse
/discourse
:1.0.17
26 docker_path
=`which docker.io || which docker`
27 template_path
=samples
/standalone.yml
28 changelog
=/tmp
/changelog
# used to test whether sed did anything
30 if [ "${SUPERVISED}" = "true" ]; then
31 restart_policy
="--restart=no"
33 attach_on_run
="-a stdout -a stderr"
38 if [ -n "$DOCKER_HOST" ]; then
39 docker_ip
=`sed -e 's/^tcp:\/\/\(.*\):.*$/\1/' <<< "$DOCKER_HOST"`
40 elif [ -x "$(which ip 2>/dev/null)" ]; then
41 docker_ip
=`ip addr show docker0 | \
43 awk '{ split($2,a,"/"); print a[1] }';`
45 docker_ip
=`ifconfig | \
46 grep -B1 "inet addr" | \
47 awk '{ if ( $1 == "inet" ) { print $2 } else if ( $2 == "Link" ) { printf "%s:" ,$1 } }' | \
49 awk -F: '{ print $3 }';`
54 echo "Usage: launcher COMMAND CONFIG [--skip-prereqs]"
56 echo " start: Start/initialize a container"
57 echo " stop: Stop a running container"
58 echo " restart: Restart a container"
59 echo " destroy: Stop and remove a container"
60 echo " enter: Use nsenter to enter a container"
61 echo " ssh: Start a bash shell in a running container"
62 echo " logs: Docker logs for container"
63 echo " bootstrap: Bootstrap a container for the config based on a template"
64 echo " rebuild: Rebuild a container (destroy old, bootstrap, start new)"
65 echo " memconfig: Configure defaults based on available RAM"
66 echo " cleanup: Remove all containers that have stopped for > 24 hours"
69 echo " --skip-prereqs Don't check prerequisites or resource requirements"
70 echo " --docker-args Extra arguments to pass when running docker"
77 IFS
=.
read -a ver_a
<<< "$1"
78 IFS
=.
read -a ver_b
<<< "$2"
80 while [[ -n $ver_a ]]; do
81 if (( ver_a
> ver_b
)); then
83 elif (( ver_b
> ver_a
)); then
92 return 1 # They are equal
97 # 1. docker daemon running?
98 # we send stderr to /dev/null cause we don't care about warnings,
99 # it usually complains about swap which does not matter
100 test=`$docker_path info 2> /dev/null`
102 if [[ $?
-ne 0 ]] ; then
103 echo "Cannot connect to the docker daemon - verify it is running and you have access"
107 # 2. running aufs or btrfs
108 test=`$docker_path info 2> /dev/null | grep 'Driver: '`
109 if [[ "$test" =~
[aufs|btrfs|zfs|overlay
] ]] ; then : ; else
110 echo "Your Docker installation is not using a supported filesystem if we were to proceed you may have a broken install."
111 echo "aufs is the recommended filesystem you should be using (zfs/btrfs and overlay may work as well)"
112 echo "You can tell what filesystem you are using by running \"docker info\" and looking at the driver"
114 echo "If you wish to continue anyway using your existing unsupported filesystem"
115 echo "read the source code of launcher and figure out how to bypass this."
119 # 3. running recommended docker version
120 test=($
($docker_path --version)) # Get docker version string
121 test=${test[2]//,/} # Get version alone and strip comma if exists
123 [[ "$test" =~
"0.12.0" ]] && echo "You are running a broken version of Docker, please upgrade ASAP. See: https://meta.discourse.org/t/the-installation-stopped-in-the-middle/16311/ for more details." && exit 1
125 # At least minimum version
126 if compare_version
"${docker_min_version}" "${test}"; then
127 echo "ERROR: Docker version ${test} not supported, please upgrade to at least ${docker_min_version}, or recommended ${docker_rec_version}"
131 # Recommend best version
132 if compare_version
"${docker_rec_version}" "${test}"; then
133 echo "WARNING: Docker version ${test} deprecated, recommend upgrade to ${docker_rec_version} or newer."
136 # 4. discourse docker image is downloaded
137 test=`$docker_path images | awk '{print $1 ":" $2 }' | grep "$image"`
139 if [ -z "$test" ]; then
141 echo "WARNING: We are about to start downloading the Discourse base image"
142 echo "This process may take anywhere between a few minutes to an hour, depending on your network speed"
144 echo "Please be patient"
149 # 5. able to attach stderr / out / tty
150 test=`$docker_path run $user_args -i --rm -a stdout -a stderr $image echo working`
151 if [[ "$test" =~
"working" ]] ; then : ; else
152 echo "Your Docker installation is not working correctly"
154 echo "See: https://meta.discourse.org/t/docker-error-on-bootstrap/13657/18?u=sam"
163 avail_mem
="$(LANG=C free -m | grep '^Mem:' | awk '{print $2}')"
164 if [ "$avail_mem" -lt 900 ]; then
165 resources
="insufficient"
166 echo "WARNING: You do not appear to have sufficient memory to run Discourse."
168 echo "Your system may not work properly, or future upgrades of Discourse may"
169 echo "not complete successfully."
171 echo "See https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud.md#create-new-cloud-server"
172 elif [ "$avail_mem" -lt 1800 ]; then
173 total_swap
="$(LANG=C free -m | grep ^Swap: | awk '{print $2}')"
174 if [ "$total_swap" -lt 1000 ]; then
175 resources
="insufficient"
176 echo "WARNING: You must have at least 1GB of swap when running with less"
177 echo "than 2GB of RAM."
179 echo "Your system may not work properly, or future upgrades of Discourse may"
180 echo "not complete successfully."
182 echo "See https://github.com/discourse/discourse/blob/master/docs/INSTALL-cloud.md#set-up-swap-if-needed"
187 free_disk
="$(df /var | tail -n 1 | awk '{print $4}')"
188 if [ "$free_disk" -lt 5000 ]; then
189 resources
="insufficient"
190 echo "WARNING: You must have at least 5GB of *free* disk space to run Discourse."
192 echo "Insufficient disk space may result in problems running your site, and may"
193 echo "not even allow Discourse installation to complete successfully."
195 echo "Please free up some space, or expand your disk, before continuing."
199 if [ -t 0 ] && [ "$resources" != "ok" ]; then
201 read -p "Press ENTER to continue, or Ctrl-C to exit and give your system more resources"
206 local valid
=$
(netstat
-tln |
awk '{print $4}' |
grep ":${1}\$")
208 if [ -n "$valid" ]; then
209 echo "Launcher has detected that port ${1} is in use."
211 echo "If you are trying to run Discourse simultaneously with another web server like Apache or nginx, you will need to bind to a different port."
212 echo "See https://meta.discourse.org/t/17247 for help."
213 echo "To continue anyway, re-run Launcher with --skip-prereqs"
218 if [ "$opt" != "--skip-prereqs" ] ; then
222 if [ "$opt" == "--docker-args" ] ; then
229 local ${ssh_key_locations}
231 ~
/.ssh
/id_ed25519.pub
235 ~core
/.ssh
/authorized_keys
239 for keyfile
in "${ssh_key_locations[@]}"; do
240 if [[ -e ${keyfile} ]] ; then
241 ssh_pub_key
="$(cat ${keyfile})"
252 echo "Docker is not installed, you will need to install Docker in order to run Discourse"
253 echo "Please visit https://docs.docker.com/installation/ for instructions on how to do this for your system"
255 echo "If you are running Ubuntu Trusty or later, you can try the following:"
258 echo "sudo apt-key adv --keyserver hkp://p80.pool.sks-keyservers.net:80 --recv-keys 58118E89F3A912897C070ADBF76221572C52609D"
259 echo "sudo sh -c \"echo deb https://apt.dockerproject.org/repo ubuntu-$(lsb_release -sc) main > /etc/apt/sources.list.d/docker.list\""
260 echo "sudo apt-get update"
261 echo "sudo apt-get install docker-engine"
267 read -r -d '' env_ruby
<< 'RUBY'
270 input
= STDIN.readlines.
join
271 yaml
= YAML.load
(input
)
273 if host_run
= yaml
['host_run']
274 params
= yaml
['params'] ||
{}
275 host_run.each
do |run|
277 run
= run.gsub
("$#{k}", v
)
279 STDOUT.
write "#{run}--SEP--"
284 host_run
=`cat $config_file | $docker_path run $user_args --rm -i -a stdout -a stdin $image ruby -e "$env_ruby"`
286 while [ "$host_run" ] ; do
287 iter
=${host_run%%--SEP--*}
289 echo "Host run: $iter"
292 host_run
="${host_run#*--SEP--}"
298 volumes
=`cat $config_file | $docker_path run $user_args --rm -i -a stdout -a stdin $image ruby -e \
299 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['volumes'].map{|v| '-v ' << v['volume']['host'] << ':' << v['volume']['guest'] << ' '}.join"`
303 links
=`cat $config_file | $docker_path run $user_args --rm -i -a stdout -a stdin $image ruby -e \
304 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['links'].map{|l| '--link ' << l['link']['name'] << ':' << l['link']['alias'] << ' '}.join"`
307 set_template_info
() {
309 templates
=`cat $config_file | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e \
310 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['templates']"`
313 arrTemplates
=(${templates// / })
314 config_data
=$
(cat $config_file)
319 for template
in "${arrTemplates[@]}"
321 [ ! -z $template ] && {
322 input
="$input _FILE_SEPERATOR_ $(cat $template)"
326 # we always want our config file last so it takes priority
327 input
="$input _FILE_SEPERATOR_ $config_data"
329 read -r -d '' env_ruby
<< 'RUBY'
332 input
=STDIN.readlines.
join
333 # default to UTF-8 for the dbs sake
334 env
= {'LANG' => 'en_US.UTF-8'}
335 input.
split('_FILE_SEPERATOR_').each
do |yml|
338 env.merge
!(YAML.load
(yml
)['env'] ||
{})
339 rescue Psych
::SyntaxError
=> e
347 puts env.map
{|k
,v|
"-e\n#{k}=#{v}" }.
join("\n")
350 raw
=`exec echo "$input" | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e "$env_ruby"`
355 if [ "$i" == "*ERROR." ]; then
357 elif [ -n "$i" ]; then
362 if [ "$ok" -ne 1 ]; then
364 echo "YAML syntax error. Please check your /var/discourse/containers/*.yml config files."
369 [ -z $docker_path ] && {
373 [ "$command" == "cleanup" ] && {
375 echo "The following command will"
376 echo "- Delete all docker images for old containers"
377 echo "- Delete all stopped and orphan containers"
379 read -p "Are you sure (Y/n): " -n 1 -r && echo
380 if [[ $REPLY =~ ^
[Yy
]$ ||
! $REPLY ]]
382 space
=$
(df
/var
/lib
/docker |
awk '{ print $4 }' |
grep -v Available
)
383 echo "Starting Cleanup (bytes free $space)"
385 STATE_DIR
=.
/.gc-state
scripts
/docker-gc
387 space
=$
(df
/var
/lib
/docker |
awk '{ print $4 }' |
grep -v Available
)
388 echo "Finished Cleanup (bytes free $space)"
400 if [[ ! -e $config_file && $command -ne "memconfig" ]]
402 echo "Config file was not found, ensure $config_file exists"
404 echo "Available configs ( `cd containers && ls -dm *.yml | tr -s '\n' ' ' | awk '{ gsub(/\.yml/, ""); print }'`)"
409 docker_version
=($
($docker_path --version))
410 docker_version
=${test[2]//,/}
412 if compare_version
"1.2.0" "$docker_version"; then
413 echo "We recommend you upgrade docker, the version you are running has no restart policies, on reboot your container may not start up"
416 restart_policy
=${restart_policy:---restart=always}
419 set_existing_container
(){
420 existing
=`$docker_path ps -a | awk '{ print $1, $(NF) }' | grep " $config$" | awk '{ print $1 }'`
425 set_existing_container
427 if [ ! -z $existing ]
431 $docker_path stop
-t 10 $config
434 echo "$config was not started !"
440 run_image
=`cat $config_file | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e \
441 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['run_image']"`
443 if [ -z "$run_image" ]; then
444 run_image
="$local_discourse/$config"
449 boot_command
=`cat $config_file | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e \
450 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['boot_command']"`
452 if [ -z "$boot_command" ]; then
454 no_boot_command
=`cat $config_file | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e \
455 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['no_boot_command']"`
457 if [ -z "$no_boot_command" ]; then
458 boot_command
="/sbin/boot"
464 if [ "$opt" != "--skip-prereqs" ] ; then
467 if [ -f $config_file ]
469 cp $config_file $config_file.bak
470 echo "Saving $config_file as $config_file.bak"
472 echo "Creating $config_file from $template_path"
473 if [ ! -f $template_path ]
475 echo "$template_path is missing. Exiting."
478 cp $template_path $config_file
482 avail_mem
="$(LANG=C free -m | grep '^Mem:' | awk '{print $2}')"
483 avail_gb
=`expr $(($avail_mem / 950))`
484 avail_cores
=`grep -c processor /proc/cpuinfo`
485 echo "Found $avail_mem (${avail_gb}GB), of memory and $avail_cores cores."
487 # set db_shared_buffers: "128MB" (1GB) or 256MB * GB
488 if [ "$avail_gb" -eq "1" ]
490 db_shared_buffers
="128"
492 db_shared_buffers
=`expr $avail_gb \* 256`
494 echo -e "Recommend setting for db_shared_buffers: ${db_shared_buffers}GB"
495 sed -i -e "s/^ #db_shared_buffers:.*/ db_shared_buffers: \"${db_shared_buffers}GB\"/w $changelog" $config_file
498 echo "db_shared_buffers set successfully."
500 else if grep "^ db_shared_buffers:" $config_file
502 echo "db_shared_buffers already set. Unchanged."
504 echo -e ". . . oops!\n---> db_shared_buffers not found in $config_file."
508 # set UNICORN_WORKERS: 2*GB or 2*cores (the same on DO)
509 if [ "$avail_gb" -le "2" ]
511 unicorn_workers
=`expr $avail_gb \* 2`
513 unicorn_workers
=`expr $avail_cores \* 2`
516 echo -e "Recommended setting UNICORN_WORKERS: $unicorn_workers"
517 sed -i -e "s/^ #UNICORN_WORKERS:.*/ UNICORN_WORKERS: ${unicorn_workers}/w $changelog" $config_file
520 echo "UNICORN_WORKERS set successfully."
522 else if grep "^ UNICORN_WORKERS:" $config_file
524 echo "UNICORN_WORKERS already set. Unchanged."
526 echo -e ". . . oops!\n---> UNICORN_WORKERS not found in $config_file.\n"
533 existing
=`$docker_path ps | awk '{ print $1, $(NF) }' | grep " $config$" | awk '{ print $1 }'`
535 if [ ! -z $existing ]
537 echo "Nothing to do, your container has already started!"
541 existing
=`$docker_path ps -a | awk '{ print $1, $(NF) }' | grep " $config$" | awk '{ print $1 }'`
542 if [ ! -z $existing ]
544 echo "starting up existing container"
547 $docker_path start
$config
553 ports
=`cat $config_file | $docker_path run $user_args --rm -i -a stdout -a stdin $image ruby -e \
554 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['expose'].map{|p| \"-p #{p}\"}.join(' ')"`
556 IFS
='-p ' read -a array
<<< "$ports"
557 for element
in "${array[@]}"
559 IFS
=':' read -a args
<<< "$element"
560 if [ "${#args[@]}" == "2" ]; then
561 check_ports
"${args[0]}"
562 elif [ "${#args[@]}" == "3" ]; then
563 check_ports
"${args[1]}"
567 docker_args
=`cat $config_file | $docker_path run $user_args --rm -i -a stdout -a stdin $image ruby -e \
568 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['docker_args']"`
576 # get hostname and settings from container configuration
577 for envar
in "${env[@]}"
579 if [[ $envar == DOCKER_USE_HOSTNAME
* ]] ||
[[ $envar == DISCOURSE_HOSTNAME
* ]]
581 # use as environment variable
587 hostname
=`hostname -s`
589 if [ "$DOCKER_USE_HOSTNAME" = "true" ]
591 hostname
=$DISCOURSE_HOSTNAME
593 hostname
=$hostname-$config
596 # we got to normalize so we only have allowed strings, this is more comprehensive but lets see how bash does first
597 # hostname=`$docker_path run $user_args --rm $image ruby -e 'print ARGV[0].gsub(/[^a-zA-Z-]/, "-")' $hostname`
598 # docker added more hostname rules
599 hostname
=${hostname/_/-}
602 $docker_path run
$user_args $links $attach_on_run $restart_policy "${env[@]}" -h "$hostname" \
603 -e DOCKER_HOST_IP
=$docker_ip --name $config -t $ports $volumes $docker_args $run_image $boot_command
612 if [ "$opt" != "--skip-prereqs" ] ; then
620 # Is the image available?
621 # If not, pull it here so the user is aware what's happening.
622 $docker_path history $image >/dev
/null
2>&1 ||
$docker_path pull
$image
626 base_image
=`cat $config_file | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e \
627 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['base_image']"`
629 update_pups
=`cat $config_file | $docker_path run $user_args --rm -i -a stdin -a stdout $image ruby -e \
630 "require 'yaml'; puts YAML.load(STDIN.readlines.join)['update_pups']"`
632 if [[ ! X
"" = X
"$base_image" ]]; then
641 run_command
="cd /pups &&"
642 if [[ ! "false" = $update_pups ]]; then
643 run_command
="$run_command git pull &&"
645 run_command
="$run_command /pups/bin/pups --stdin"
649 env
=("${env[@]}" "-e" "SSH_PUB_KEY=$ssh_pub_key")
651 (exec echo "$input" |
$docker_path run
$user_args $links "${env[@]}" -e DOCKER_HOST_IP
=$docker_ip --cidfile $cidbootstrap -i -a stdin
-a stdout
-a stderr
$volumes $image \
652 /bin
/bash
-c "$run_command") \
653 ||
($docker_path rm `cat $cidbootstrap` && rm $cidbootstrap)
655 [ ! -e $cidbootstrap ] && echo "** FAILED TO BOOTSTRAP ** please scroll up and look for earlier error messages, there may be more than one" && exit 1
659 $docker_path commit
`cat $cidbootstrap` $local_discourse/$config ||
echo 'FAILED TO COMMIT'
660 $docker_path rm `cat $cidbootstrap` && rm $cidbootstrap
668 echo "Successfully bootstrapped, to startup use ./launcher start $config"
673 exec $docker_path exec -it $config /bin
/bash
--login
677 existing
=`$docker_path ps | awk '{ print $1, $(NF) }' | grep " $config$" | awk '{ print $1 }'`
679 if [[ ! -z $existing ]]; then
680 address
="`$docker_path port $config 22`"
681 split=(${address//:/ })
682 exec ssh -o StrictHostKeyChecking
=no root@
${split[0]} -p ${split[1]}
684 echo "$config is not running!"
696 $docker_path logs
$config
717 if [ "$(git symbolic-ref --short HEAD)" == "master" ]; then
718 echo "Ensuring discourse docker is up to date"
722 LOCAL
=$
(git rev-parse @
)
723 REMOTE
=$
(git rev-parse @
{u
})
724 BASE
=$
(git merge-base @ @
{u
})
726 if [ $LOCAL = $REMOTE ]; then
727 echo "Discourse Docker is up-to-date"
729 elif [ $LOCAL = $BASE ]; then
730 echo "Updating Discourse Docker"
731 git pull ||
(echo 'failed to update' && exit 1)
734 elif [ $REMOTE = $BASE ]; then
735 echo "Your version of Discourse Docker is ahead of origin"
738 echo "Discourse Docker has diverged source, this is only expected in Dev mode"
743 set_existing_container
745 if [ ! -z $existing ]
747 echo "Stopping old container"
750 $docker_path stop
-t 10 $config
756 if [ ! -z $existing ]
758 echo "Removing old container"
761 $docker_path rm $config
771 (set -x; $docker_path stop
-t 10 $config && $docker_path rm $config) ||
(echo "$config was not found" && exit 0)