Обработка данных

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

Начнем с краткого определения каждого типа плагина:

lookups: В основном используются для запроса «внешних данных», в Ansible они были основной частью циклов, использующих конструкцию with_<lookup>, но их можно использовать независимо для возврата данных для обработки. Обычно они возвращают список из-за их основной функции в циклах, как упоминалось ранее. Используются с операторами Jinja2 lookup или query.
filters: используются для изменения/преобразования данных, используются с оператором Jinja2 |.
tests: используются для проверки данных, используются с оператором Jinja2 is.

Циклы и списковые включения

Большинство языков программирования имеют циклы (for, while, и так далее) и списковые включения для выполнения преобразований над списками, включая списки объектов. Jinja2 имеет несколько фильтров, которые обеспечивают эту функциональность: map, select, reject, selectattr, rejectattr.

map: это базовый цикл for, который просто позволяет изменить каждый элемент в списке, используя ключевое слово «attribute», вы можете выполнить преобразование, основанное на атрибутах элементов списка.
select/reject: это цикл for с условием, который позволяет создать подмножество списка, соответствующее (или не соответствующее) результату условия.
selectattr/rejectattr: очень похожи на предыдущие, но они используют определенный атрибут элементов списка для условного оператора.

Используйте цикл для создания экспоненциальной задержки.

- name: try wait_for_connection up to 10 times with exponential delay
  ansible.builtin.wait_for_connection:
    delay: '{{ item | int }}'
    timeout: 1
  loop: '{{ range(1, 11) | map("pow", 2) }}'
  loop_control:
    extended: true
  ignore_errors: "{{ not ansible_loop.last }}"
  register: result
  when: result is not defined or result is failed

Извлечение ключей из словаря, соответствующих элементам из списка

Эквивалентный код на Python будет:

chains = [1, 2]
for chain in chains:
    for config in chains_config[chain]['configs']:
        print(config['type'])

Существует несколько способов сделать это в Ansible, это всего лишь один пример:

Способ извлечения соответствующих ключей из списка словарей

 tasks:
   - name: Show extracted list of keys from a list of dictionaries
     ansible.builtin.debug:
       msg: "{{ chains | map('extract', chains_config) | map(attribute='configs') | flatten | map(attribute='type') | flatten }}"
     vars:
       chains: [1, 2]
       chains_config:
           1:
               foo: bar
               configs:
                   - type: routed
                     version: 0.1
                   - type: bridged
                     version: 0.2
           2:
               foo: baz
               configs:
                   - type: routed
                     version: 1.0
                   - type: bridged
                     version: 1.1

Результаты задачи debug, список с извлеченными ключами

   ok: [localhost] => {
       "msg": [
           "routed",
           "bridged",
           "routed",
           "bridged"
       ]
   }

Получение уникального списка значений переменной, которая изменяется в зависимости от хоста

   vars:
       unique_value_list: "{{ groups['all'] | map ('extract', hostvars, 'varname') | list | unique}}"

Поиск точки монтирования

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

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

  - hosts: all
    gather_facts: True
    vars:
       path: /var/lib/cache
    tasks:
    - name: The mount point for {{path}}, found using the Ansible mount facts, [-1] is the same as the 'last' filter
      ansible.builtin.debug:
       msg: "{{(ansible_facts.mounts | selectattr('mount', 'in', path) | list | sort(attribute='mount'))[-1]['mount']}}"

Исключение элементов из списка

Специальная omit переменная работает ТОЛЬКО с параметрами модуля, но мы все равно можем использовать ее другими способами в качестве идентификатора для настройки списка элементов:

Встроенная фильтрация списка при передаче параметра модуля

   - name: Enable a list of Windows features, by name
     ansible.builtin.set_fact:
       win_feature_list: "{{ namestuff | reject('equalto', omit) | list }}"
     vars:
       namestuff:
         - "{{ (fs_installed_smb_v1 | default(False)) | ternary(omit, 'FS-SMB1') }}"
         - "foo"
         - "bar"

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

Использование set_fact в цикле для условного увеличения списка

   - name: Build unique list with some items conditionally omitted
     ansible.builtin.set_fact:
        namestuff: ' {{ (namestuff | default([])) | union([item]) }}'
     when: item != omit
     loop:
         - "{{ (fs_installed_smb_v1 | default(False)) | ternary(omit, 'FS-SMB1') }}"
         - "foo"
         - "bar"

Объединение значений из одного списка словарей

Сочетание положительных и отрицательных фильтров из приведенных выше примеров позволяет получить «значение, когда оно существует», и «значение по умолчанию», когда его нет.

