Роли Ansible

Введение

В этом лабораторном занятии вы познакомитесь с ролями Ansible (Ansible Roles) — мощной функцией, которая позволяет организовывать и структурировать ваш код Ansible (Аnsible) в модульном и повторно используемом виде. Роли предоставляют способ автоматической загрузки связанных переменных, файлов, задач, обработчиков и других артефактов Ansible (Аnsible) на основе известной структуры файлов. К концу этого лабораторного занятия вы поймете, как создавать, использовать и организовывать роли Ansible (Ansible Roles), что поможет вам писать более поддерживаемый и масштабируемый автоматизационный код.

Skills Graph

Понимание структуры ролей Ansible

Прежде чем мы начнем создавать свою собственную роль, давайте разберемся в структуре роли Ansible (Ansible Role).

Роль Ansible (Ansible Role) имеет определенную структуру каталогов с восемью основными стандартными каталогами. Каждый каталог должен содержать файл main.yml, который содержит соответствующее содержимое. Вот краткий обзор каждого каталога:

1. tasks - содержит основной список задач, которые будут выполняться этой ролью.
2. handlers - содержит обработчики (handlers), которые могут быть использованы этой ролью или вне этой роли.
3. defaults - содержит переменные по умолчанию для роли.
4. vars - содержит другие переменные для роли.
5. files - содержит файлы, которые могут быть развернуты с помощью этой роли.
6. templates - содержит шаблоны (templates), которые могут быть развернуты с помощью этой роли.
7. meta - определяет метаданные для этой роли.
8. tests - содержит тесты для роли.

Начнем с создания простой структуры роли. Сначала перейдите в каталог своего проекта:

cd ~/project

Теперь создадим каталог для наших ролей:

mkdir -p roles/example_role
cd roles/example_role

Флаг -p в команде mkdir создает родительские каталоги по мере необходимости.

Теперь создадим базовую структуру для нашей роли:

mkdir {tasks,handlers,defaults,vars,files,templates,meta}

Эта команда создает все необходимые нам каталоги для роли за один раз. Это удобный ярлык в bash для создания нескольких каталогов сразу.

Теперь создадим файл main.yml в каталоге tasks:

nano tasks/main.yml

Добавьте следующее содержимое в этот файл:

---
- name: Print a message
  debug:
    msg: "This is a task from our example role!"

Сохраните и выйдите из редактора nano (Ctrl+X, затем Y, затем Enter).

Теперь мы создали базовую структуру роли с простой задачей. В следующих шагах мы будем расширять ее и узнаем, как использовать нашу роль.

Расширение нашей роли

Теперь, когда у нас есть базовая структура роли, давайте расширим ее, чтобы включить больше компонентов типичной роли Ansible (Ansible role). Мы добавим переменные, обработчик (handler) и шаблон (template).

Сначала добавим переменную по умолчанию. Создайте файл main.yml в каталоге defaults:

nano defaults/main.yml

Добавьте следующее содержимое:

---
example_variable: "This is a default value"

Это устанавливает значение по умолчанию для example_variable, которое можно переопределить при использовании роли.

Далее создадим обработчик (handler). Создайте файл main.yml в каталоге handlers:

nano handlers/main.yml

Добавьте следующее содержимое:

---
- name: Restart example service
  debug:
    msg: "This would restart a service in a real scenario"

В реальной ситуации этот обработчик (handler) мог бы перезапустить службу, но в этом примере мы просто выводим сообщение.

Теперь создадим шаблон (template). Создайте файл с именем example_template.j2 в каталоге templates:

nano templates/example_template.j2

Добавьте следующее содержимое:

This is an example template.
The value of example_variable is: {{ example_variable }}

Этот шаблон (template) использует синтаксис Jinja2 для включения значения нашей переменной example_variable.

Наконец, обновим файл tasks/main.yml, чтобы использовать эти новые компоненты:

nano tasks/main.yml

Замените существующее содержимое на:

---
- name: Print a message
  debug:
    msg: "This is a task from our example role!"

- name: Use our variable
  debug:
    msg: "The value of example_variable is: {{ example_variable }}"

- name: Create a file from our template
  template:
    src: example_template.j2
    dest: /tmp/example_file.txt
  notify: Restart example service

Этот обновленный список задач теперь использует нашу переменную, создает файл из нашего шаблона (template) и уведомляет наш обработчик (handler).

Использование нашей роли в плейбуке

Теперь, когда мы создали нашу роль, давайте используем ее в плейбуке (playbook). Сначала вернемся в корневой каталог проекта:

cd ~/project

Создайте новый файл плейбука (playbook) с именем use_role.yml:

nano use_role.yml

Добавьте следующее содержимое:

---
- name: Use our example role
  hosts: localhost
  roles:
    - example_role

Этот плейбук (playbook) просто применяет нашу роль example_role к локальному хосту.

Теперь запустим этот плейбук (playbook):

ansible-playbook -i inventory.ini use_role.yml

