Planetahost VPS
Перейти к основному контенту

Ansible #4: Переменные и шаблоны Jinja2

intro-Ansible-4-Jinja2-Variables-and-Templates-planetahost.png

Подробности урока
Уровень сложности Лёгкий
Права root Требуются
Требования Терминал Linux
Категория Установка ПО
Совместимость с ОС Debian, Ubuntu
Примерное время чтения  35 мин

Введение

В предыдущей статье мы создали первые Playbook и рассмотрели задачи, модули и обработчики. Теперь разберём переменные и шаблоны Jinja2. Переменные позволяют использовать один Playbook для серверов с разными настройками. Например, можно указать разные порты, имена сервисов или пути к файлам.

Jinja2 используется для подстановки переменных в конфигурационные файлы и другие данные.

В этой статье рассмотрим:

  • переменные;

  • переменные из Inventory;

  • факты Ansible;

  • условные конструкции;

  • шаблоны Jinja2;

  • создание конфигурационных файлов с помощью template.

Переменные

Создадим простой Playbook:

---
- name: Работа с переменными
  hosts: db

  vars:
    package_name: htop

  tasks:
    - name: Установка пакета
      ansible.builtin.apt:
        name: "{{ package_name }}"
        state: present

Переменная задаётся в секции:

vars:
  package_name: htop

Использовать переменную можно через конструкцию:

{{ package_name }}

В результате Ansible подставит вместо {{ package_name }} значение htop.

Переменные в Inventory

Переменные можно задавать непосредственно в Inventory.

Например:

[web]
web1 ansible_host=192.168.88.10 http_port=8080
web2 ansible_host=192.168.88.11 http_port=9999

изображение.png

Теперь у каждого сервера своё значение http_port.

Переменную можно использовать в Playbook:

---
- name: Настройка веб-серверов
  hosts: web

  tasks:
    - name: Вывод порта
      ansible.builtin.debug:
        msg: "Порт сервера: {{ http_port }}"

Для web1 будет использовано значение 8080, а для web2 - 9999.

изображение.png

Для большого количества переменных лучше использовать group_vars и host_vars, которые мы рассмотрели во второй статье.

Переменные group_vars

Например, для группы web создадим:

group_vars/web.yml

Содержимое:

---
http_port: 80
server_name: planetahost.ru

Теперь эти переменные доступны всем серверам группы web.

Playbook:

---
- name: Настройка веб-сервера
  hosts: web

  tasks:
    - name: Вывод настроек
      ansible.builtin.debug:
        msg: "Сервер {{ server_name }} использует порт {{ http_port }}"

изображение.png

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

Факты Ansible

При запуске Playbook Ansible по умолчанию собирает информацию об управляемом сервере. Эта информация называется facts.

Например:

  • имя сервера;

  • операционная система;

  • версия ОС;

  • IP-адреса;

  • объём оперативной памяти;

  • количество процессоров;

  • сетевые интерфейсы.

Посмотреть факты можно с помощью:

---
- name: Получение информации о сервере
  hosts: db

  tasks:
    - name: Показать факты
      ansible.builtin.debug:
        var: ansible_facts

изображение.png

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

Например, получить имя сервера:

---
- name: Информация о сервере
  hosts: db

  tasks:
    - name: Показать имя
      ansible.builtin.debug:
        var: ansible_facts.hostname

Получить информацию об операционной системе:

- name: Показать ОС
  ansible.builtin.debug:
    var: ansible_facts.distribution

Получить версию ОС:

- name: Показать версию ОС
  ansible.builtin.debug:
    var: ansible_facts.distribution_version

изображение.png

Использование фактов

Факты можно использовать непосредственно в Playbook.

Например:

---
- name: Информация о серверах
  hosts: db

  tasks:
    - name: Вывод информации
      ansible.builtin.debug:
        msg: "Сервер {{ ansible_facts.hostname }} работает под управлением {{ ansible_facts.distribution }} {{ ansible_facts.distribution_version }}"

Ansible подставит реальные значения каждого сервера.

Например:

изображение.png

Условия

Условия позволяют выполнять задачу только при выполнении определённого условия. Для этого используется when.

Например, установим htop только на сервер с ОС Debian:

---
- name: Установка htop
  hosts: db

  tasks:
    - name: Установка htop на Debian
      ansible.builtin.apt:
        name: htop
        state: present
      when: ansible_facts.distribution == "Debian"