Использование selectattr и rejectattr для получения ansible_host или inventory_hostname по мере необходимости

   - hosts: localhost
     tasks:
       - name: Check hosts in inventory that respond to ssh port
         wait_for:
           host: "{{ item }}"
           port: 22
         loop: '{{ has_ah + no_ah }}'
         vars:
           has_ah: '{{ hostvars|dictsort|selectattr("1.ansible_host", "defined")|map(attribute="1.ansible_host")|list }}'
           no_ah: '{{ hostvars|dictsort|rejectattr("1.ansible_host", "defined")|map(attribute="0")|list }}'

Настройка Fileglob на основе переменной

В этом примере используется распаковка аргументов списка Python для создания настраиваемого списка fileglob на основе переменной.

Использование fileglob со списком на основе переменной.

  - hosts: all
    vars:
      mygroups:
        - prod
        - web
    tasks:
      - name: Copy a glob of files based on a list of groups
        copy:
          src: "{{ item }}"
          dest: "/tmp/{{ item }}"
        loop: '{{ q("fileglob", *globlist) }}'
        vars:
          globlist: '{{ mygroups | map("regex_replace", "^(.*)$", "files/\1/*.conf") | list }}'

Преобразования сложных типов

Jinja предоставляет фильтры для простых преобразований типов данных (int, bool, и так далее), но когда требуется преобразование структур данных, все не так просто. Вы можете использовать циклы и списковые включения, как показано выше, а также другие фильтры и поисковые запросы, которые могут быть объединены для достижения более сложных преобразований.

Создание словаря из списка

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

Эти примеры производят {"a": "b", "c": "d"}

Простой список в словарь, предполагая, что список — это [ключ, значение, ключ, значение, …]

 vars:
     single_list: [ 'a', 'b', 'c', 'd' ]
     mydict: "{{ dict(single_list[::2] | zip_longest(single_list[1::2])) }}"

Проще, когда у нас есть список пар:

 vars:
     list_of_pairs: [ ['a', 'b'], ['c', 'd'] ]
     mydict: "{{ dict(list_of_pairs) }}"

Оба результата одинаковы, с zip_longest преобразующим single_list в генератор list_of_pairs.

Немного сложнее, используя set_fact и loop для создания/обновления словаря с парами «ключ-значение» из двух списков:

Использование set_fact для создания словаря из набора списков

    - name: Uses 'combine' to update the dictionary and 'zip' to make pairs of both lists
      ansible.builtin.set_fact:
        mydict: "{{ mydict | default({}) | combine({item[0]: item[1]}) }}"
      loop: "{{ (keys | zip(values)) | list }}"
      vars:
        keys:
          - foo
          - var
          - bar
        values:
          - a
          - b
          - c

Это приводит к {"foo": "a", "var": "b", "bar": "c"}.

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

Использование «переменных» для определения словаря из набора списков без необходимости в задаче

   vars:
       xyz_stuff: 1234
       xyz_morestuff: 567
       myvarnames: "{{ q('varnames', '^xyz_') }}"
       mydict: "{{ dict(myvarnames|map('regex_replace', '^xyz_', '')|list | zip(q('vars', *myvarnames))) }}"

Краткое объяснение, поскольку из этих двух строк много информации:

Поисковый запрос varnames возвращает список переменных, которые начинаются с xyz_.
Затем список из предыдущего шага передается в поисковый запрос vars для получения списка значений. * используется для «дериференцирования списка» (python-прием, который работает в Jinja), в противном случае он бы принял список как единственный аргумент.
Оба списка передаются фильтру zip для объединения их в единый список (ключ, значение, ключ2, значение2, …).
Функция dict затем использует этот «список пар», чтобы создать словарь.

Пример использования фактов для поиска данных хоста, соответствующих условию X:

vars:
  uptime_of_host_most_recently_rebooted: "{{ansible_play_hosts_all | map('extract', hostvars, 'ansible_uptime_seconds') | sort | first}}"

Пример, демонстрирующий время работы хоста в днях/часах/минутах/секундах (предполагая, что данные фактов были собраны).

- name: Show the uptime in days/hours/minutes/seconds
  ansible.builtin.debug:
   msg: Uptime {{ now().replace(microsecond=0) - now().fromtimestamp(now(fmt='%s') | int - ansible_uptime_seconds) }}

См. также

Использование фильтров для обработки данных: Включенные в Ansible фильтры Jinja2
Тесты: Включенные в Ansible тесты Jinja2
Документация Jinja2: Документация Jinja2, включает списки основных фильтров и тестов

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/playbook_guide/complex_data_manipulation.html