Release 0.3.21

Peg lxc-docker in buildstep to 1.6.2

HISTORY.md

@@ -1,5 +1,37 @@
 # History
 
+## 0.3.21
+
+This release fixes an issue with installing buildstep and dokku.
+
+### New Features
+
+- #1256: @alessio Log all dokku events to /var/log/dokku/events.log
+
+### Bug Fixes
+
+- #1269: @josegonzalez Peg lxc-docker in buildstep to 1.6.2
+
+## 0.3.20
+
+This release pegs Dokku to Docker 1.6.2. Docker 1.7.0 introduced changes in `docker ps` which cause incompatibilities with many popular dokku plugins.
+
+### New Features
+
+- #1245: @arthurschreiber Support config variables containing `\n`
+- #1257: @josegonzalez Split nginx ssl logs by $APP
+
+### Bug Fixes
+
+- #1207: @rockymadden Fixed bug with client commands taking verb, appname, and also arguments.
+- #1251: @josegonzalez Fallback to using /etc/init.d/nginx reload directly to restart nginx
+- #1264: @josegonzalez Require lxc-docker-1.6.2
+
+### Docs Changes
+
+- #1252: @josegonzalez Fix ssh port for vagrant installation. Closes #1139. [ci skip]
+- #1250: @josegonzalez SSL documentation is misleading
+
 ## 0.3.19
 
 ### New Features

Makefile

@@ -93,7 +93,7 @@ ifndef CI
 ifdef DOCKER_VERSION
 	apt-get install -qq -y lxc-docker-${DOCKER_VERSION}
 else
-	apt-get install -qq -y lxc-docker
+	apt-get install -qq -y lxc-docker-1.6.2
 endif
 	sleep 2 # give docker a moment i guess
 endif

README.md

@@ -10,8 +10,8 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. S
 
 To install the latest stable release, you can run the following commands as a user that has access to `sudo`:
 
-    wget https://raw.github.com/progrium/dokku/v0.3.19/bootstrap.sh
-    sudo DOKKU_TAG=v0.3.19 bash bootstrap.sh
+    wget https://raw.github.com/progrium/dokku/v0.3.21/bootstrap.sh
+    sudo DOKKU_TAG=v0.3.21 bash bootstrap.sh
 
 ### Upgrading
 

contrib/dokku-installer.rb

@@ -21,7 +21,7 @@ if ARGV[0] == "onboot"
   exit
 end
 
-version   = "v0.3.19"
+version   = "v0.3.21"
 dokku_root  = ENV["DOKKU_ROOT"] || "/home/dokku"
 admin_key   = `cat /root/.ssh/authorized_keys`.split("\n").first
 hostname  = `bash -c '[[ $(dig +short $HOSTNAME) ]] && echo $HOSTNAME || curl icanhazip.com'`.strip

contrib/dokku_client.sh

@@ -102,6 +102,11 @@ if [[ ! -z $DOKKU_HOST ]]; then
       if [[ ! "$1" =~ --* ]]; then
         verb=$1
         shift
+        
+        if [[ "$1" == "$appname" ]]; then
+          shift
+        fi
+        
         args="$*"
       else
         long_args="--"

deb.mk

@@ -1,6 +1,6 @@
 BUILDSTEP_DESCRIPTION = 'Buildstep uses Docker and Buildpacks to build applications like Heroku'
 BUILDSTEP_REPO_NAME ?= progrium/buildstep
-BUILDSTEP_VERSION ?= 0.0.1
+BUILDSTEP_VERSION ?= 0.0.2
 BUILDSTEP_ARCHITECTURE = amd64
 BUILDSTEP_PACKAGE_NAME = buildstep_$(BUILDSTEP_VERSION)_$(BUILDSTEP_ARCHITECTURE).deb
 
@@ -89,7 +89,7 @@ deb-buildstep: deb-setup
 	cp -rf /tmp/tmp/buildstep /tmp/build/var/lib/buildstep
 
 	echo "-> Creating $(BUILDSTEP_PACKAGE_NAME)"