Вы должны увидеть вывод, показывающий выполнение задач, которые мы определили в нашей роли.

Разберем, что произошло:

1. Ansible (Аnsible) искал роль с именем example_role в каталоге roles.
2. Он нашел нашу роль и выполнил задачи, определенные в tasks/main.yml.
3. Он использовал значение по умолчанию для example_variable, которое мы установили в defaults/main.yml.
4. Он создал файл в /tmp/example_file.txt с использованием нашего шаблона (template).
5. Наконец, он вызвал наш обработчик (handler), который вывел отладочное сообщение.

Это демонстрирует, как роли позволяют нам объединять связанные задачи, переменные и файлы, делая наш код Ansible (Аnsible) более организованным и повторно используемым.

Переопределение переменных роли

Одной из мощных возможностей ролей Ansible (Ansible roles) является возможность переопределения переменных по умолчанию. Это позволяет создавать гибкие роли, которые можно использовать в различных сценариях.

Создадим новый плейбук (playbook), который переопределит нашу переменную example_variable. Создайте файл с именем override_role_var.yml:

nano override_role_var.yml

Добавьте следующее содержимое:

---
- name: Use our example role with a custom variable
  hosts: localhost
  vars:
    example_variable: "This is a custom value"
  roles:
    - example_role

В этом плейбуке (playbook) мы устанавливаем example_variable в пользовательское значение перед применением нашей роли.

Теперь запустим этот плейбук (playbook):

ansible-playbook -i inventory.ini override_role_var.yml

Вы должны увидеть, что задачи теперь используют пользовательское значение для example_variable вместо значения по умолчанию.

Это демонстрирует, как можно создавать роли с разумными значениями по умолчанию, но при этом иметь гибкость для настройки их поведения при необходимости.

Зависимости ролей

Роли Ansible (Ansible roles) могут зависеть от других ролей. Это позволяет создавать более сложные роли, комбинируя более простые. Создадим новую роль, которая будет зависеть от нашей роли example_role.

Сначала создадим новую структуру роли:

cd ~/project/roles
mkdir -p dependent_role/{tasks,meta}

Теперь определим зависимости роли. Создайте файл main.yml в каталоге meta:

nano dependent_role/meta/main.yml

Добавьте следующее содержимое:

---
dependencies:
  - role: example_role

Это указывает, что роль dependent_role зависит от роли example_role.

Теперь добавим задачу в нашу роль dependent_role. Создайте файл main.yml в каталоге tasks:

nano dependent_role/tasks/main.yml

Добавьте следующее содержимое:

---
- name: Task from dependent role
  debug:
    msg: "This task is from the dependent role"

Теперь создадим плейбук (playbook) для использования нашей роли dependent_role. Вернемся в корневой каталог проекта:

cd ~/project
nano use_dependent_role.yml

Добавьте следующее содержимое:

---
- name: Use our dependent role
  hosts: localhost
  roles:
    - dependent_role

Наконец, запустим этот плейбук (playbook):

ansible-playbook -i inventory.ini use_dependent_role.yml

Вы должны увидеть, что выполняются как задачи из роли example_role, так и из роли dependent_role. Это демонстрирует, как зависимости ролей позволяют создавать более сложную автоматизацию, комбинируя более простые роли.

Итоги

В этом практическом занятии вы узнали о ролях Ansible (Ansible Roles) — мощной функции для организации и структурирования вашего кода Ansible. Вот основные выводы:

1. Роли Ansible (Ansible Roles) предоставляют способ автоматически загружать связанные переменные (vars), файлы, задачи (tasks), обработчики (handlers) и другие артефакты Ansible на основе известной структуры файлов.
2. Базовая структура роли включает в себя каталоги для задач (tasks), обработчиков (handlers), переменных по умолчанию (defaults), других переменных (vars), файлов (files), шаблонов (templates) и мета-информации (meta).
3. Роли позволяют устанавливать переменные по умолчанию, которые можно переопределить при использовании роли, обеспечивая гибкость и повторное использование.
4. Вы можете использовать шаблоны (templates) в рамках ролей для создания файлов с динамическим содержимым.
5. Роли можно легко включать в плейбуки (playbooks), что позволяет применять сложные конфигурации одной строкой кода.
6. Вы можете переопределить переменные роли в своих плейбуках (playbooks), что позволяет настраивать поведение ролей без изменения самой роли.
7. Роли могут зависеть от других ролей, что позволяет создавать более сложную автоматизацию, комбинируя более простые роли.

Роли Ansible (Ansible Roles) — это фундаментальное понятие для написания поддерживаемого и повторно используемого кода Ansible. Они позволяют разбить сложные задачи автоматизации на более мелкие и управляемые части и способствуют повторному использованию кода в вашей организации. По мере продолжения работы с Ansible вы обнаружите, что роли становятся неотъемлемым инструментом в вашем арсенале автоматизации, особенно для более крупных и сложных проектов.