Использование переменных

Определение простых переменных

Вы можете определить простую переменную, используя стандартный синтаксис YAML. Например:

remote_install_path: /opt/my_app_config

Обращение к простым переменным

После определения переменной используйте синтаксис Jinja2 для обращения к ней. Переменные Jinja2 используют двойные фигурные скобки. Например, выражение My amp goes to {{ max_amp_value }} демонстрирует наиболее базовый вид подстановки переменных. Вы можете использовать синтаксис Jinja2 в плейбуках. Например:

ansible.builtin.template:
  src: foo.cfg.j2
  dest: '{{ remote_install_path }}/foo.cfg'

В этом примере переменная определяет расположение файла, которое может отличаться на разных системах.

Определение переменных как списков

Вы можете определять переменные с несколькими значениями, используя списки YAML. Например:

region:
  - northeast
  - southeast
  - midwest

Обращение к переменным-спискам

Когда вы используете переменные, определенные как списки (также называемые массивами), вы можете использовать отдельные, конкретные элементы из этого списка. Первый элемент в списке — элемент 0, второй — элемент 1. Например:

region: "{{ region[0] }}"

Значение этого выражения будет «северо-восток».

Определение переменных как словарей ключ:значение

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

foo:
  field1: one
  field2: two

Обращение к переменным словаря ключ:значение

Когда вы используете переменные, определённые как словарь ключ:значение (также называемый хешем), вы можете использовать отдельные, конкретные поля из этого словаря, используя либо квадратные скобки, либо точку:

foo['field1']
foo.field1

Оба этих примера ссылаются на то же значение («один»). Квадратные скобки всегда работают. Использование точки может вызвать проблемы, поскольку некоторые ключи сталкиваются с атрибутами и методами словарей Python. Используйте квадратные скобки, если вы используете ключи, которые начинаются и заканчиваются двумя подчёркиваниями (которые зарезервированы для специальных значений в Python) или являются любыми из известных публичных атрибутов:

add, append, as_integer_ratio, bit_length, capitalize, center, clear, conjugate, copy, count, decode, denominator, difference, difference_update, discard, encode, endswith, expandtabs, extend, find, format, fromhex, fromkeys, get, has_key, hex, imag, index, insert, intersection, intersection_update, isalnum, isalpha, isdecimal, isdigit, isdisjoint, is_integer, islower, isnumeric, isspace, issubset, issuperset, istitle, isupper, items, iteritems, iterkeys, itervalues, join, keys, ljust, lower, lstrip, numerator, partition, pop, popitem, real, remove, replace, reverse, rfind, rindex, rjust, rpartition, rsplit, rstrip, setdefault, sort, split, splitlines, startswith, strip, swapcase, symmetric_difference, symmetric_difference_update, title, translate, union, update, upper, values, viewitems, viewkeys, viewvalues, zfill.

Объединение переменных-списков

Вы можете использовать модуль set_fact для объединения списков в новую merged_list переменную следующим образом:

vars:
  list1:
  - apple
  - banana
  - fig

  list2:
  - peach
  - plum
  - pear

tasks:
- name: Combine list1 and list2 into a merged_list var
  ansible.builtin.set_fact:
    merged_list: "{{ list1 + list2 }}"

Объединение переменных-словарей

Для слияния словарей используйте фильтр combine, например:

vars:
  dict1:
    name: Leeroy Jenkins
    age: 25
    occupation: Astronaut

  dict2:
    location: Galway
    country: Ireland
    postcode: H71 1234

tasks:
- name: Combine dict1 and dict2 into a merged_dict var
  ansible.builtin.set_fact:
    merged_dict: "{{ dict1 | ansible.builtin.combine(dict2) }}"

Подробнее см. ansible.builtin.combine .

Использование lookup merge_variables

Для слияния переменных, соответствующих заданным префиксам, суффиксам или регулярным выражениям, можно использовать lookup community.general.merge_variables, например:

merged_variable: "{{ lookup('community.general.merge_variables', '__my_pattern', pattern_type='suffix') }}"

Дополнительные сведения и примеры использования см. в документации lookup community.general.merge_variables.

Определение переменных в инвентаре

