Ansible

Requirements

Requirements on hosts:

• SSH
• Python 2.5 or later

Control machine requires Python 2.6 or later.

Ansible is push-based, i.e. updates occur only when a playbook is run. However, pull-based support is available via ansible-pull.

No abstraction is available, so playbooks are OS and distribution specific (e.g. use apt for Debian).

Ansible runs each task in parallel across every host, and does not move on to the next task until all hosts have completed.

Configuration file

Ansible will look for an ansible.cfg file in the following locations:

1. Location specified by ANSIBLE_CONFIG configuration.
2. ./ansible.cfg
3. ~/.ansible.cfg
4. /etc/ansible/ansible.cfg

Placing the file in the current directory alongside playbooks is the easiest solution, and keeps everything together.

Sample configuration file:

[defaults]
hostfile = hosts
remote_user = vagrant
private_key_file = ~/.vagrant.d/insecure_private_key
host_key_checking = False

SSH options

Accelerated mode makes an initial SSH connection and then sends further commands via port 5099. To use this:

• Install python-keyczar
• Add accelerate: true at the top level of the playbook

There are some problems using accelerated mode with sudo, which requires additional configuration.

Port 5099 must of course be allowed through the firewall.

Command module

Arbitrary commands can be executed using the command module:

ansible hostname -m command -a uptime

Passing -s runs the command as root, using sudo.

Update packages:

ansible hostname -s -m apt -a "update_cache=yes"

Install package:

ansible hostname -s -m apt -a "name=apache2"

Restarting service:

ansible hostname -s -m service -a "name=apache2 state=restarted"

Playbooks

Playbooks are YAML files which contain tasks to be run on a group of hosts. Each playbook must contain:

• A list of hosts.
• A list of tasks to be run on the hosts.

Command: ansible-playbook playbook.yml

The sudo option in a playbook means that every task should be run via sudo. This is particularly useful on Ubuntu servers, and also on servers where root SSH login has been disabled.

All tasks in a playbook can be listed by running:

ansible-playbook --list-tasks playbook.yml

Handlers

Handlers are similar to tasks, but they only run if notified. An example handler might be:

handlers:
    - name: restart apache
      service:
        name: apache2
        state: restarted

This will run if a task includes:

notify: restart apache

Handlers run after all tasks, and only run once regardless of how many times they are notified. Handlers are run in the order they are defined, not the order they are notified.

File conventions

• Support files (e.g. configuration) in: files
• Template files in: templates

Roles

Each Ansible role has a name, e.g. web. Files associated with this role go into roles/web, including:

• tasks/main.yml - tasks
• files/ - files, as per usual Ansible layout
• templates/ - Jinja2 templates
• handlers/main.yml - handlers
• defaults/main.yml - default variables than can be overridden.

The file structure can be automatically created using:

ansible-galaxy init base

The above command will create a file structure for a role called base in the current directory.

A playbook may contain multiple roles, and variables for each role can be overridden on a per-play basis.

Tasks can be run before or after roles are applied.

When using a template directive within a role, Ansible will look for the file in the templates/ subdirectory, unlike in top-level playbooks where you need to specify the full path (i.e. templates/file.j2).

Base server

Packages that should be installed on a basic server:

• OpenSSH
• UFW - firewall rules
• SSHGuard - automatically block dictionary attacks etc.
• vnstat - monitor total amount of network traffic
• Postfix - for outgoing email (e.g. notifications)
• Monit - basic monitoring, might want to swap out for something more sophisticated. At a bare minimum we need to monitor the disk space and any services.
• NTP - for time synchronisation (no longer required as Ubuntu ships with timesyncd, part of systemd)
• unattended-upgrades - with appropriate configuration to update everything, not just security updates, and send out an email
• Backup scripts

Web server

• Nginx
• PHP FPM
• Certbot

Database server

• MariaDB - usually mariadb-server and mariadb-client
• MySQL-python - python3-mysqldb
• Set root password to a random value?
• MySQL backups

Role dependencies

Roles can depend on other roles. Dependencies are specified in meta/main.yml, for example:

dependencies:
  - role: base
    vars:
      install_packages:
        - nginx

Testing

The official testing framework for Ansible roles is Molecule.

Links

• Infrastructure testing with Molecule - Talk from Ansiblefest 2017.
• How We Test Our Ansible Roles with Molecule
• Testing your Ansible roles with Molecule
• Ansible for DevOps
• On building an Ansible training environment on FreeBSD