-	sudo fpm -t deb -s dir -C /tmp/build -n buildstep -v $(BUILDSTEP_VERSION) -a $(BUILDSTEP_ARCHITECTURE) -p $(BUILDSTEP_PACKAGE_NAME) --deb-pre-depends 'lxc-docker >= 1.4.0' --after-install /tmp/tmp/post-install --url "https://github.com/$(BUILDSTEP_REPO_NAME)" --description $(BUILDSTEP_DESCRIPTION) --license 'MIT License' .
+	sudo fpm -t deb -s dir -C /tmp/build -n buildstep -v $(BUILDSTEP_VERSION) -a $(BUILDSTEP_ARCHITECTURE) -p $(BUILDSTEP_PACKAGE_NAME) --deb-pre-depends 'lxc-docker-1.6.2' --after-install /tmp/tmp/post-install --url "https://github.com/$(BUILDSTEP_REPO_NAME)" --description $(BUILDSTEP_DESCRIPTION) --license 'MIT License' .
 	mv *.deb /tmp
 
 deb-dokku: deb-setup

debian/control

@@ -3,7 +3,7 @@ Version: 0.3.12
 Section: base
 Priority: optional
 Architecture: amd64
-Depends: locales, git, make, curl, software-properties-common, lxc-docker (>= 1.4.0), gcc, python-software-properties, man-db, buildstep, sshcommand, pluginhook
+Depends: locales, git, make, curl, software-properties-common, lxc-docker-1.6.2, gcc, python-software-properties, man-db, buildstep, sshcommand, pluginhook
 Pre-Depends: nginx, dnsutils, ruby, ruby-dev, rubygem-rack, rubygem-rack-protection, rubygem-sinatra, rubygem-tilt, apparmor, cgroup-lite
 Provides: dokku
 Maintainer: Jose Diaz-Gonzalez <dokku@josediazgonzalez.com>

debian/preinst

