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

Устаревшие элементы

Хотя все перечисленные здесь элементы будут отображать сообщение об устаревании, они по-прежнему работают так же, как и в 1.9.x. Обратите внимание, что они будут удалены в версии 2.2 (Ansible всегда ждет два основных выпуска, чтобы удалить устаревшую функцию).

• Необработанные переменные в циклах with_ должны использовать синтаксис "{{ var }}", что помогает устранить неоднозначность.
• Требования к файлу формата ansible-galaxy. Пользователи должны использовать формат YAML для требований.
• Неопределенные переменные внутри списка цикла with_ в настоящее время не прерывают цикл, но выдают предупреждение; в будущем они будут выдавать ошибку.
• Использование переменных словарей для установки всех параметров задачи небезопасно и будет удалено в будущей версии. Пример устаревшего варианта:

- hosts: localhost
  gather_facts: no
  vars:
    debug_params:
      msg: "hello there"
  tasks:
    - debug: "{{debug_params}}"
    - debug:
      args: "{{debug_params}}"

Пример рекомендуемого варианта:

- hosts: localhost
  gather_facts: no
  vars:
    debug_params:
      msg: "hello there"
  tasks:
    - debug:
      msg: "{{debug_params['msg']}}"

• Шаблоны хостов должны использовать запятую (,) или двоеточие (:) вместо точки с запятой (;), чтобы разделить хосты/группы в шаблоне.
• Диапазоны, указанные в шаблонах хостов, должны использовать синтаксис [x:y], а не [x-y].
• Playbooks, использующие повышение привилегий, должны всегда использовать опции «become*» вместо устаревших опций su*/sudo*.

• «Короткий» вариант для vars_prompt больше не поддерживается. Например:

  vars_prompt:
      variable_name: "Prompt string"
  

• Указание переменных на верхнем уровне заявления о включении задачи больше не поддерживается. Например:

  - include_tasks: foo.yml
      a: 1
  

Теперь должно быть:

- include_tasks: foo.yml
  vars:
    a: 1

• Установка any_errors_fatal в задаче больше не поддерживается. Это должно быть установлено только на уровне playbook.
• Необработанные переменные в словаре environment (для playbooks/задач и т. д.) больше не поддерживаются. Переменные, указанные там, должны использовать полный синтаксис переменной: ‘{{foo}}’.

• Теги (или любые директивы) больше не должны указываться вместе с другими параметрами во включении задачи. Вместо этого они должны быть указаны как параметр задачи. Например:

  - include_tasks: foo.yml tags=a,b,c
  

  Должно быть:

  - include_tasks: foo.yml
    tags: [a, b, c]
  

• Параметр first_available_file для задач устарел. Пользователи должны использовать опцию with_first_found или плагин поиска (‘first_found’, …).

Другие особенности

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

• Неправильное составление переменных:

  with_items: myvar_{{rest_of_name}}
  

  Это работало «случайно», так как ошибки были перешаблонированы и переменная в итоге разрешалась, но это никогда не предполагалось как допустимый синтаксис, и теперь возвращает ошибку. Используйте следующее вместо этого:

  hostvars[inventory_hostname]['myvar_' + rest_of_name]
  

• Неправильно написанные директивы:

  - task: dostuf
    becom: yes
  

  Задача всегда выполнялась без использования повышения привилегий (для этого нужен become), но также молча игнорировалась, поэтому playbook «работал», хотя этого не должно было происходить. Сейчас это ошибка парсинга.

• Повторные директивы:

  - task: dostuf
    when: True
    when: False
  

  Первая when была проигнорирована, и использовалась только вторая, так как playbook выполнялся без предупреждения об игнорировании одной из директив. Сейчас это ошибка парсинга.