Условие:

when: ansible_facts.distribution == "Debian"

означает, что задача будет выполнена только на Debian.

Если условие не выполняется, Ansible пропустит задачу.

изображение.png

Несколько условий

Можно использовать несколько условий:

when:
  - ansible_facts.distribution == "Debian"
  - ansible_facts.distribution_major_version == "13"

В этом случае оба условия должны выполняться.

Можно использовать логические операторы:

when: ansible_facts.distribution == "Debian" or ansible_facts.distribution == "Ubuntu"

Шаблоны Jinja2

Jinja2 используется для подстановки переменных в текстовые файлы.

Например:

Привет, {{ server_name }}!

Если переменная содержит:

server_name: server1

результат будет:

Привет, server1!

Для Ansible особенно полезны шаблоны конфигурационных файлов.

Обычно они имеют расширение:

.j2

Создание шаблона

Создадим каталог:

mkdir -p templates

Создадим файл:

nano templates/example.conf.j2

Добавим:

server_name={{ server_name }}
http_port={{ http_port }}

Теперь создадим Playbook:

---
- name: Создание конфигурации
  hosts: web

  tasks:
    - name: Копирование конфигурации
      ansible.builtin.template:
        src: templates/example.conf.j2
        dest: /opt/example.conf
        mode: '0644'

изображение.png

Модуль template возьмёт файл example.conf.j2, обработает переменные и создаст готовый файл на сервере.

Если переменные имеют значения:

server_name: planetahost.ru
http_port: 80

на сервере появится:

изображение.png

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

Шаблон с фактами

В шаблоне можно использовать не только собственные переменные, но и факты Ansible.

Например:

nano templates/server-info.conf.j2
hostname={{ ansible_facts.hostname }}
os={{ ansible_facts.distribution }}
version={{ ansible_facts.distribution_version }}

Playbook:

---
- name: Создание информации о сервере
  hosts: db

  tasks:
    - name: Создание файла
      ansible.builtin.template:
        src: templates/server-info.conf.j2
        dest: /opt/server-info.conf
        mode: '0644'

В результате каждый сервер получит собственный файл с информацией о системе.

изображение.png

Условия в шаблонах

Jinja2 позволяет использовать условия непосредственно внутри шаблона.

Например:

{% if http_port == 443 %}
HTTPS включён
{% else %}
Используется обычный HTTP
{% endif %}

Если http_port равен 443, будет создано:

HTTPS включён

В противном случае:

Используется обычный HTTP

Циклы в шаблонах

Jinja2 также поддерживает циклы. Например, создадим переменную:

vars:
  packages:
    - htop
    - curl
    - vim

В шаблоне:

{% for package in packages %}
package={{ package }}
{% endfor %}

Результат:

package=htop
package=curl
package=vim

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

Практический пример

Создадим простой шаблон конфигурации веб-сервера.

Файл:

nano templates/web.conf.j2
server {
    listen {{ http_port }};
    server_name {{ server_name }};

    root {{ document_root }};
}

В group_vars/web.yml:

---
http_port: 80
server_name: example.com
document_root: /var/www/html

изображение.png

Playbook:

---
- name: Настройка веб-сервера
  hosts: web

  tasks:
    - name: Создание конфигурации
      ansible.builtin.template:
        src: templates/web.conf.j2
        dest: /etc/web.conf
        mode: '0644'

Ansible подставит значения переменных и создаст на сервере готовую конфигурацию.

изображение.png

Если изменить значение:

http_port: 8080

и снова запустить Playbook, конфигурация автоматически изменится.

Проверка Playbook

Запуск Playbook:

ansible-playbook -i inventory four.yml

Перед запуском можно проверить синтаксис:

ansible-playbook -i inventory four.yml --syntax-check

Посмотреть, какие серверы будут использоваться:

ansible-playbook -i inventory four.yml --list-hosts

Для предварительной проверки изменений:

ansible-playbook -i inventory four.yml --check

Заключение

Переменные позволяют использовать один Playbook для серверов с разными настройками. Факты Ansible предоставляют информацию о системе и позволяют использовать её в задачах и шаблонах. Jinja2 позволяет подставлять переменные, использовать условия и циклы при создании конфигурационных файлов.

В следующей статье разберём управление файлами и службами в Ansible: copy, template, file, service и systemd.

Полезные ссылки