Try to explain API further

This commit is contained in:
Luke Murphy 2020-03-19 01:55:49 +01:00
parent dd29d4f28b
commit 12de0a96d8
No known key found for this signature in database
GPG Key ID: 5E2EF5A63E3718CC
1 changed files with 29 additions and 2 deletions

View File

@ -18,5 +18,32 @@ $ dokku plugin:install https://github.com/decentral1se/dokku-ansible-playbook.gi
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`: the play to run before the application is deployed.
* `post-deploy.yml`: the play to run after the application is deployed.
The following hooks are supported (add `.yml` to the hook name in `.ansible`):
* `pre-deploy`
* `post-deploy`
* `create-app`
## Example
### .ansible/requirements.yml
```yaml
---
- src: dokku_bot.ansible_dokku
version: v2020.3.15
```
### .ansible/create-app.yml
```yaml
---
- hosts: all
tasks:
- name: Create foobar group
group:
name: foobar
system: true
state: present
```