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. 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 various hooks against the Dokku server localhost.

• 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
• vars.yml: variables (you'll need to include manually with the include_vars module)

Passwords

Ansible uses the vault password file which can be used to decrypt secrets.

To get started with enabling this, you should generate a vault password for your self and run the following on your Dokku host.

$ dokku ansible-playbook:add-vault-password

Then you can start to encrypt your passwords on your local machine with the following.

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

Where ansible/.vault.sh might look like this.

#!/bin/bash

set -eu -o pipefail

echo "my-cool-vault-password"

Then for example, if you want to pass a sudo password, you might include a vars.yml.

---
ansible_become_password: !vault ...

Permissions

Since the dokku user account runs the plays on the host, you will need to deal with sudo permissions when you want to use become: true to run a privilege escalation to the root account. You can give your dokku user account passwordless sudo access but that would give a lot of power to people who can get access to that user account. A solution to this can be to add your dokku to the sudoers group, give the account a password (passwd dokku && usermod -aG sudo dokku) and pass ansible_become_password in as a variable.

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