Вы можете определять разные переменные для каждого хоста индивидуально или задавать общие переменные для группы хостов в инвентаре. Например, если все машины в группе [Boston] используют ‘boston.ntp.example.com’ в качестве NTP-сервера, вы можете задать групповую переменную. На странице Как создать инвентарь подробно описано, как задавать переменные хоста и групповые переменные в инвентаре.

Определение переменных в плейбуке

Вы можете определить переменные непосредственно в плейбуке:

- hosts: webservers
  vars:
    http_port: 80

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

Определение переменных в включённых файлах и ролях

Вы можете определять переменные в переиспользуемых файлах переменных и/или в переиспользуемых ролях. Когда вы определяете переменные в переиспользуемых файлах переменных, конфиденциальные переменные отделяются от плейбуков. Это разделение позволяет хранить плейбуки в системе управления версиями и даже делиться ими, не рискуя раскрыть пароли или другую конфиденциальную и личную информацию. Сведения о создании переиспользуемых файлов и ролей см. в разделе Использование артефактов Ansible.

В этом примере показано, как включить переменные, определённые во внешнем файле:

---

- hosts: all
  remote_user: root
  vars:
    favcolor: blue
  vars_files:
    - /vars/external_vars.yml

  tasks:

  - name: This is just a placeholder
    ansible.builtin.command: /bin/echo foo

Содержание каждого файла переменных — это простой словарь YAML. Например:

---
# in the above example, this would be vars/external_vars.yml
somevar: somevalue
password: magic

Определение переменных во время выполнения

Вы можете определять переменные при запуске плейбука, передавая переменные в командной строке с помощью аргумента --extra-vars (или -e). Вы также можете запросить ввод пользователя с помощью vars_prompt (см. Интерактивный ввод: подсказки). При передаче переменных в командной строке используйте строку в одинарных кавычках, содержащую одну или несколько переменных, в одном из следующих форматов.

ansible-playbook release.yml --extra-vars "version=1.23.45 other_variable=foo"

ansible-playbook release.yml --extra-vars '{"version":"1.23.45","other_variable":"foo"}'
ansible-playbook arcade.yml --extra-vars '{"pacman":"mrs","ghosts":["inky","pinky","clyde","sue"]}'

ansible-playbook arcade.yml --extra-vars "{\"name\":\"Conan O\'Brien\"}"
ansible-playbook arcade.yml --extra-vars '{"name":"Conan O'\\\''Brien"}'
ansible-playbook script.yml --extra-vars "{\"dialog\":\"He said \\\"I just can\'t get enough of those single and double-quotes"\!"\\\"\"}"

ansible-playbook release.yml --extra-vars "@some_file.json"
ansible-playbook release.yml --extra-vars "@some_file.yaml"

Понимание приоритета переменных

Ansible применяет приоритет переменных, и вы можете его использовать. Вот порядок приоритетов от наименьшего к наибольшему (переменные, указанные последними, переопределяют все другие переменные):

