这是Ansible系列课程第四节,小试牛刀,执行第一个Playbook:介绍什么是Playbook以及体验一下它的强大功能。
该系列课程前后章节都是有关联性的,对于初学者建议按顺序阅读。也可以选择特定的章节了解单个知识点。
上一节我们介绍了Ad-hoc命令以及演示了几个Ad-hoc命令的实例,可以说,已经初步了解了Ansible是如何执行单个任务的。通过命令行执行单个任务满足了工作中的一部分简单的场景。但在实际工作中,所涉及的场景可能是复杂的大型项目,这个时候单个的Ad-hoc命令就满足不了要求了,就需要使用Ansible Playbook。下面介绍一下什么是Ansible Playbook以及将上一节的例子通过Playbook形式执行。
什么是Playbook
Playbook是一组采用YAML语法格式编写的、用于远程执行的有序命令的集合。
Playbook与Ad-hoc是执行Ansbile的两种完全不同的方式,前者强大,后者简单。Playbook之所以强大,是因为它是Ansible配置、部署、编排的语言。既然是一种语言,就包含了语法结构、逻辑处理、条件判断等,再加以模块和插件进行扩展,使得Playbook具有很强的业务处理能力。
Playbook是由一个或多个“play”组成,每个“play”又由一个或多个“task”组成,task就是具体执行的任务。打个比方,可以把task比作音符,play就是一首歌曲,playbook就是演唱会的剧本,通过playbook编排出精彩酷炫的演唱会。同样,ansible通过playbook编排出复杂的、自动化的部署任务。
Playbook示例讲解
下面是一个示例是关于安装并检查apache是否安装并启动的playbook,采用YAML语法编写,对YAML语法不熟悉的请自行补习。
---
- hosts: devops
vars:
http_port: 80
remote_user: root
tasks:
- name: ensure apache is at the latest version
yum:
pkg: httpd
state: latest
- name: write the apache config file
template:
src: ./template/httpd.conf.j2
dest: /etc/httpd/conf/httpd.conf
- name: ensure apache is running
service:
name: httpd
state: started
该示例只包含了一个play,如果要包含多个play,按如下结构编写,一个play用于webserver主机组中httpd的安装,一个是用于dbserver主机组中postgresql的安装。plays的执行顺序和tasks一样,都是从上到下顺序执行。
---
- hosts: webserver
remote_user: root
tasks:
- name: ensure apache is at the latest version
yum:
pkg: httpd
state: latest
- hosts: dbserver
remote_user: root
tasks:
- name: ensure postgresql is at the latest version
yum:
name: postgresql
state: latest
对于playbook中的每个play都是关于where、who、what和how的事情:
where:在哪些主机组上
who:由哪个用户执行
what:执行哪些任务
how:如何执行这些任务,循环、同步、异步等
下面拆解一个单独的play中包含哪几个主要部分:
hosts:指定任务执行的位置,包含一个或多个主机组或者特定模式的主机组,这些都是需要从inventory文件中获取,即便是直接写IP,但该IP没包含在inventory中也是不可以的。关于inventory会在下一节介绍。
remote_user:指定执行任务的用户。在这个位置指定用户表示该play包含的所有任务都通过该用户执行,也可以在单个task中指定。对于没有权限的用户可以使用become升级为sudo权限执行(前提是该用户必须是一个sudoer)。
vars:指定该play任务中包含的变量。关于变量也会在后面章节介绍。
tasks:指定该play执行的任务清单,执行的顺序按从上到下的顺序,每次都是在所有主机组上执行完一个任务再执行下一个任务。每个任务都是执行一个具有非常具体的参数的模块,上面的vars可以用做模块的参数。这里的模块应该是幂等的,也就是说,连续多次运行一个模块应该与只运行一次的结果相同。模块是幂等的,task也就是幂等的,整个play很可能也就是幂等。
name:指定每个具体任务的名称,会在脚本运行过程中输出。在Ansible最佳实践中要求,每个任务的名称都要写上,这样可以在执行过程中知道哪个任务是干什么的。
yum:执行该任务所执行的具体的模块,在Ansible中类似这样的模块大概有3000多个,能够满足工作中的几乎所有的场景,如果满足不了,开发人员还可以开发自己的模块。
name和state:指定yum模块具体的参数,每个模块都包含许多不同的参数,根据参数值的不同执行的结果不一样。比如state:present是创建,state:absent是删除。
这些只是组成一个play或者playbook的基本要素,playbook中包含的元素远不止这些。在涉及到一个具体的模块不知道都有哪些参数时,可以执行ansible-doc modulename查看。
$ ansible-docyum
执行Playbook
了解了Playbook编写的语法,可通过下面命令执行playbook:
$ansible-playbookcheck-apache.yml
ansible-playbook这个命令行工具还有很多其他的参数,可以通过ansible-playbook -h查看帮助文档,结果如下所示:
[root@controll-node ~]# ansible-playbook -h
usage: ansible-playbook [-h] [--version] [-v] [-k]
[--private-key PRIVATE_KEY_FILE] [-u REMOTE_USER]
[-c CONNECTION] [-T TIMEOUT]
[--ssh-common-args SSH_COMMON_ARGS]
[--sftp-extra-args SFTP_EXTRA_ARGS]
[--scp-extra-args SCP_EXTRA_ARGS]
[--ssh-extra-args SSH_EXTRA_ARGS] [--force-handlers]
[--flush-cache] [-b] [--become-method BECOME_METHOD]
[--become-user BECOME_USER] [-K] [-t TAGS]
[--skip-tags SKIP_TAGS] [-C] [--syntax-check] [-D]
[-i INVENTORY] [--list-hosts] [-l SUBSET]
[-e EXTRA_VARS] [--vault-id VAULT_IDS]
[--ask-vault-pass |--vault-password-fileVAULT_PASSWORD_FILES]
[-f FORKS] [-M MODULE_PATH] [--list-tasks]
[--list-tags] [--step] [--start-at-task START_AT_TASK]
playbook [playbook ...]
Runs Ansible playbooks, executing the defined tasks on the targeted hosts.
positional arguments:
playbook Playbook(s)
......
下面再介绍几个重要的选项:
-v:输出调试日志,需要更详细的日志,可以使用-vv,-vvv,或-vvvv等。
-u:指定连接的远程用户。
--become:改变执行任务的用户,值为yes或no。
--become-user:指定执行任务的用户,默认为root。
--ask-become-pass:指定改变后的用户的密码。
--become-method:指定通过什么方式变为该用户,默认为sudo。
-i:指定inventory文件,可以是多个。
-f:指定并行执行的任务数,默认是5个。
--syntax-check:检查playbook的语法是否正确,但不执行。
--step:一步一步的执行playbook,在执行之前需要确认。
-h:这也是最应该记住的选项,其他都没记住,只要记住这个就能知道其他的了。
这几个是平时用的比较多点,先熟悉一下,其他选项可以自行查看帮助文档。
示例演示
下面我们编写一个playbook,需要执行的任务是:
在远程主机上创建一个文件,内容为“this is a playbook”,并将该文件从远程主机拷贝到控制主机上,然后在控制主机上获取该文件的内容。
这个稍微复杂的场景如果要用Ad-hoc命令是一个很繁琐的事情,playbook脚本的内容如下:
---
- hosts: devops
vars:
file_name: playbook
tasks:
- name: create file with content
copy:
content: this is a playbook
dest: /mnt/{{file_name}}.txt
- name: copy file from remote to local
fetch:
src: /mnt/{{file_name}}.txt
dest: /mnt/
- hosts: localhost
vars:
file_name: playbook
tasks:
- name: get the file content with var
debug:
msg: "{{ lookup('file', \"/mnt/{{item}}/mnt/{{file_name}}.txt\") }}"
with_items:
- "{{groups['devops']}}"
该Playbook包含两个play,第一个play是在devops主机组上创建一个文件,然后将该文件拷贝到本地,第二个play是读取拷贝到本地的文件内容,所用的模块有:copy、fetch和debug。下面执行一下这个playbook。
总结
这一节主要介绍了什么是Playbook,Playbook由哪些主要元素组成,以及如何执行playbook和相关的主要参数,最后通过一个具体的示例演示了一个包含多个play的playbook。虽然与大型复杂的场景相比,该示例仍然很小,但也展示出了Ansible playbook的强大之处。在后面的章节里,我们也主要以介绍Playbook为主。