Руководство по переносу Ansible 2.8

Сведения о дистрибутиве

Информация, возвращаемая для группы фактов ansible_distribution_*, может незначительно измениться. Ansible 2.8 использует новую библиотеку бэкенда для получения сведений о дистрибутивах: nir0s/distro. Эта библиотека работает на Python-3.8 и исправляет множество багов, включая исправление названий релизов и версий.

Два наиболее часто используемых факта в плейбуках, ansible_distribution и ansible_distribution_major_version, не должны изменяться. Если вы обнаружите изменения в этих фактах, пожалуйста, отправьте отчет об ошибке, чтобы мы могли разобраться с различием. Однако другие факты, такие как ansible_distribution_release и ansible_distribution_version, могут измениться по мере исправления неверной информации.

Импорты как обработчики

Начиная с версии 2.8, задача не может оповещать import_tasks или статический include, указанный в handlers.

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

Для достижения результата оповещения одного имени, но выполнения нескольких обработчиков, используйте include_tasks, или listen Обработчики: выполнение операций при изменении.

Неопределённые значения Jinja

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

В Ansible 2.8:

{{ foo.bar.baz | default('DEFAULT') }}

В Ansible 2.7 и более ранних версиях:

{{ ((foo | default({})).bar | default({})).baz | default('DEFAULT') }}

или:

{{ foo.bar.baz if (foo is defined and foo.bar is defined and foo.bar.baz is defined) else 'DEFAULT' }}

Преобразование параметра модуля в строку

Начиная с версии 2.8, Ansible будет предупреждать, если модуль ожидает строку, но передаётся значение, не являющееся строкой, и автоматически преобразуется в строку. Это выявляет потенциальные проблемы, где, например, yes или true (разбираемые как истинное булево значение) будут преобразованы в строку 'True', или где номер версии 1.10 (разбираемый как число с плавающей точкой) будет преобразован в '1.1'. Такие преобразования могут привести к неожиданному поведению в зависимости от контекста.

Это поведение можно изменить, чтобы это было ошибкой или игнорировалось, установив переменную среды ANSIBLE_STRING_CONVERSION_ACTION, или параметр конфигурации string_conversion_action в разделе defaults ansible.cfg.

ФАКТЫ командной строки

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

Одиночные переменные в условных операторах

В Ansible 2.7 и ранее переменные верхнего уровня иногда обрабатывали строковые значения булевых переменных как булевы значения. Это приводило к несогласованному поведению в условных тестах, построенных на переменных верхнего уровня, определённых как строки. Ansible 2.8 начал изменять это поведение. Например, если вы установите два условия, как это:

tasks:
  - include_tasks: teardown.yml
    when: teardown

  - include_tasks: provision.yml
    when: not teardown

на основе переменной, которую вы определяете как строку (с кавычками вокруг неё):

• В Ansible 2.7 и ранее вышеуказанные два условия оценивались как True и False соответственно, если teardown: 'true'.
• В Ansible 2.7 и ранее оба условия оценивались как False если teardown: 'false'.
• В Ansible 2.8 и более поздних версиях у вас есть возможность отключить одиночные переменные в условных операторах, таким образом when: teardown всегда оценивается как True и when: not teardown всегда оценивается как False когда teardown является непустой строкой (включая 'true' или 'false')

В конечном итоге when: 'string' всегда будет оцениваться как True и when: not 'string' всегда будет оцениваться как False, пока 'string' не пуста, даже если значение 'string' само по себе похоже на булевое. Для пользователей с плейбуками, которые зависят от старого поведения, мы добавили настройку конфигурации, которая сохраняет его. Вы можете использовать переменную среды ANSIBLE_CONDITIONAL_BARE_VARS или conditional_bare_variables в разделе defaults ansible.cfg для выбора нужного поведения на узле управления. По умолчанию установлено значение true, которое сохраняет старое поведение. Установите значение конфигурации или переменной среды на false для использования нового варианта.

vars:
  teardown: 'false'

tasks:
  - include_tasks: teardown.yml
    when: teardown | bool

  - include_tasks: provision.yml
    when: not teardown | bool

vars:
  teardown: false

tasks:
  - include_tasks: teardown.yml
    when: teardown

  - include_tasks: provision.yml
    when: not teardown

- debug:
  when: my_list | length > 0

- debug:
  when: my_dictionary | length > 0

vars:
  double_interpolated: 'bare_variable'
  bare_variable: false

tasks:
  - debug:
    when: double_interpolated

vars:
  double_interpolated: "{{ other_variable }}"
  other_variable: false

Сбор фактов

В Ansible 2.8 неявная задача «Сбор фактов» в плейбуке была изменена, чтобы подчиняться меткам плейбука. До версии 2.8 задача «Сбор фактов» игнорировала метки плейбука и метки, предоставленные через командную строку, и всегда выполнялась в задаче.

