https://github.com/tableflip/tabs-infrastructure
:floppy_disk: Ansible scripts for deploying TABS
https://github.com/tableflip/tabs-infrastructure
Last synced: 5 months ago
JSON representation
:floppy_disk: Ansible scripts for deploying TABS
- Host: GitHub
- URL: https://github.com/tableflip/tabs-infrastructure
- Owner: tableflip
- Created: 2016-03-02T12:49:12.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2017-11-08T10:53:26.000Z (over 8 years ago)
- Last Synced: 2025-02-15T12:46:45.349Z (over 1 year ago)
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# TABS infrastructure
**Ansible scripts for deploying TABS**
```sh
├── Vagrantfile # Test the scripts locally with `vagrant up`
├── group_vars # Common variables and deploy secrets
├── dev # Inventory of hosts used in local dev
├── production # Inventory of LIVE hosts
├── roles # Define the tasks that set up a given role.
├── bootstrap.yml # Playbook for getting new vms up to spec.
└── deploy.yml # Playbook for updating our app.
```
[Ansible](http://docs.ansible.com/ansible/index.html) works by assigning roles to hosts.
- A **host** is any server in our infrastructure.
- A **role** can be things like `frontend`, `db`, etc.
Roles contain the tasks and and files to install and configure the services needed.
**e.g**: `frontend` _clones our app code, installs npm deps, and configures nginx as a proxy._
Key to making it work is ensuring tasks are idempotent. We can run all the tasks at any time. Either the task changes the system as required, or has no effect if that change is already in place.
An **inventory** defines named groups of servers. We use **playbooks** to assign roles those groups. We have a playbook that bootstraps a brand new vm to be used by ansible, which we assume will be run once on against each machine.
```sh
ansible-playbook -i production bootstrap.yml --extra-vars "ansible_user=root"
```
where
- `-i production` limits the hosts affected to just those listed in `production/inventory`
- `bootstrap.yml` is the playbook to run.
- `--extra-vars "ansible_user=root"` tells ansible to connect as `root` for this run. It's only needed while we don't have an ansible user.
[`bootstrap.yml`](bootstrap.yml) just steps up the ansible user and not much else.
```yaml
- hosts: app
roles:
- bootstrap
```
By assigning `app` hosts the role `bootstrap`, it's telling ansible to run the tasks defined in [`roles/boostrap/tasks/main.yml`](roles/bootstrap/tasks/main.yml)
```yaml
- name: Ensure base OS is up-to-date
become: yes
apt: upgrade=dist update_cache=yes
- name: Ensure ansible user exists
become: yes
user: name=ansible comment="Ansible" groups="ansible,sudo"
...
```
Once we have an ansible user, we can forget about about bootstrap, and get on with setting up our roles, as defined in [`deploy.yml`](deploy.yml)
At the start of a project, it's normal to have all the roles on the same host; a single vm dealing with the frontend, api and db, as it's then much easier to roll out additional VMs for staging and test.
When we need to scale the infrastructure we can add additional hosts to an inventory, to scale a roll horizontally across many identically configured servers, and we can split roles our to separate hosts, to create optimised VMs with a single purpose; e.g. a separate `db` server.
## Prerequisites
**You will need some secrets.** A `secrets.yaml` file to be precise, from the tableflip vault.
Drop it into the `group_vars/all/` dir, and your good to go.
## Usage
**To bootstrap a local test server with vagrant**
- Install ansible
- Install vagrant (`brew install vagrant`)
- Add to your local `/etc/hosts`:
```
10.100.106.100 dev.tabs.tableflip.io
```
```sh
# Download and provision a vm
vagrant up
# Update app vm
ansible-playbook -i dev deploy.yml
```
You now have the app & ops vm, running locally
**To bootstrap a new production vm**
- Add the new remote to the relevant inventory
- Add your public ssh key in `/root/.ssh/authorized_keys` on the remote
```sh
# bootstrap ansible user
ansible-playbook -i production bootstrap.yml --extra-vars "ansible_user=root"
# Intall app and dependencies
ansible-playbook -i production deploy.yml
```