Как устроены шаблоны (templates) в Ansible?

24.01.2023

Ansible

Комментариев нет

Шаблоны в Ansible — это мощный инструмент для динамического создания файлов конфигураций и других текстовых документов на основе переменных и данных, полученных во время выполнения плейбуков. Ansible использует шаблонизатор Jinja2 для создания этих шаблонов, что позволяет внедрять переменные, использовать циклы, условные операторы и другие конструкции в шаблонах.

Основные аспекты работы с шаблонами в Ansible

Формат шаблонов:
- Шаблоны в Ansible создаются с использованием синтаксиса Jinja2 и обычно имеют расширение .j2.
- Файлы шаблонов содержат статический текст (например, стандартный конфиг), а также динамические элементы, такие как переменные, циклы и условия.
Использование модуля template:
- В Ansible модуль template используется для применения шаблонов. Он берет .j2 файл, обрабатывает его с учетом переменных и копирует на удаленный хост с уже подставленными значениями.

Пример структуры шаблона Jinja2

# my_config.conf.j2
server {
    listen {{ port }};
    server_name {{ server_name }};

    location / {
        root {{ document_root }};
        index index.html index.htm;
    }

    {% if use_ssl %}
    ssl_certificate /etc/ssl/certs/{{ server_name }}.crt;
    ssl_certificate_key /etc/ssl/private/{{ server_name }}.key;
    {% endif %}
}

# my_config.conf.j2

server {

listen {{ port }};

server_name {{ server_name }};

location / {

root {{ document_root }};

index index.html index.htm;

}

{% if use_ssl %}

ssl_certificate /etc/ssl/certs/{{ server_name }}.crt;

ssl_certificate_key /etc/ssl/private/{{ server_name }}.key;

{% endif %}

}

В этом примере используются переменные port, server_name, document_root, и условие use_ssl для динамической генерации конфигурационного файла.

Пример использования шаблона в Ansible плейбуке

- name: Deploy NGINX configuration
  hosts: webservers
  become: true
  vars:
    port: 80
    server_name: example.com
    document_root: /var/www/html
    use_ssl: false

  tasks:
    - name: Deploy NGINX configuration file from template
      template:
        src: templates/my_config.conf.j2
        dest: /etc/nginx/conf.d/my_config.conf
      notify:
        - Restart NGINX

- name: Deploy NGINX configuration

hosts: webservers

become: true

vars:

port: 80

server_name: example.com

document_root: /var/www/html

use_ssl: false

tasks:

- name: Deploy NGINX configuration file from template

template:

src: templates/my_config.conf.j2

dest: /etc/nginx/conf.d/my_config.conf

notify:

- Restart NGINX

В этом плейбуке:

src — указывает путь к локальному файлу шаблона.
dest — путь на удаленном хосте, куда будет скопирован обработанный шаблон.

Возможности Jinja2 в шаблонах

Вставка переменных: Используется синтаксис {{ variable }} для подстановки значений переменных.

Shell

Welcome, {{ user_name }}!

1
2

Welcome, {{ user_name }}!
Условные выражения: Используются для добавления условий.

INI

{% if use_ssl %} SSL is enabled. {% else %} SSL is not enabled. {% endif %}

1
2
3
4
5
6

{% if use_ssl %}
SSL is enabled.
{% else %}
SSL is not enabled.
{% endif %}
Циклы: Позволяют итерироваться по спискам и словарям.

INI

{% for user in users %} User: {{ user.name }}, Email: {{ user.email }} {% endfor %}

1
2
3
4

{% for user in users %}
User: {{ user.name }}, Email: {{ user.email }}
{% endfor %}
Фильтры: Модифицируют данные, например, upper для преобразования текста в верхний регистр.

INI

{{ "hello" | upper }}

1
2

{{ "hello" | upper }}
Шаблонные макросы и функции: Для создания переиспользуемых блоков кода внутри шаблона.

Пример сложного шаблона

# inventory.j2
{% for host in groups['webservers'] %}
Host {{ host }}
  HostName {{ hostvars[host]['ansible_host'] }}
  User {{ hostvars[host]['ansible_user'] }}
  {% if hostvars[host]['ansible_port'] is defined %}
  Port {{ hostvars[host]['ansible_port'] }}
  {% endif %}
{% endfor %}

# inventory.j2

{% for host in groups['webservers'] %}

Host {{ host }}

HostName {{ hostvars[host]['ansible_host'] }}

User {{ hostvars[host]['ansible_user'] }}

{% if hostvars[host]['ansible_port'] is defined %}

Port {{ hostvars[host]['ansible_port'] }}

{% endif %}

{% endfor %}

Этот шаблон динамически генерирует файл конфигурации на основе инвентаря Ansible, итерируясь по группе webservers.

Использование Ansible Variables в шаблонах

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

Примеры часто используемых сценариев

Настройка конфигурационных файлов: Использование шаблонов для создания конфигураций сервисов (например, NGINX, Apache, Docker).
Создание скриптов и автоматизация задач: Динамическое создание скриптов, которые затем выполняются на удаленных хостах.
Шаблоны писем и отчетов: Использование шаблонов для создания отчетов с результатами выполнения задач.

Преимущества использования шаблонов

Гибкость и адаптивность: Позволяют создавать конфигурации, которые подстраиваются под данные, полученные от Ansible или пользователей.
Удобство сопровождения: Шаблоны позволяют легко вносить изменения в конфигурации и распространять их на все управляемые хосты.
Повышение автоматизации: Упрощают автоматическое создание файлов конфигураций и документов.

Шаблоны в Ansible — это мощный инструмент для автоматизации и динамического создания файлов, который значительно упрощает управление конфигурациями на множестве удаленных серверов.