1. значения командной строки (например, -u my_user, это не переменные)
2. значения по умолчанию для ролей (как определено в Структура каталога ролей) [1]
3. переменные из файла инвентаризации или группы скриптов [2]
4. переменные группы инвентаризации group_vars/all [3]
5. переменные группы playbook group_vars/all [3]
6. переменные группы инвентаризации group_vars/* [3]
7. переменные группы playbook group_vars/* [3]
8. переменные из файла инвентаризации или группы скриптов для хостов [2]
9. переменные хоста инвентаризации host_vars/* [3]
10. переменные хоста playbook host_vars/* [3]
11. факты хоста / кэшированные set_facts [4]
12. переменные плейбука
13. переменные плейбука vars_prompt
14. переменные плейбука vars_files
15. переменные роли (как определено в Структура каталога ролей)
16. переменные блока (только для задач в блоке)
17. переменные задачи (только для задачи)
18. include_vars
19. set_facts / зарегистрированные переменные
20. параметры роли (и include_role)
21. параметры include
22. дополнительные переменные (например, -e "user=my_user") (всегда имеют приоритет)

В общем случае Ansible отдаёт приоритет переменным, которые были определены более поздно, активнее и с более явным областью действия. Переменные в папке defaults внутри роли легко переопределяются. Всё, что находится в каталоге vars роли, переопределяет предыдущие версии этой переменной в пространстве имён. Переменные хоста и/или инвентаризации переопределяют значения по умолчанию роли, но явные включения, такие как каталог vars или задача include_vars, переопределяют переменные инвентаризации.

Ansible объединяет разные переменные, установленные в инвентаризации, так, что более конкретные настройки переопределяют более общие. Например, ansible_ssh_user заданная как group_var, переопределяется ansible_user заданной как host_var. Подробнее о приоритете переменных, заданных в инвентаризации, см. Как объединяются переменные.

Примечания

Ограничение переменных

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

• Глобальная: устанавливается конфигурацией, переменными среды и командной строкой
• Пьеса: каждая пьеса и содержащиеся структуры, записи vars (vars; vars_files; vars_prompt), значения по умолчанию роли и vars.
• Хост: переменные, напрямую связанные с хостом, такие как инвентаризация, include_vars, факты или выходы зарегистрированных задач

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

Рекомендации по тому, где задавать переменные

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

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

Задавайте общие значения по умолчанию в файле group_vars/all. Подробнее о том, как организовать переменные хоста и группы в вашем инвентаре, см. Организация переменных хоста и группы. Переменные группы обычно размещаются рядом с файлом инвентаря, но они также могут возвращаться динамическим инвентарем (см. Работа с динамическим инвентарем) или определяться в AWX или на платформе Red Hat Ansible Automation Platform через интерфейс или API:

---
# file: /etc/ansible/group_vars/all
# this is the site wide default
ntp_server: default-time.example.com

Задавайте переменные, зависящие от местоположения, в файлах group_vars/my_location. Все группы являются дочерними по отношению к группе all, поэтому переменные, заданные здесь, переопределяют переменные, заданные в group_vars/all.

---
# file: /etc/ansible/group_vars/boston
ntp_server: boston-time.example.com

Если один хост использует другой сервер NTP, вы можете задать это в файле host_vars, что переопределит переменную группы:

---
# file: /etc/ansible/host_vars/xyz.boston.example.com
ntp_server: override.example.com

Задавайте значения по умолчанию в ролях, чтобы избежать ошибок undefined-variable. Если вы используете свои роли, другие пользователи могут полагаться на разумные значения по умолчанию, которые вы добавили в файл roles/x/defaults/main.yml, или они могут легко переопределить эти значения в инвентаре или в командной строке. Дополнительную информацию см. в Роли. Например:

---
# file: roles/x/defaults/main.yml
# if no other value is supplied in inventory or as a parameter, this value will be used
http_port: 80

Устанавливайте переменные в ролях, чтобы значение использовалось в этой роли и не переопределялось переменными инвентаризации. Если вы не будете делиться своей ролью с другими, вы можете определить специфичные для приложения параметры, такие как порты, таким образом, в roles/x/vars/main.yml. Если вы делитесь ролями с другими, размещение переменных здесь затрудняет их переопределение, хотя это всё ещё возможно, передав параметр роли или установив переменную с помощью -e:

---
# file: roles/x/vars/main.yml
# this will absolutely be used in this role
http_port: 80

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

roles:
   - role: apache
     vars:
        http_port: 8080

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

roles:
   - role: app_user
     vars:
        myname: Ian
   - role: app_user
     vars:
       myname: Terry
   - role: app_user
     vars:
       myname: Graham
   - role: app_user
     vars:
       myname: John

Переменные, установленные в одной роли, доступны последующим ролям. Вы можете установить переменные в каталоге роли vars (как определено в Структура каталога роли) и использовать их в других ролях и в других частях вашего плейбука:

roles:
   - role: common_settings
   - role: something
     vars:
       foo: 12
   - role: something_else

Вместо того, чтобы беспокоиться о приоритете переменных, мы рекомендуем вам подумать о том, насколько легко или часто вы хотите переопределить переменную, когда решаете, где её установить. Если вы не уверены, какие ещё переменные определены, и вам нужно конкретное значение, используйте --extra-vars (-e) для переопределения всех других переменных.