Ansible Playbooks

A collection of Ansible scripts and templates used to deploy systems used by OpenSRP. We use Ansible's recommended alternative directory layout.

Setup

Clone this repository with its Git submodules:

git clone --recursive [email protected]:opensrp/playbooks.git && cd playbooks

This repository requires that you have Python 3 installed on the host you will be running Ansible. Make sure all pip requirements are installed by running the following command. We recommend you do this in a dedicated Python 3 virtual env:

python --version # confirm that your active python version is 3
pip install -r requirements/base.pip

Install the Ansible Galaxy requirements using these commands:

ansible-galaxy role install -r requirements/ansible-galaxy.yml -p ~/.ansible/roles/opensrp
ansible-galaxy collection install -r requirements/ansible-galaxy.yml -p ~/.ansible/collections/opensrp

Note on Mitogen

We use Mitogen as the connection backend for Ansible because it is worlds faster than the default Ansible connection backend. This, however, means that we have to install some pip requirements and point Ansible (using the strategy_plugins configuration) to a directory installed by the mitogen pip package. This, therefore, means that the location of this directory is going to be different depending on what your Python virtualenv (if you're using one) is called and what Python version you use. The path to this directory in ansible.cfg is what is in the admin host, since that is where we recommend Ansible to be ran from.

If the Ansible strategy plugin is located in a location other than ~/.virtualenvs/opensrp/lib/python3.6/site-packages/ansible_mitogen/plugins/strategy, override the default Ansible strategy plugin path by exporting ANSIBLE_STRATEGY_PLUGINS.

export ANSIBLE_STRATEGY_PLUGINS=<virtualenv_root>/lib/<python_version>/site-packages/ansible_mitogen/plugins/strategy

Inventories

Copy over your inventory files into a new directory called inventories. Note that we have inventories in the .gitignore file. We recommend you track them in a seperate private git repository. Please do not make pull requests to this repository with inventory files that might expose aspects of your infrastructure that you don't want exposed.

We recommend you use the following directory structure:

Split your inventories based on DevOps clients, and their server environments.

Example DevOps clients include:

• personal (for your personal inventories)
• tb-reach
• zeir

And environments:

• production
• preview
• staging

The inventory directory structure, hence, looks like:

inventories/
│── [DevOps Client 1]
│   │── [Environment 1]
│   │   │── group_vars
│   │   │── hosts
│   │   └── host_vars
│   .
│   .
│   .
│   └── [Environment m]
│       └ ...
.
.
.
└── [DevOps Client n]
    └ ...

You could alternatively use the included script scripts/new_inventory.sh to generate from the sample inventories a specific application. For example:

./scripts/new_inventory.sh reveal_web demo production

Generates the following inventory files:

inventories
├── demo
│   └── production
│       └── group_vars
│           ├── reveal_web
│           │   ├── vars.yml
│           │   └── vault.yml
│           └── reveal_web_client
│               └── vars.yml

Note: The hosts file is not part of the file generated. You will need to generate yourself, look at the sample-inventories/inventory-a/hosts for an example.

Note: Most changes would be in the service name _client folder, there should be very minimal changes in the service name folder other than the vault.yml file.

Each environment directory contains a hosts file that's used to group host_vars into group_vars and group_vars into other group_vars. Please avoid setting ansible variables in that file.

Packer

Packer allows for packaging of machine/container images from Ansible scripts like the ones defined in this repository. To run any of the packer files defined in this repository, do:

packer build -var-file=inventories/<DevOps client>/<environment>/packer/<name of setup>/<name of variant>.json packer/<name of setup>.json

Terraform

Terraform enables you to use infrastructure as code to provision and manage any cloud, infrastructure, or service.

You can get started quickly by copying one of the sample terraform deployments.

./scripts/new_terraform.sh reveal-viz demo production

Generates the following Terraform deployment for the Reveal Web and Apache Superset deployed on the same image. Assumes you have built the Packer image using the packer/aws/reveal-web-superset.json Packer configuration file.

terraform/deployments
├── demo
│   └── production
│       └── reveal-viz
│           ├── init.sh.tpl
│           ├── main.tf
│           ├── terraform.tfvars
│           ├── variables.tf
│           └── versions.tf

You will need to edit the terraform.tfvars and the state management section of main.tf before you can make use of the configuration.

cd terraform/deployments/demo/production/reveal-viz

# initialize the Terraform state
terraform init

# Verify your plan
terraform plan

# Apply your changes to create the resources
terraform apply