How to use these roles

There is quite some documentation available already, but it can’t hurt to briefly explain how to use these roles.

My promise

Installing the roles

Before using any role, they need to be installed. There are a few ways to do that:

  1. Install them one-by-one using ansible-galaxy install robertdebock.bootstrap for example.
  2. Install them using a requirements.yml file (see below) using ansible-galaxy install --role-file requirements.yml.

The requirements.yml file is a list of roles, for example:

---
- robertdebock.bootstrap

These roles are typically installed in ~/.ansible/roles/. You can configure Ansible to look somewhere else though, for example this ansible.cfg stores the roles “locally”, in the same directory where the ansible.cfg is found:

[default]
roles_path = roles

Including the roles in playbooks

Once the roles are downloaded, you can integrate them into a playbook, for example:

---
- name: bootstrap all hosts
  hosts: all
  become: yes
  gather_facts: no

  roles:
    - role: robertdebock.bootstrap

You can also use [include_role](https://docs.ansible.com/ansible/latest/modules/include_role_module.html).

Using variable

Most roles can be controled using variables. For example by using the vars: statement:

---
- name: bootstrap all hosts
  hosts: all
  become: yes
  gather_facts: no


  roles:
    - role: robertdebock.bootstrap
      bootstrap_user: root

Most roles have quite a few variables and the playbook can get long using the example above. Another way to use variables in in the inventory, specifically in the group variables. For example the file group_vars/all.yml can contain:

---
bootstrap_user: root

Full example

This is a layout of the file and directory structure that I tend to use:

├── ansible.cfg
├── inventory
│   ├── group_vars
│   │   └── all.yml
│   └── hosts
├── playbook.yml
└── roles
    ├── requirements.yml
    └── robertdebock.bootstrap

Also see best practices.

ansible.cfg

[defaults]
roles_path=roles
retry_files_enabled=no
inventory=inventory

Also see Ansible configuration.

inventory/hosts

fedora-s-1vcpu-2gb-fra1-01 ansible_host=167.99.141.134

Also see working with inventories.

inventory/group_vars/all.yml

---
bootstrap_wait_for_host: yes

Also see group variables

playbook.yml

---
- name: bootstrap all hosts
  hosts: all
  become: yes
  gather_facts: no

  roles:
    - robertdebock.bootstrap

Also see working with playbooks.

roles/requirements.yml

---
- robertdebock.bootstrap

Also see installing roles from a file.

roles/robertdebock.bootstrap

Although a consumer of the role does not need to look into the role and ansible-galaxy install will manage the contents of these roles, here is a brief explanation what can be found here:

Also see Ansible roles.