Отладка задач

Включение отладчика с помощью ключевого слова debugger

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

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

- 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

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

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

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

- hosts: test
  strategy: debug
  tasks:
    - name: Example task
      debug:
        msg: "This is a debug message"

Или в 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"}

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

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

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

При запуске плейбука недопустимое имя пакета вызывает ошибку, и 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, чтобы повторно запустить задачу с новыми аргументами.

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

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

[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 пересоздает задачу из исходной структуры данных задачи и шаблонов с обновленными переменными задачи. Пример использования см. в разделе Команда обновления vars.

Команда повторного выполнения

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

Команда продолжения

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

Команда выхода

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