dokku-ansible-playbook/README.md

dokku-ansible-playbook

Run ansible playbooks during deployment.

This plugin can be useful when you need to provision your server before or after a deployment of your application (or on any hook, just raise an issue and let's add it) and you prefer to use Ansible instead of Bash. For example, you make use of the ansible-dokku roles.

Requirements

• dokku 0.19.13+
• Debian based system (uses apt package manager for installing dependencies)

Installation

$ dokku plugin:install https://github.com/decentral1se/dokku-ansible-playbook.git
$ dokku plugin:install-dependencies

Usage

All files must be placed within the ansible folder of your git repository.

• requirements.yml: what role dependencies to download before running your plays.

• pre-deploy.yml: play run before a deployment

• post-deploy.yml: play run after a deployment

• Everything is copied into $DOKKU_LIB_ROOT/data/ansible/$APP on the post-extract hook.

• Dokku will make sure that your Ansible plays are run on the right hook against the Dokku server localhost.

Passwords

You can place a ansible/.vault.sh script (don't forget to chmod +x it) that looks like this:

#!/bin/bash

set -eu -o pipefail

echo "my-cool-vault-password"

This file will be copied over to $DOKKU_LIB_ROOT/data/ansible/$APP and locked down with the correct read-only permissions for the Dokku user account. This will then be used as the Ansible Vault password file which can be used to decrypt secrets.

So, if you then encrypt a secret:

$ ansible-vault \
  encrypt_string \
  --vault-password-file ansible/.vault.sh \
  --name mysecretname \
  mysecretvalue

You can place this in your plays and it can be successfully decrypted on the host.

Example

ansible/requirements.yml

---
- src: dokku_bot.ansible_dokku
  version: v2020.3.15

ansible/pre-deploy.yml

---
- hosts: all
  tasks:
    - name: Configure the foobar environment
      dokku_config:
        app: foobar
        restart: false
        config:
          FOO: BAR
      become: true
      become_user: dokku