Задачи отладки

Включение отладчика с ключевым словом debugger

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

При использовании ключевого слова debugger, указанное вами значение переопределяет любые глобальные настройки для включения или выключения отладчика. Если вы определяете debugger на нескольких уровнях, например, в роли и в задаче, Ansible использует наиболее точное определение. Определение на уровне плей или роли применяется ко всем блокам и задачам в рамках этого плей или роли, если не указано иное значение. Определение на уровне блока переопределяет определение на уровне плей или роли и применяется ко всем задачам в рамках этого блока, если не указано иное значение. Определение на уровне задачи всегда применяется к задаче; оно переопределяет определения на уровне блока, плей или роли.

- name: Execute a command
  ansible.builtin.command: "false"
  debugger: on_failed

- name: My play
  hosts: all
  debugger: on_skipped
  tasks:
    - name: Execute a command
      ansible.builtin.command: "true"
      when: False

- name: Play
  hosts: all
  debugger: never
  tasks:
    - name: Execute a command
      ansible.builtin.command: "false"
      debugger: on_failed

Включение отладчика в конфигурации или переменной среды

Вы можете включить отладчик задач глобально с настройкой в ansible.cfg или с переменной среды. Доступны только варианты True или False. Если вы установите параметр конфигурации или переменную среды на True, Ansible по умолчанию запускает отладчик на задачах, завершившихся ошибкой.

Для включения отладчика задач из ansible.cfg, добавьте эту настройку в раздел [defaults].

[defaults]
enable_task_debugger = True

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

ANSIBLE_ENABLE_TASK_DEBUGGER=True ansible-playbook -i hosts site.yml

Когда вы включаете отладчик глобально, каждый завершившийся ошибкой задача вызывает отладчик, если роль, плей, блок или задача явно не отключают отладчик. Если вам нужен более точный контроль над тем, какие условия вызывают отладчик, используйте ключевое слово debugger.

Включение отладчика как стратегии

Если вы работаете со старыми плейбуками или ролями, вы можете увидеть, что отладчик включён как стратегия. Вы можете сделать это на уровне плей, в ansible.cfg, или с помощью переменной среды ANSIBLE_STRATEGY=debug. Например:

- hosts: test
  strategy: debug
  tasks:
  ...

Или в ansible.cfg:

[defaults]
strategy = debug

Команда print

print *task/task.args/task_vars/host/result* выводит информацию о задаче.

[192.0.2.10] TASK: install package (debug)> p task
TASK: install package
[192.0.2.10] TASK: install package (debug)> p task.args
{u'name': u'{{ pkg_name }}'}
[192.0.2.10] TASK: install package (debug)> p task_vars
{u'ansible_all_ipv4_addresses': [u'192.0.2.10'],
 u'ansible_architecture': u'x86_64',
 ...
}
[192.0.2.10] TASK: install package (debug)> p task_vars['pkg_name']
u'bash'
[192.0.2.10] TASK: install package (debug)> p host
192.0.2.10
[192.0.2.10] TASK: install package (debug)> p result._result
{'_ansible_no_log': False,
 'changed': False,
 u'failed': True,
 ...
 u'msg': u"No package matching 'not_exist' is available"}

Команда обновления аргументов

task.args[*key*] = *value* обновляет аргумент модуля. В этом примере playbook содержит неверное имя пакета.

- hosts: test
  strategy: debug
  gather_facts: true
  vars:
    pkg_name: not_exist
  tasks:
    - name: Install a package
      ansible.builtin.apt: name={{ pkg_name }}

При запуске playbook неверное имя пакета приводит к ошибке, и Ansible запускает отладчик. Вы можете исправить имя пакета, просмотрев и затем обновив аргумент модуля.

[192.0.2.10] TASK: install package (debug)> p task.args
{u'name': u'{{ pkg_name }}'}
[192.0.2.10] TASK: install package (debug)> task.args['name'] = 'bash'
[192.0.2.10] TASK: install package (debug)> p task.args
{u'name': 'bash'}
[192.0.2.10] TASK: install package (debug)> redo

После обновления аргумента модуля используйте redo для повторного выполнения задачи с новыми аргументами.

Команда обновления переменных

task_vars[*key*] = *value* обновляет task_vars. Вы могли бы исправить playbook выше, просмотрев и обновив переменные задачи вместо аргументов модуля.

[192.0.2.10] TASK: install package (debug)> p task_vars['pkg_name']
u'not_exist'
[192.0.2.10] TASK: install package (debug)> task_vars['pkg_name'] = 'bash'
[192.0.2.10] TASK: install package (debug)> p task_vars['pkg_name']
'bash'
[192.0.2.10] TASK: install package (debug)> update_task
[192.0.2.10] TASK: install package (debug)> redo

После обновления переменных задачи необходимо использовать update_task для загрузки новых переменных перед использованием redo для повторного выполнения задачи.

Команда обновления задачи

u или update_task пересоздаёт задачу из исходной структуры данных и шаблонов задачи с обновлёнными переменными задачи. См. запись Команда обновления переменных для примера использования.

Команда redo

r или redo выполняет задачу снова.

Команда continue

c или continue продолжает выполнение, начиная со следующей задачи.

Команда quit

q или quit закрывает отладчик. Выполнение playbook прерывается.