这是Ansible系列课程第六节,Ansible如何进行调试?。介绍一下如何在执行过程中打印日志,如何增加断言,或者使用调试器。
该系列课程前后章节都是有关联性的,对于初学者建议按顺序阅读。也可以选择特定的章节了解单个知识点。
上一节介绍了Inventory文件的语法格式,了解了如何高效管理远程主机。今天介绍一个代码编写的基本技能:调试,方便的调试技巧可以让我们更清晰的了解代码的执行逻辑,在出现问题时快速定位,高效解决。这个Ansible系列课程中如果有些playbook不方便采用真实案例,大多数都会采用输出调试信息的方式进行讲解,这也是后续课程的基础。
debug模块
debug模块是Ansible Playbook中最常用的调试模块,可以在Playbook执行过程打印调试信息,特别是跟when条件语句一起使用时,可以调试特定条件下的执行过程。比如:当变量a定义时,将a的值打印出来,当任务成功后,打印执行结果等等
该模块有三个参数,分别是:
msg:指定要打印的信息,如果没有指定,打印默认值“hello world”。
var:指定要打印的变量名,与msg参数互斥,二者只能有一个。注意:var参数中的变量不需要使用{{}}表达式,而msg中需要。
verbosity:控制哪种调试级别下输出,值为Integer。如果设为3,则只有在-vvv或更高调试级别下才会输出。
下面举几个列子:
---
- hosts: devops
tasks:
- name: show debug msg
debug:
msg: System {{inventory_hostname}} has uuid {{ansible_product_uuid}}
- name: print gateway when it is defined
debug:
msg: System {{inventory_hostname}} has gateway {{ansible_default_ipv4.gateway}}
when: ansible_default_ipv4.gateway is defined
- name: show uptime
shell: /usr/bin/uptime
register: result
- name: show uptime result
debug:
var: result
verbosity: 2
- name: display all vars of a host
debug:
var: hostvars[inventory_hostname]
verbosity: 3
- name: print two lines of messages
debug:
msg:
- "first line msg"
- "second line msg"
执行结果如下,因为在执行时使用的-v参数,调试级别不够,有2个任务skipped了。
assert模块
assert模块是用来断言playbook中给定的表达式。当表达式成功或失败时输出一些信息,帮助进行调试。assert模块可用作单元测试,每次修改playbook后,都通过assert断言判断有没有改变执行结果。
assert模块有四个参数,分别是:
fail_msg:当断言失败时输出的消息。
success_msg:当断言成功时输出的消息。
quite:当为yes时,如果成功就不输出任何消息,为no时,断言成功会输出消息。
that:需要判断的表达式列表。
下面举几个例子:
---
- hosts: devops
vars:
command_result: 'the result is success'
number_of_the_count: 5
param: 90
tasks:
- name: assert param scope
assert:
that:
- param <= 100
- param >= 0
fail_msg: "'param' must be between 0 and 100"
success_msg: "'param' is between 0 and 100"
- name: use quiet to avoid verbose output
assert:
that:
- param <= 100
- param >= 0
quiet: yes
- name: print origin fail msg
assert:
that:
- "'success' in command_result"
- number_of_the_count == 4
执行结果如下:
fail模块
fail模块是让当前所执行的任务失败,并输出信息。等与when一起使用时,可以在特定条件下让任务失败,以调试程序。比如:当status与期望值不符时,任务失败并输出变量的值。
fail模块只有一个参数:
msg:当任务失败时,输出特定的消息。如果没有指定,输出默认消息“Failed as requested from task”。
下面举个例子:
---
- hosts: devops
vars:
number_of_the_count: 5
tasks:
- name: use fail module with when
fail:
when: number_of_the_count == 5
- name: use fail module
fail:
msg: 'this is a debug msg'
执行结果:
--start-at-task参数
有时候在开发阶段调试新增的palybook或task,其中有个任务经常失败,需要不停的重试。如果在这个任务之前还有很多其他成功的任务,如果每次都从头执行,那么每次都需要执行那些已经成功的任务,效率就很低,这时可以通过--start-at-task参数指定这个特定的任务。
$ansible-playbookassert.yml--start-at-task="print origin fail msg"
执行结果:
--step参数
--step参数与--start-at-task参数不同,--start-at-task参数是从某个特定的任务开始,而--step是以交互的模式一步一步的执行。以上面debug.yml为例:
$ansible-playbookdebug.yml--step
执行结果,可以看出,每步任务的执行都需要输入三个选项中的一个:N(跳过)Y(执行)C(继续执行后面所有步骤)
总结
这一小节主要介绍了几个在playbook执行过程中方便调试的模块或参数。编写playbook就跟写代码一样,不可能没有bug,不可能不出问题,我们需要做的就是在遇到问题时能够快速的发现问题,解决问题。Ansible的这几个功能虽然对调试有很大帮助,但在使用上也有一些问题,比如debug、assert和fail这几个模块,需要每次都执行完任务才能看到结果,从输出信息中判断任务执行情况。--start-at-task能够提供执行易错任务的效率,--step参数可以分步执行任务,但他们不能在task任务执行过程中进行调试。下一节我们就介绍一下ansible强大的调试器debugger的使用。