Изменение поведения затрагивает следующий пример плейбука.

- name: Configure Webservers
  hosts: webserver
  tags:
    - webserver
  tasks:
    - name: Install nginx
      package:
        name: nginx
      tags:
        - nginx

В Ansible 2.8, если вы передадите --tags nginx, неявная задача «Сбор фактов» будет пропущена, поскольку задача теперь наследует метку webserver вместо always.

Если метки уровня плейбука не заданы, задаче «Сбор фактов» будет присвоена метка always и она будет соответствовать предыдущему поведению.

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

- name: Configure Webservers
  hosts: webserver
  gather_facts: false
  tags:
    - webserver
  tasks:
    - name: Gathering Facts
      gather_facts:
      tags:
        - always

    - name: Install nginx
      package:
        name: nginx
      tags:
        - nginx

Значение по умолчанию для повторной попытки создания файла

В Ansible 2.8, retry_files_enabled теперь по умолчанию False вместо True. Поведение может быть изменено на поведение предыдущей версии, отредактировав файл ansible.cfg по умолчанию и установив значение на True.

Запрос пароля для повышения привилегий

Начиная с версии 2.8, Ansible по умолчанию будет использовать слово BECOME для запроса пароля для повышения привилегий (sudo привилегии на системах Unix или enable режим на сетевых устройствах):

По умолчанию в Ansible 2.8:

ansible-playbook --become --ask-become-pass site.yml
BECOME password:

Если вы хотите, чтобы запрос отображал конкретный become_method , который вы используете, вместо общего значения BECOME, установите AGNOSTIC_BECOME_PROMPT в значение False в вашей конфигурации Ansible.

По умолчанию в Ansible 2.7, или с AGNOSTIC_BECOME_PROMPT=False в Ansible 2.8:

ansible-playbook --become --ask-become-pass site.yml
SUDO password:

Удаленные модули

Следующие модули больше не существуют:

• ec2_remote_facts
• azure
• cs_nic
• netscaler
• win_msi

Уведомления о устаревании

Следующие модули будут удалены в Ansible 2.12. Пожалуйста, обновите свои плейбуки соответственно.

• foreman используйте foreman-ansible-modules вместо этого.
• katello используйте foreman-ansible-modules вместо этого.
• github_hooks используйте github_webhook и github_webhook_facts вместо этого.
• digital_ocean используйте digital_ocean_droplet вместо этого.
• gce используйте gcp_compute_instance вместо этого.
• gcspanner используйте gcp_spanner_instance и gcp_spanner_database вместо этого.
• gcdns_record используйте gcp_dns_resource_record_set вместо этого.
• gcdns_zone используйте gcp_dns_managed_zone вместо этого.
• gcp_forwarding_rule используйте gcp_compute_global_forwarding_rule или gcp_compute_forwarding_rule вместо этого.
• gcp_healthcheck используйте gcp_compute_health_check, gcp_compute_http_health_check или gcp_compute_https_health_check вместо этого.
• gcp_backend_service используйте gcp_compute_backend_service вместо этого.
• gcp_target_proxy используйте gcp_compute_target_http_proxy вместо этого.
• gcp_url_map используйте gcp_compute_url_map вместо этого.
• panos используйте роль Palo Alto Networks Ansible Galaxy вместо этого.

Важные изменения модулей

