From 794df9a647f60be87a383fc3ece7949a2e0a403d Mon Sep 17 00:00:00 2001 From: Amit Kumar Date: Wed, 27 May 2020 23:56:50 +0100 Subject: [PATCH] Add documentation for setting it up --- README.md | 25 +++++++++++++++++++ .../{repository.yml => clone_repository.yml} | 0 deployment/{compose.yml => compose_start.yml} | 0 deployment/{docker.yml => docker_setup.yml} | 0 deployment/main.yml | 5 ---- deployment/site.yml | 5 ++++ 6 files changed, 30 insertions(+), 5 deletions(-) rename deployment/{repository.yml => clone_repository.yml} (100%) rename deployment/{compose.yml => compose_start.yml} (100%) rename deployment/{docker.yml => docker_setup.yml} (100%) delete mode 100644 deployment/main.yml create mode 100644 deployment/site.yml diff --git a/README.md b/README.md index 0ce1a44..f00ec28 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,18 @@ # Ansible Tutorial +A basic Django app with postgres as database deployed on DigitalOcean (droplet) via Ansible. + +## Environment variables + +Create a `.env` file in the root of the cloned repository, with following variables: + +```bash +POSTGRES_DB=sample +POSTGRES_USER=postgres +POSTGRES_PASSWORD="set strong password for postgres" +SUPERUSER_PASSWORD="set strong password for django admin dashboard" +DO_API_TOKEN="Digital Ocean token, if deploying" +``` ## Running the app @@ -13,3 +26,15 @@ docker-compose build ```bash docker-compose up ``` + +After running the commands above, the app should be running at: +http://127.0.0.1:8000/ + +## Deployment + +This is deployed on Digital Ocean Droplet via Ansible. To deploy run the +following command after `docker-compose up`: + +```bash +docker-compose exec web ansible-playbook deployment/site.yml +``` diff --git a/deployment/repository.yml b/deployment/clone_repository.yml similarity index 100% rename from deployment/repository.yml rename to deployment/clone_repository.yml diff --git a/deployment/compose.yml b/deployment/compose_start.yml similarity index 100% rename from deployment/compose.yml rename to deployment/compose_start.yml diff --git a/deployment/docker.yml b/deployment/docker_setup.yml similarity index 100% rename from deployment/docker.yml rename to deployment/docker_setup.yml diff --git a/deployment/main.yml b/deployment/main.yml deleted file mode 100644 index 4231d33..0000000 --- a/deployment/main.yml +++ /dev/null @@ -1,5 +0,0 @@ ---- -- import_playbook: digital_ocean_droplet.yml -- import_playbook: docker.yml -- import_playbook: repository.yml -- import_playbook: compose.yml diff --git a/deployment/site.yml b/deployment/site.yml new file mode 100644 index 0000000..c986f94 --- /dev/null +++ b/deployment/site.yml @@ -0,0 +1,5 @@ +--- +- import_playbook: digital_ocean_droplet.yml +- import_playbook: docker_setup.yml +- import_playbook: clone_repository.yml +- import_playbook: compose_start.yml