/chef-dokku-simple

Chef cookbook for installing dokku using the default bootstrap script.

Primary LanguageRuby

chef-dokku-simple cookbook

Dokku is simple software. It should have a simple cookbook.

This cookbook just runs dokku's default bootstrap script, and installs your ssh keys for access to dokku. If you need more power, you should check out chef-dokku.

Tested with Dokku v0.3.22 and later. Older versions may work, but are untested, so try at your own risk.

Attributes

Attribute Description Type Default
[:dokku][:tag] git tag to install String v0.3.26
[:dokku][:root] home dir for dokku String /home/dokku
[:dokku][:ssh_users] array of usernames to lookup ssh keys in data bag users (see below) Array []
[:dokku][:vhost] domain for virtual hosting String nil
[:dokku][:apps] hash of apps to configure with env vars Hash {}
[:dokku][:plugins] hash of plugin name: repo url to install Hash {}

SSH keys

You need to add ssh keys that may git push apps to your dokku instance. This cookbook looks up ssh_keys as a string or array (of multiple keys) for each configured user in the data bag users. This is for compatibility with the ssh-keys cookbook.

Domain

You will need to setup a wildcard domain pointing to your host (unless you want each app on a different port). Unless dig +short $(hostname -f) gives the correct answer, you need to configure with [:dokku][:vhost].

Environment variables

To pre-configure environment for an application, add to the apps attribute as shown below in Usage.

Usage

Just include dokku-simple in your node's run_list:

{
  "dokku": {
    "tag": "v0.3.26",
    "root": "/home/dokku",
    "ssh_users": [ "lindsey", "jeff" ],
    "vhost": "dokku.me",
    "apps": {
      "my_app": {
        "env": { "TOKEN": "123" }
      }
    }
  },

  "run_list": [
    "recipe[dokku-simple]"
  ]
}

Plugins

To install dokku plugins use the dokku-simple::plugins recipe:

{
  "dokku": {
    "plugins": {
      "postgresql": "https://github.com/Kloadut/dokku-pg-plugin"
    }
  },

  "run_list": [
    "recipe[dokku-simple]",
    "recipe[dokku-simple::plugins]"
  ]
}

You can specify what revision (branch/tag/ref) of a plugin to check out by appending a hash (#) followed by the revision at the end of the URL. For example to specifically use the v1.0.1 tag of the redis plugin:

{
  "dokku": {
    "plugins": {
      "redis": "https://github.com/sekjun9878/dokku-redis-plugin#v1.0.1"
    }
  }
}

To remove a plugin, simply set it's URL to remove:

{
  "dokku": {
    "plugins": {
      "redis": "remove"
    }
  }
}