• Модули foreman и katello устарели и заменены на набор модулей, разбитых по сущностям для лучшей идемпотентности.
• Замена модулей foreman и katello официально входит в состав Foreman Community и поддерживается там.
• Модуль tower_credential первоначально требовал, чтобы ssh_key_data был путем к файлу ssh_key_file. Для работы аналогично AWX/Tower/RHAAP, ssh_key_data теперь содержит содержимое файла. Предыдущее поведение можно получить с помощью lookup('file', '/path/to/file').
• Модуль win_scheduled_task отказался от поддержки указания повторения триггера как списка и этот формат будет удален в Ansible 2.12. Вместо этого укажите повторение как значение словаря.
• Модуль win_feature удалил устаревший результат restart_needed. Используйте вместо него стандартное значение reboot_required.
• Модуль win_package удалил устаревшие значения возврата restart_required и exit_code. Используйте вместо них стандартные значения reboot_required и rc.
• Модуль win_get_url удалил устаревший словарь возврата win_get_url, значения возвращаются напрямую.
• Модуль win_get_url удалил устаревший параметр skip_certificate_validation. Используйте вместо него стандартный параметр validate_certs.
• Модуль vmware_local_role_facts теперь возвращает список словарей вместо словаря словарей для информации о роли.
• Если docker_network или docker_volume вызывались с diff: yes, check_mode: yes или debug: yes, возвращалось значение diff типа list. Для обеспечения правильного вывода diff это было изменено на тип dict; исходное значение list возвращается как diff.differences.
• Модуль na_ontap_cluster_peer заменил строковые параметры source_intercluster_lif и dest_intercluster_lif на списковые параметры source_intercluster_lifs и dest_intercluster_lifs
• Модуль modprobe теперь обнаруживает встроенные ядра. Ранее попытка удалить (с помощью state: absent) встроенный модуль ядра заканчивалась без сообщения об ошибке, потому что modprobe не распознавал модуль как present. Теперь modprobe завершится неудачно, если модуль ядра встроен и state: absent (с сообщением об ошибке из модуля modprobe, например, modprobe: ERROR: Module nfs is builtin.). В противном случае он завершится без сообщения о изменениях, если state: present. Любые playbook, которые используют changed_when: no для маскировки этого поведения, могут безопасно удалить обходной путь. Чтобы получить предыдущее поведение при применении state: absent к встроенному модулю ядра, используйте failed_when: false или ignore_errors: true в вашем playbook.
• Модуль digital_ocean устарел в пользу модулей, не требующих внешних зависимостей. Это позволяет повысить гибкость и улучшить поддержку модулей.
• Модуль docker_container устарел для возвращаемого факта docker_container. Это же значение доступно в виде переменной container. Возвращаемый факт будет удален в Ansible 2.12.
• Модуль docker_network устарел для возвращаемого факта docker_container. Это же значение доступно в виде переменной network. Возвращаемый факт будет удален в Ansible 2.12.
• Модуль docker_volume устарел для возвращаемого факта docker_container. Это же значение доступно в виде переменной volume. Возвращаемый факт будет удален в Ansible 2.12.
• Модуль docker_service был переименован в docker_compose.
• Переименованный модуль docker_compose возвращал один факт на службу, имя которой совпадало с именем службы. Словарь этих фактов возвращается в качестве обычного значения возврата services. Возвращаемые факты будут удалены в Ansible 2.12.

• The docker_swarm_service module no longer sets a defaults for the following options:

  • user. Раньше значением по умолчанию было root.
  • update_delay. Раньше значением по умолчанию было 10.
  • update_parallelism. Раньше значением по умолчанию было 1.

• vmware_vm_facts ранее возвращал словарь словарей с фактами виртуальной машины. Ansible 2.8 и выше будут возвращать список словарей с фактами виртуальной машины. Пожалуйста, обратитесь к документации модуля vmware_vm_facts для примера.
• vmware_guest_snapshot модуль ранее возвращал results. Начиная с Ansible 2.8 и выше, results — зарезервированное ключевое слово, поэтому он заменён на snapshot_results. Обратитесь к документации модуля vmware_guest_snapshots для примера.
• Модули panos устарели в пользу использования ролей Palo Alto Networks из Ansible Galaxy. Взносы в роль можно вносить здесь.
• Модуль ipa_user изначально всегда отправлял password в FreeIPA независимо от того, изменился ли пароль. Теперь модуль отправляет password только если update_password установлено в always, что является значением по умолчанию.
• В модуле win_psexec устарел не документированный параметр extra_opts модуля. Он будет удален в Ansible 2.10.
• Модуль win_nssm устарел для следующих параметров в пользу использования модуля win_service для настройки службы после её установки с помощью win_nssm: * dependencies, используйте dependencies из win_service * start_mode, используйте start_mode из win_service * user, используйте username из win_service * password, используйте password из win_service Эти параметры будут удалены в Ansible 2.12.
• Модуль win_nssm также устарел для значений start, stop, и restart параметра status. Используйте модуль win_service для управления состоянием службы. Этот параметр будет удален в Ansible 2.12.
• Параметр модуля status для win_nssm изменил значение по умолчанию на present. Ранее значение по умолчанию было start. Вследствие этого, служба больше не запускается по умолчанию после создания с помощью win_nssm, и вы должны использовать модуль win_service для запуска, если это необходимо.
• Параметр модуля app_parameters для win_nssm устарел; используйте argument вместо него. Он будет удален в Ansible 2.12.
• Параметр модуля app_parameters_free_form для win_nssm стал псевдонимом нового параметра arguments.
• Модуль win_dsc теперь проверяет входные параметры для ресурса DSC. В предыдущих версиях недопустимые параметры игнорировались, но теперь нет.
• Модуль openssl_pkcs12 теперь перегенерирует файл pkcs12, если есть различия между файлом на диске и параметрами, переданными модулю.

Класс Display

Начиная с Ansible 2.8, класс Display теперь является «синглтоном». Вместо использования __main__.display каждый файл должен импортировать и инициализировать ansible.utils.display.Display самостоятельно.

СТАРЫЙ В Ansible 2.7 (и ранее) для доступа к объекту display использовалось следующее:

try:
    from __main__ import display
except ImportError:
    from ansible.utils.display import Display
    display = Display()

НОВЫЙ В Ansible 2.8 следует использовать следующее:

from ansible.utils.display import Display
display = Display()