[ansible series] fundamentals 02 module debug

1. Official module commissioning

ansible There are detailed debugging methods in the documentation of the developer's Guide , May refer to
Portal

2. Custom module debugging

Premise ： The custom module will not go until there is a problem debug Customize the contents of the module , That is, the program is stuck in the custom module

Debugging steps

step1 View error details
The main purpose of viewing error details is to see playbook Temporary files generated during operation

ansible-playbook -i inventory all.yml -vvv
# The default host information is in inventory in 
# Default playbook be known as all.yml

Example

# Temporary file path of the module during operation 
/root/.ansible/tmp/ansible-tmp-1614847639.99-2480-188457856158931/AnsiballZ_dataformat.py

step2 Processing files in temporary directory

Set the environment variable ANSIBLE_KEEP_REMOTE_FILES=1
The role of this environment variable ：Ansible The remote module file will be preserved , Instead of deleting a module after its execution

export ANSIBLE_KEEP_REMOTE_FILES=1

To the temporary directory of the execution host

cd /root/.ansible/tmp/ansible-tmp-1614847639.99-2480-188457856158931/

There will be a... In the directory structure AnsiballZ_dataformat.py file

To run the wrapper explode command , Convert a string to something you can use Python file

python AnsiballZ_dataformat.py explode

stay AnsiballZ_dataformat.py The same level directory will generate debug_dir Catalog

• debug_dir/ansible/modules There are corresponding modules in the directory python Code , In the illustrated example is ping.py
• debug_dir/args The file contains a JSON character string . The string is a dictionary , contain Ansible Module parameters and other variables passed to a module to change its behavior . Modify this file to change the parameters passed to the module .

step3 debug Handle
It can be modified by modules The file corresponding to the module in the directory , Then execute the following statement under the temporary directory

python AnsiballZ_dataformat.py execute

tips： The common operation is to use in the module script file pdb Conduct debug, Step by step, find out the problem , If you run the above statement again, you will enter pdb Hit the breakpoint
pdb Commissioning the transfer gate

---

Stay Hungry,Stay Foolish！