• Смешивание переменных и директив:

  - role: {name=rosy, port=435 }
  
  # in tasks/main.yml
  - wait_for: port={{port}}
  

  Переменная port зарезервирована как директива playbook/задачи для переопределения порта соединения. В предыдущих версиях она смешивалась с переменной с именем port и была доступна позже в playbook, что создавало проблемы, если хост пытался переподключиться или использовал соединение без кэширования. Сейчас она будет правильно идентифицирована как директива, и переменная port будет отображаться как неопределенная. Это заставляет использовать неконфликтные имена и устраняет неоднозначность при добавлении настроек и переменных в вызов роли.

• Необработанные операции над with_:

  with_items: var1 + var2
  

  Проблема с функциями «необработанных переменных», которые должны были шаблонизировать только одну переменную без фигурных скобок ({{)}), в некоторых версиях Ansible шаблонизировали полные выражения. Теперь вам нужно использовать правильное шаблонирование и фигурные скобки для всех выражений, кроме условных операторов (when) :

  with_items: "{{var1 + var2}}"
  

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

Плагины поиска

• плагины поиска ; импорт версии

Плагины подключения

• плагины подключения

Плагины действий

• плагины действий

Плагины обратного вызова

Хотя Ansible 2.0 предоставляет новый API обратного вызова, старый продолжает работать для большинства плагинов обратного вызова. Однако, если ваш плагин обратного вызова использует self.playbook, self.play или self.task, то вам нужно будет хранить значения для этих параметров самостоятельно, так как Ansible больше не автоматически заполняет плагин обратного вызова ими. Вот короткий фрагмент, который показывает, как это сделать:

import os
from ansible.plugins.callback import CallbackBase

class CallbackModule(CallbackBase):
    def __init__(self):
        self.playbook = None
        self.playbook_name = None
        self.play = None
        self.task = None

    def v2_playbook_on_start(self, playbook):
        self.playbook = playbook
        self.playbook_name = os.path.basename(self.playbook._file_name)

    def v2_playbook_on_play_start(self, play):
        self.play = play

    def v2_playbook_on_task_start(self, task, is_conditional):
        self.task = task

    def v2_on_any(self, *args, **kwargs):
        self._display.display('%s: %s: %s' % (self.playbook_name,
        self.play.name, self.task))

Плагины подключения

• плагины подключения

Плагины поиска

В качестве простого примера мы создадим гибридный fileglob плагин поиска.

from __future__ import (absolute_import, division, print_function)
__metaclass__ = type

import os
import glob

try:
    # ansible-2.0
    from ansible.plugins.lookup import LookupBase
except ImportError:
    # ansible-1.9.x

    class LookupBase(object):
        def __init__(self, basedir=None, runner=None, **kwargs):
            self.runner = runner
            self.basedir = self.runner.basedir

        def get_basedir(self, variables):
            return self.basedir

try:
    # ansible-1.9.x
    from ansible.utils import (listify_lookup_plugin_terms, path_dwim, warning)
except ImportError:
    # ansible-2.0
    from ansible.utils.display import Display
    warning = Display().warning

class LookupModule(LookupBase):

    # For ansible-1.9.x, we added inject=None as valid argument
    def run(self, terms, inject=None, variables=None, **kwargs):

        # ansible-2.0, but we made this work for ansible-1.9.x too !
        basedir = self.get_basedir(variables)

        # ansible-1.9.x
        if 'listify_lookup_plugin_terms' in globals():
            terms = listify_lookup_plugin_terms(terms, basedir, inject)

        ret = []
        for term in terms:
            term_file = os.path.basename(term)

            # For ansible-1.9.x, we imported path_dwim() from ansible.utils
            if 'path_dwim' in globals():
                # ansible-1.9.x
                dwimmed_path = path_dwim(basedir, os.path.dirname(term))
            else:
                # ansible-2.0
                dwimmed_path = self._loader.path_dwim_relative(basedir, 'files', os.path.dirname(term))

            globbed = glob.glob(os.path.join(dwimmed_path, term_file))
            ret.extend(g for g in globbed if os.path.isfile(g))

        return ret

Плагины подключения

• плагины подключения

Плагины действий

• плагины действий

Плагины обратного вызова

• плагины обратного вызова

Плагины подключения

• плагины подключения