@@ -29,7 +29,7 @@ case "$1" in
       } >> $NGINX_CONF
 
       rm -f /etc/nginx/sites-enabled/*
-      service nginx reload
+      service nginx reload || /etc/init.d/nginx reload
       exit 0
     fi
 

docs/getting-started/install/vagrant.md

@@ -30,7 +30,7 @@
 
     ```
     Host dokku.me
-        Port 2222
+        Port 22
     ```
 
 - Copy your SSH key via `cat ~/.ssh/id_rsa.pub | pbcopy` and paste it into the dokku-installer at http://dokku.me . Change the `Hostname` field on the Dokku Setup screen to your domain and then check the box that says `Use virtualhost naming`. Then click *Finish Setup* to install your key. You'll be directed to application deployment instructions from here.

docs/installation.md

@@ -12,8 +12,8 @@ To install the latest stable version of dokku, you can run the following bootstr
 
 ```shell
 # installs dokku via apt-get
-wget https://raw.github.com/progrium/dokku/v0.3.19/bootstrap.sh
-sudo DOKKU_TAG=v0.3.19 bash bootstrap.sh
+wget https://raw.github.com/progrium/dokku/v0.3.21/bootstrap.sh
+sudo DOKKU_TAG=v0.3.21 bash bootstrap.sh
 
 # Go to your server's IP and follow the web installer
 ```

docs/nginx.md

@@ -8,9 +8,18 @@ Dokku provides easy TLS/SPDY support out of the box. This can be done app-by-app
 
 ### Per App
 
-To enable TLS connection to to one of your applications, copy or symlink the `.crt` and `.key` files into the application's `/home/dokku/:app/tls` folder (create this folder if it doesn't exist) as `server.crt` and `server.key` respectively.
+To enable TLS connections to to one of your applications, do the following:
+
+* Create a key file and a cert file. 
+ * You can find detailed steps for generating a self-signed certificate at https://devcenter.heroku.com/articles/ssl-certificate-self
+ * If you are not paranoid and need it just for a DEV or STAGING app, you can use http://www.selfsignedcertificate.com/ to generate your 2 files more easily.
+* Rename your files to server.key and server.crt
+* tar these 2 files together, *without* subdirectories. Example: tar cvf cert-key.tar server.crt server.key
+* Install the pair for your app, like this: ssh dokku@ip-of-your-dokku-server nginx:import-ssl < cert-key.tar
+
+You will need to repeat the steps above for each domain used to serve your app. You can't simply create
+a single tar with all key/cert files in it (see https://github.com/progrium/dokku/issues/1195). 
 
-Redeployment of the application will be needed to apply TLS configuration. Once it is redeployed, the application will be accessible by `https://` (redirection from `http://` is applied as well).
 
 ### All Subdomains
 

dokku

@@ -10,6 +10,9 @@ export PLUGIN_PATH=${PLUGIN_PATH:="/var/lib/dokku/plugins"}
 export DOKKU_NOT_IMPLEMENTED_EXIT=10
 export DOKKU_VALID_EXIT=0
 
+export DOKKU_LOGS_DIR=${DOKKU_LOGS_DIR:="/var/log/dokku"}
+export DOKKU_EVENTS_LOGFILE=${DOKKU_EVENTS_LOGFILE:="$DOKKU_LOGS_DIR/events.log"}
+
 source "$PLUGIN_PATH/common/functions"
 
 [[ -f $DOKKU_ROOT/dokkurc ]] && source $DOKKU_ROOT/dokkurc

plugins/20_events/backup-check

@@ -0,0 +1 @@
+hook

plugins/20_events/backup-export

@@ -0,0 +1 @@
+hook

plugins/20_events/backup-import

@@ -0,0 +1 @@
+hook

plugins/20_events/bind-external-ip

@@ -0,0 +1 @@
+hook

plugins/20_events/check-deploy

@@ -0,0 +1 @@
+hook

plugins/20_events/commands

@@ -0,0 +1,55 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$(dirname $0)/../common/functions"
+
+PLUGIN_DIR="$(dirname $0)"
+
+case "$1" in
+  events)
+    if [[ -f $DOKKU_EVENTS_LOGFILE ]] ; then
+      if [[ $2 == "-t" ]]; then
+        tail -f $DOKKU_EVENTS_LOGFILE
+      else
+        tail -n 100 $DOKKU_EVENTS_LOGFILE
+      fi
+    fi
+    ;;
+
+  events:on)
+    echo "Enabling dokku events logger"
+    [[ -d $DOKKU_ROOT/.dokkurc ]] || mkdir -p $DOKKU_ROOT/.dokkurc
+    echo "export DOKKU_EVENTS=1" > $DOKKU_ROOT/.dokkurc/DOKKU_EVENTS
+    ;;
+
+  events:off)
+    echo "Disabling dokku events logger"
+    rm -f $DOKKU_ROOT/.dokkurc/DOKKU_EVENTS
+    ;;
+
+  events:list)
+    if [[ "$DOKKU_EVENTS" ]]; then
+      logged="$(find $PLUGIN_DIR -type l -printf '%f ' | sort)"
+      dokku_col_log_info2_quiet "Events currently logged"
+      for hook in $logged ; do
+        dokku_col_log_msg "$hook"
+      done
+    else
+      dokku_log_warn "Events logger disabled"
+    fi
+    ;;
+
+  help | events:help)
+    cat && cat<<EOF
+    events [-t]                                     Show the last events (-t follows)
+    events:list                                     List logged events
+    events:on                                       Enable events logger
+    events:off                                      Disable events logger
+EOF
+    ;;
+
+  *)
+    exit $DOKKU_NOT_IMPLEMENTED_EXIT
+    ;;
+
+esac
+

plugins/20_events/dependencies

@@ -0,0 +1 @@
+hook

plugins/20_events/docker-args-build

@@ -0,0 +1 @@
+hook

plugins/20_events/docker-args-deploy

@@ -0,0 +1 @@
+hook

plugins/20_events/docker-args-run

@@ -0,0 +1 @@
+hook

plugins/20_events/git-post-pull

@@ -0,0 +1 @@
+hook

plugins/20_events/git-pre-pull

@@ -0,0 +1 @@
+hook

plugins/20_events/hook

@@ -0,0 +1,5 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$(dirname $0)/../common/functions"
+
+[[ ! "$DOKKU_EVENTS" ]] || dokku_log_pluginhook_call "$(basename $0)" "$@"

plugins/20_events/install

@@ -0,0 +1,54 @@
+#!/usr/bin/env bash
+set -eo pipefail; [[ $DOKKU_TRACE ]] && set -x
+source "$(dirname $0)/../common/functions"
+
+DOKKU_RSYSLOG_FILTER=/etc/rsyslog.d/99-dokku.conf
+DOKKU_LOGROTATE_FILE=/etc/logrotate.d/dokku
+
+flag_rsyslog_needs_restart=n
+
+# This can be done unconditionally as mkdir -p
+# exits gracefully if the path already exists
+mkdir -m 775 -p "$DOKKU_LOGS_DIR"
+chown syslog:dokku "$DOKKU_LOGS_DIR"
+
+if [[ ! -f  "$DOKKU_EVENTS_LOGFILE" ]]; then
+  touch "$DOKKU_EVENTS_LOGFILE"
+  # chown syslog:root might not work on SUSE
+  chown syslog:dokku "$DOKKU_EVENTS_LOGFILE"
+  chmod 664 "$DOKKU_EVENTS_LOGFILE"
+fi
+
+if [[ ! -f  "$DOKKU_RSYSLOG_FILTER" ]]; then
+  cat >"$DOKKU_RSYSLOG_FILTER" <<EOF
+:syslogtag, contains, "dokku" $DOKKU_EVENTS_LOGFILE
+EOF
+  flag_rsyslog_needs_restart=y
+fi
+
+if [[ ! -f "$DOKKU_LOGROTATE_FILE" ]]; then
+  cat >"$DOKKU_LOGROTATE_FILE" <<EOF
+$DOKKU_LOGS_DIR/*.log {
+        daily
+        rotate 7
+        missingok
+        notifempty
+        su syslog dokku
+        compress
+        delaycompress
+        postrotate
+                reload rsyslog >/dev/null 2>&1 || true
+        endscript
+        create 664 syslog dokku
+}
+EOF
+  flag_rsyslog_needs_restart=y
+fi
+
+if [[ "$flag_rsyslog_needs_restart" == "y" ]]; then
+  service rsyslog restart
+fi
+
+[[ ! "$DOKKU_EVENTS" ]] || dokku_log_pluginhook_call "$(basename $0)" "$@"
+
+exit 0

plugins/20_events/nginx-hostname

@@ -0,0 +1 @@
+hook

plugins/20_events/nginx-pre-reload

@@ -0,0 +1 @@
+hook

plugins/20_events/post-build-buildstep

@@ -0,0 +1 @@
+hook

plugins/20_events/post-build-dockerfile

@@ -0,0 +1 @@
+hook

plugins/20_events/post-delete

@@ -0,0 +1 @@
+hook

plugins/20_events/post-deploy

@@ -0,0 +1 @@
+hook

plugins/20_events/post-domains-update

@@ -0,0 +1 @@
+hook

plugins/20_events/post-release-buildstep

@@ -0,0 +1 @@
+hook

plugins/20_events/post-release-dockerfile

@@ -0,0 +1 @@
+hook

plugins/20_events/pre-build-buildstep

@@ -0,0 +1 @@
+hook

plugins/20_events/pre-build-dockerfile

@@ -0,0 +1 @@
+hook

plugins/20_events/pre-delete

@@ -0,0 +1 @@
+hook

plugins/20_events/pre-deploy

@@ -0,0 +1 @@
+hook

plugins/20_events/pre-release-buildstep

@@ -0,0 +1 @@
+hook

plugins/20_events/pre-release-dockerfile

@@ -0,0 +1 @@
+hook

plugins/20_events/receive-app

@@ -0,0 +1 @@
+hook

plugins/20_events/update

@@ -0,0 +1 @@
+hook

plugins/common/functions

@@ -90,6 +90,17 @@ dokku_log_fail() {
   exit 1
 }
 
+dokku_log_event() {
+  logger -t dokku -i -- "$@"
+}
+
+dokku_log_pluginhook_call() {
+  local l_hook
+
+  l_hook="$1" ; shift
+  dokku_log_event "INVOKED: ${l_hook}( $@ )"
+}
+
 dokku_container_log_verbose_quiet() {
   CID=$1;
   shift

plugins/config/commands

@@ -38,7 +38,7 @@ config_styled_hash () {
 
 config_write() {
   ENV_TEMP="$1"
-  echo -e "$ENV_TEMP" | sed '/^$/d' | sort > $ENV_FILE_TEMP
+  echo "$ENV_TEMP" | sed '/^$/d' | sort > $ENV_FILE_TEMP
   if ! cmp -s $ENV_FILE $ENV_FILE_TEMP; then
     cp -f $ENV_FILE_TEMP $ENV_FILE
     chmod 600 $ENV_FILE
@@ -137,8 +137,9 @@ case "$1" in
 
       if [[ $KEY =~ [a-zA-Z_][a-zA-Z0-9_]* ]]; then
         RESTART_APP=true
-        ENV_TEMP=$(echo -e "${ENV_TEMP}" | sed "/^export $KEY=/ d")
-        ENV_TEMP="${ENV_TEMP}\nexport $KEY='$VALUE'"
+        ENV_TEMP=$(echo "${ENV_TEMP}" | sed "/^export $KEY=/ d")
+        ENV_TEMP="${ENV_TEMP}
+export $KEY='$VALUE'"
         ENV_ADD=$(echo -e "${ENV_ADD}" | sed "/^$KEY=/ d")
         ENV_ADD="${ENV_ADD}$
 ${var}"

plugins/nginx-vhosts/templates/nginx.ssl.conf.template

@@ -2,6 +2,8 @@ server {
   listen      [::]:80;
   listen      80;
   server_name $NOSSL_SERVER_NAME;
+  access_log  /var/log/nginx/${APP}-access.log;
+  error_log   /var/log/nginx/${APP}-error.log;
   return 301 https://\$host\$request_uri;
 }
 
@@ -9,6 +11,8 @@ server {
   listen      [::]:443 ssl spdy;
   listen      443 ssl spdy;
   server_name $SSL_SERVER_NAME;
+  access_log  /var/log/nginx/${APP}-access.log;
+  error_log   /var/log/nginx/${APP}-error.log;
 $SSL_DIRECTIVES
 
   keepalive_timeout   70;

tests/unit/config.bats

@@ -20,7 +20,7 @@ teardown() {
 }
 
 @test "(config) config:get" {
-  run ssh dokku@dokku.me config:set $TEST_APP test_var=true test_var2=\"hello world\"
+  run ssh dokku@dokku.me config:set $TEST_APP test_var=true test_var2=\"hello world\" test_var3=\"with\\nnewline\"
   echo "output: "$output
   echo "status: "$status
   assert_success
@@ -28,6 +28,10 @@ teardown() {
   echo "output: "$output
   echo "status: "$status
   assert_output 'hello world'
+  run dokku config:get $TEST_APP test_var3
+  echo "output: "$output
+  echo "status: "$status
+  assert_output 'with\nnewline'
 }
 
 @test "(config) config:unset" {

tests/unit/events.bats

@@ -0,0 +1,40 @@
+#!/usr/bin/env bats
+
+load test_helper
+
+setup() {
+  create_app
+}
+
+teardown() {
+  destroy_app
+}
+
+@test "(events) check conffiles" {
+  run bash -c "test -f /etc/logrotate.d/dokku"
+  echo "output: "$output
+  echo "status: "$status
+  assert_success
+  run bash -c "test -f /etc/rsyslog.d/99-dokku.conf"
+  echo "output: "$output
+  echo "status: "$status
+  assert_success
+  run bash -c "stat -c '%U:%G:%a' /var/log/dokku/"
+  echo "output: "$output
+  echo "status: "$status
+  assert_output "syslog:dokku:775"
+  run bash -c "stat -c '%U:%G:%a' /var/log/dokku/events.log"
+  echo "output: "$output
+  echo "status: "$status
+  assert_output "syslog:dokku:664"
+}
+
+@test "(events) log commands" {
+  run dokku events:on
+  deploy_app
+  run dokku events
+  echo "output: "$output
+  echo "status: "$status
+  assert_success
+  run dokku events:off
+}