diff --git a/DESIGN.md b/DESIGN.md index fdffeaf..49ac8aa 100644 --- a/DESIGN.md +++ b/DESIGN.md @@ -1,7 +1,26 @@ # design +## inputs + +What things the user will be giving us from the application repository side of +things and therefore what we'll need to pipe into the provisioning and +deployment process. + +1. env vars to be `dokku_config` loaded +1. persistence layer docker volume mounts +1. application layer http port to be mapped on host layer +1. nginx.conf.d customations + ## post-extract 1. Create a /var/lib/dokku/data/ansible/\$APP folder 1. Copy over nginx.conf.d folder 1. Copy over vault folder and and env.yml file + +## pre-deploy + +TODO. + +## post-deploy + +TODO. diff --git a/README.md b/README.md index e4231e2..742a795 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,10 @@ Deploy applications on Dokku using Ansible. -Work In Progress, See [DESIGN.md](./DESIGN.md). +It is a work in progress, please see the following planning documents: + +- [DESIGN.md](./DESIGN.md) +- [dokku-packaging-format.md](https://git.autonomic.zone/autonomic-cooperative/organising/wiki/dokku-packaging-format) ## Requirements