Debugging Ansible.
authorOleksandr Gavenko <gavenkoa@gmail.com>
Thu, 14 Nov 2019 00:37:01 +0200
changeset 2389 6548a372f31f
parent 2388 4339ed4bd568
child 2390 f2b450fa4f4b
Debugging Ansible.
ansible.rst
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/ansible.rst	Thu Nov 14 00:37:01 2019 +0200
@@ -0,0 +1,49 @@
+
+=========
+ Ansible
+=========
+.. contents::
+   :local:
+
+Debugging Ansible
+=================
+
+Pass ``-vvv`` to Ansible utilities::
+
+  ansible -vvv ...
+  ansible-playbook -vvv ...
+
+To debug connection use ``-vvvv``::
+
+  ansible -vvvv ...
+
+To debug Python modules set ``ANSIBLE_KEEP_REMOTE_FILES`` to ``1`` (it causes Ansible to leave the
+exact copy of the Python scripts it executed on the target machine)::
+
+  ANSIBLE_KEEP_REMOTE_FILES=1  ansible ...
+
+There is ``debugger`` keyword that triggers debugger, see `Ansible Debugger
+<https://docs.ansible.com/ansible/latest/user_guide/playbooks_debugger.html>`_
+
+To activate debugger on task::
+
+  - name: Execute a command
+    command: false
+    debugger: on_failed
+
+To activate debugger in ``ansible.cfg``::
+
+  [defaults]
+  enable_task_debugger = True
+
+To activate debugger via env var::
+
+  ANSIBLE_ENABLE_TASK_DEBUGGER=True ansible-playbook -i hosts site.yml
+
+Use ``ansible-lint``::
+
+  $ sudo apt install ansible-lint
+  $ ansible-lint site.yml
+
+https://stackoverflow.com/questions/42417079/how-to-debug-ansible-issues
+  How to debug Ansible issues?