This repository is DEPRECATED and replaced by the following 2 repositories which are refactored to allow for easier integration into any project by using Ansible collection format.

• ansible-coord - Ansible collection for deploying Django projects.
• ansible-coord-starter - A starter project for using coord which features using vagrant for testing your playbooks.

Please use the new repositories.

The purpose of this ansible playbook is to store the multi-environment configuration for multiple django projects utilizing the same playbooks for deployment.

Ansible is powerful and provide a multitude of ways to configure your project. This repository aims to focus and streamline this into a more simplified workflow providing clean starter project with tools to fully deploy django and celery workers which meant for further customization and building on top of.

• Configure and deploy Django projects using pipenv, supervisor and uvicorn.
• Use any python version with pyenv using ananov.pyenv Ansible role.
• Easy configuration of Celery workers.
• PostgreSQL, user and database configuration.
• RabbitMQ vhost and user configuration.
• Configure memcache instances
• Custom nginx configuration

The basic structure of how to the configuration is stored looks like the following:

siplay
|
├── inventory1        <-- inventory for project 1
|   ├── files         <-- additional custom files 
|   ├── group_vars
|   |   ├── vagrant.yml    <-- general configuration
|   |   ├── production.yml
|   |   └── staging.yml
|   ├── vagrant       <-- host specific configuration
|   ├── vagrant.vault <-- secrets vault for login credentials
|   ├── production
|   ├── production.vault
|   ├── staging
|   └── staging.vault
|
├── inventory2         <-- inventory for project 2
|   ├── files
|   ├── group_vars
|   |   ├── vagrant.yml
|   |   ├── production.yml
|   |   └── staging.yml
|   ├── vagrant
|   ├── vagrant.vault
|   ├── production
|   ├── production.vault
|   ├── staging
|   └── staging.vault
|   
├── playbooks           <-- playbooks and roles
├── play                <-- simplified run script
...

Multiple inventory folders are stored at the root of the project and multiple environment configuration is stored inside.

An example of the intial command to setup services and deploy the project is the following:

play test-inventory local setup

And iterative deployments will use the following command to reduce work and speed up the deployment:

play test-inventory local deploy

The commands are idempotent so feel free to use whichever is more suitable.

The simple script play is used to collect together parameters which runs the ansible-playbook command with all the relevent parameters and just easier and faster to type on command line.

This is the starter ansible playbook I use when I need to automate my deployments. This allows me keep relevant projects together, deploy them in a unified workflow and allowing me to customize how they are deployed and interact with each other. Also it is a flexible structure allowing for growth when needed. Of course, this project layout is clean enough that it also works for single projects as well.

There is a test-inventory which is already configured to deploy test-django-project repository which is a blank django project generated with my django-project-template repository to make it very easy for anyone to try this out via:

• Vagrant (recommended)
• Deploy to localhost

First let's make sure you have ansible installed.

pip install ansible

Setup the basics for this playbook:

git clone https://github.com/bernardko/siplay.git
cd siplay
ansible-galaxy install -r requirements.yml

This is the quickest way to see this ansible playbook in action and only requires Vagrant to be installed on your system. Just run:

vagrant up

You will need to the following edit the following in the siplay/test-inventory/local.vault file and enter a user account with sudo access:

ansible_user: username
ansible_become_pass: mypassword

You'll also need to make sure you can SSH into this account via localhost:

ssh username@localhost

If this works, then you are ready to go, run the following get deploy:

./play test-inventory local setup

The best way to get started using this is to copy test-inventory and start customizing the settings to your own project. Make sure you explore the siplay/playbooks to how the playbooks and roles are structured. Also check out the play script to see how commands are run.

Remember to encrypt the secrets vault:

ansible-vault encrypt test-inventory vagrant.vault

Start and stop celery and uvicorn processes

./play test-inventory local processes start
./play test-inventory local processes stop
./play test-inventory local processes restart

Use these commands to clean up leftover files if you tested deploying the test-inventory to your localhost.

Remove celery and uvicorn processes

./play test-inventory local processes remove

Delete Django project folder

./play test-inventory local app DELETE

Delete rabbitmq vhost and user.

./play test-inventory local queues DELETE

Delete postgresql database and user.

./play test-inventory local dbs DELETE

Delete nginx configuration

./play test-inventory local loadbalancers DELETE