🎉What is it? 🎯Who is it for? 💪Philosophy 🔒Knowledge prerequisites 🔒Technical prerequisites 🚀Quick start
- 1. Make this repository yours
- 2. Install the required dependencies
- 3. Provision your local machine and deploy the example stack
- 4. Write your own Docker Swarm Compose files
- 5. Test on a Vagrant cluster
- 6. Edit and encrypt your production environment variables
- 7.a. Create, provision and deploy your production environment with Terraform
- 7.b. Provision and deploy your production environment to an existing infrastructure
- 8. Add other remote environments
- 9. Make your team members autonomous
🎉 What is it?
A boilerplate to create a full Infrastructure as Code (IaC) repository, from provisioning to deployment with:
- Terraform to create your cloud infrastructure
- Vagrant to reproduce a production-like environment locally
- Ansible to provision Virtual Machines and set up the Docker Swarm cluster
- Ansible again to deploy your stacks
It handles different environments:
localhost: a single node Docker Swarm cluster on your machine, useful for development (demo)
vagrant: a 3 nodes production-like cluster deployed with Vagrant on your machine, useful for testing (demo)
production: your production environment! It can be created by Terraform or you can use an existing bare metal/VMs infrastructure (demo)
- other remote production-like environments of your choice: staging, QA...
On top of that, it features:
- A companion CLI (
./tads), which is a wrapper around Terraform, Ansible and Vagrant commands. For example:
ansible-playbook -i inventories/production -D --vault-id production@vault_keys/production deploy.ymlbecomes
./tads ansible-playbook production deploy. More convenient, don't you think?
- Docker Swarm Compose files templated with Jinja2, so you can define your services once, while being able to customize them in each environment, from the same file
- An example which implements dockerswarm.rocks' recommended good practices: traefik reverse proxy with HTTPS (even locally), and more coming soon
- A smart
/etc/hostsmanagement to access your local and Vagrant applications with
- AES-256 encryption of your production credentials with ansible-vault
With T.A.D.S., you will be able to onboard a new developer on your project in less than 3 minutes, with just 3 commands! Even if you have a complex microservices architecture. Forget about your outdated wikis or installation procedures, they are no longer needed! See the example user README to get a preview of what your new procedures could look like.
🎯 Who is it for?
If you recognize yourself into some of these statements, this project is definitely for you:
- I am the only one who understands how the production environment works
- I still have to execute SSH commands in production and this makes me sad because I cannot rollback or be reviewed :(
- Setting up a new development environment for a new team member takes an entire day, and a lot of resources
- My team suffers from "Microservices Hell": we have to install many services before being able to dev
- Developers use docker-compose on their machine, while we use something else in production
- I want to do Infrastructure as Code (IaC)
- I want to promote the DevOps mindset in my team
- I don't need/want Kubernetes features and complexity
- I don't want to be vendor locked by a service like AWS ECS
- I start a new project and I want to bootstrap it quickly with good practices presets
On the contrary, this project might not be for you if:
- You have a large cluster (more than 100 machines)
- You need Kubernetes features like autoscaling
... but don't be sad, I am thinking of creating a similar project for K8s ;) Tell me if you want to help!
- Every environment infrastructure, including dev, is versioned into one repository
- Same development environment installation procedure for everyone
- No SSH, no manual actions, everything must be code
- Every change to infrastructure must be code reviewed to:
- Avoid mistakes
- Make other (including non-DevOps) team members able to learn
- Everyone, not only DevOps team members, is able to:
- Create their development environment in a minute with just one command
- Reproduce a production-like environment locally
- Understand the whole infrastructure
- Propose modifications to the infrastructure, while being able to test them locally
- This project is a boilerplate, not a framework: modify it to fulfill your needs!
- The companion CLI is written in Bash so it is easy to understand what a command does, and it is easy to modify command behaviors or to add new ones
🔒 Knowledge prerequisites
Before going further, I assume that you already have the knowledge and practice with Docker Swarm mode, Ansible, Terraform, and Infrastructure as Code in general. If it is not the case, I urge you to study and practice before. You can use this material as a starter:
- Getting started with swarm mode and Docker Swarm Rocks
- Ansible Quickstart guide
- Terraform getting started
🔒 Technical prerequisites
- Local machine:
- Ubuntu >= 18.04 or similar (PRs are welcome to update this list)
- Ansible >= 2.8
- Vagrant >= 2.0 (optional)
- Virtualbox >= 5.2 (optional)
- Terraform >= 0.12 (optional)
- Remote environments:
- A cloud provider account (tested on AWS and Digital Ocean so far)
- An existing bare metal / VMs infrastructure, with Linux based OSes (tested on Ubuntu server 18.04 and Debian 9 so far)
Have a look at Install the required dependencies for installation procedures.
OS X: It should not be that hard to make the project run on OS X. PRs are welcome! I am also thinking of creating a dockerized version of the project to improve compatibility.
🚀 Quick start
1. Make this repository yours
Clone this repo, create your own and push the code to it.
git clone --single-branch https://github.com/Thomvaill/tads-boilerplate.git <YOUR_PROJECT_NAME> cd <YOUR_PROJECT_NAME> git remote set-url origin <YOUR_REPO_URL> git push
2. Install the required dependencies
This will install Ansible, Vagrant, Virtualbox and Terraform on your local machine:
You can also manually install the dependencies if your preferer.
3. Provision your local machine and deploy the example stack
./tads ansible-playbook localhost provision ./tads ansible-playbook localhost deploy
The first command will:
- Install Docker on your local machine
- Set up a Swarm cluster with one manager node
And the second one will deploy
If everything went well, you are now able to access it at this URL: https://yourcompany.localhost/
4. Write your own Docker Swarm Compose files
Now that the example stack is running on your machine, you can deploy your own services.
First, you probably need to change the
domains dict in
This file contains all Ansible variables default values. These values can be overridden later in other group_vars files.
You are free to add your variables in it.
Then, you can write your own Docker Swarm Compose files, following this naming convention:
These files are Jinja2 templates.
You are highly encouraged to use Ansible variables in them, so your template file can be used across all your environments.
Have a look at
ansible/stacks/example_app/example_app.yml.j2 to see a good example.
Finally, do not forget to add your new stacks to
To help you with the
ansible/group_vars directory, here is a representation of Ansible groups:
all ├── dev | ├── localhost | └── vagrant ├── production ├── staging └── any_other_remote_environment...
Each group has its
_overrides counterpart, which enables you to override some variables locally in a
which is not versionned.
Have a look at
.sample.yml files to see some examples.
While developing, perform some
./tads ansible-playbook localhost deploy to test your deployment.
Do not forget to run
./tads ansible-playbook localhost provision again if you have changed domain names.
- You can use
./tads ansible-playbook localhost allto provision and deploy in a single command
- You can use tags to go quicker. Example:
./tads ansible-playbook localhost all --tags dev,stack-traefik
- Always reference your Docker images with tags! It is a bad practice to rely on the
:latesttag because you don't control what will be pushed to production. With specific tags, you will have idempotent deployments and you will be able to perform rollbacks
5. Test on a Vagrant cluster
Now that you are happy with your localhost environment, you should test the provisioning and the deployment on an environment which looks more like a production environment. For instance, on localhost, you can have just one node! And maybe you forgot some dependencies that are already installed on your computer. With Vagrant, you will be able to test your stacks on a fresh 3 nodes Swarm cluster.
vagrant/vagrant.ymland adjust its settings
./tads vagrant up
./tads ansible-playbook vagrant all
Now, you will be able to test your stacks deployed on Vagrant. If you have kept the example app, you can test it on https://yourcompany.test/
- To destroy your cluster:
./tads vagrant destroy
- To SSH into the first node:
./tads vagrant ssh vagrant-1
6. Edit and encrypt your production environment variables
Before going further, you should edit your production group_vars files:
When you are done, do not commit
production_encrypted.yml! You have to encrypt it first:
./tads ansible-vault production init-key
./tads ansible-vault production encrypt ansible/group_vars/production_encrypted.yml
The first command has generated a random key in
You must not commit this file. You should keep it in a safe place, and share it with your authorized team members securely.
If you lose it, you won't be able to decrypt your files anymore. The second one has encrypted your file
with AES-256. You can now commit it.
You can still edit this file by running
./tads ansible-vault production edit ansible/group_vars/production_encrypted.yml. Always check that you do not commit an unencrypted version of this file by mistake.
7.a. Create, provision and deploy your production environment with Terraform
Now that everything is fine locally, it is time to create and deploy your production environment!
terraform/environments/production is an AWS example. PRs are welcome for other providers!
To make it work, you should:
- Have a working SSH key pair
- Have a registered domain name managed by Route53
- Install AWS CLI:
pip3 install awscli --upgrade --user
- Configure your credentials:
Terraform will use this default profile credentials.
Then, you can run
./tads terraform production init and
./tads terraform production apply.
This example will create:
- A custom VPC
- 3 subnets into separate Availability Zones, for high availability
- 3 manager nodes and 1 worker node (with spread placement groups, for high availability)
- 1 classic ELB to distribute TCP traffic on port 80 and 443 to the manager nodes (traefik is responsible for SSL termination)
The CLI will also create the corresponding Ansible inventory for you in
ansible/inventories/production from Terraform outputs. You should commit it.
You should also commit the Terraform state file, or better: use a remote state.
Then, you have to create an alias in Route53 to the ELB.
Finally, you can run
./tads ansible-playbook production all and your website will be available!
- This is an example, you should not use it as is in production!
- Although resources created by the example are eligible to free tier, charges may occur depending on your situation
./tads terraform production destroywith caution :-)
7.b. Provision and deploy your production environment to an existing infrastructure
If you don't want to use a cloud provider, you can use classic Virtual Machines. For a production environment, you should have at least 3 manager nodes, so 3 VMs. They should be fresh installs. Ubuntu server 18.04 or Debian 9 is fine.
- Make sure you can SSH into the VMs with your key pair
- Edit it
./tads ansible-playbook production alland your website will be available!
8. Add other remote environments
You can add other remote environments, like production.
For Terraform, you just have to duplicate
terraform/environments/production to the directory of your choice, eg
After editing it, you can run
./tads terraform staging apply, it will create the
ansible/inventories/staging inventory file.
For an existing bare metal infrastructure, you just have to create the
ansible/inventories/staging inventory file.
Then, in Ansible, you have to create these files:
Then, create the ansible-vault key and encrypt the file:
./tads ansible-vault staging init-key
./tads ansible-vault staging encrypt ansible/group_vars/staging_encrypted.yml
Finally, provision and deploy!
./tads ansible-playbook staging all
9. Make your team members autonomous
It is one of this project's goals: DevOps is not a job, it is a mindset! Now that you have a beautiful IaC, it is time to onboard your team members.
- Replace this
README.example.mdand customize it, so your team can use the project easily
- Make your developers use this project to configure their machine and develop
- Let your developers update/create stacks on their own, show them how to test their changes locally
- Enjoy :-)
Where is the companion CLI documentation?
There is no documentation of the CLI since you will probably modify it, or add new commands!
To get some help, just run
./tads. Do not hesitate also to have a look at the source into the
scripts directory. This CLI is just a wrapper of Terraform, Ansible and Vagrant commands.
What if I don't want to deploy all the stacks locally?
Use Ansible tags! Example if you just want to deploy the
./tads ansible-playbook localhost deploy --tags stack-traefik,stack-myapp.
How to do Continuous Delivery / Deployment?
I have not taken the time to develop this feature properly yet. But basically what you can do is:
- Always referer to your Docker images with tags
- Manage those tags into a separate
- Write a script that can update a tag, perform a
./tads ansible-playbook production deploy, and in case of success commit and push the file
- Make your CI/CD tool use this script in your deployment pipeline
How to manage persistant storage?
This problematic is beyond the scope of this project and depends a lot on your infrastructure / cloud provider. I advise you to have a look at REX-Ray.
This might be a future feature to implement this plugin in the boilerplate.
Pull Requests are more than welcome! Please read CONTRIBUTING.md for more details.
./tads install-dependencies --dev make lint make test
- John Patterson for his ansible-swarm-playbook and his article
- Jeff Geerling for his pip and docker Ansible roles
- The forMetris team for being first users/testers of the project, and especially Axel Marbois for his contribution
This project is licensed under the MIT license, Copyright (c) 2019 Thomas Vaillant. For more information see LICENSE file.