天天看点

《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍

本节书摘来自华章出版社《ansible权威指南》一书中的第2章,第2.4节,作者 李松涛 魏 巍 甘 捷 更多章节内容可以访问云栖社区“华章计算机”公众号查看。

2.4 ansible系列命令用法详解与使用场景介绍

如何获取ansible的系列命令呢?在终端键入ansible后连续按两次tab键,会补全所有以ansible字母开头的命令,这些命令均是ansible系列命令。本节我们来逐一介绍ansible的系列命令使用。

ansible

ansible-galaxy

ansible-pull

ansible-doc

ansible-playbook

ansible-vault

ansible-console

2.4.1 ansible

命令ansible是日常工作中使用率非常高的命令之一,man中是如此定义其功能的:run a

command somewhere else,可见其灵活性。ansible命令主要在如下场景使用:

非固化需求

临时一次性操作

二次开发接口调用

那么什么是非固化需求和临时一次性操作呢?简单来讲,比如工作中我临时想查看web1服务器组是否存活,或我想临时复制本地的etcfstab到web服务器组的tmp目录下做测试,类如这些没有规律的、临时需要做的任务,我们称之为非固化需求、临时一次性操作。具体的命令使用如下:

 检查服务器存活

ansible web1 –m

ping

 复制本地文件到远程

copy –a src=etcfstab dest=tmpfstab owner=root group=root mode=644 backup=yes

ansible的返回结果都非常友好,一般会用3种颜色来表示执行结果:红色、绿色、橘黄色。其中红色表示执行过程有异常,一般会中止剩余所有的任务,如图2-2所示的ansible执行结果错误的结果返回;绿色和橘黄色表示执行过程没有异常,所有任务均正常执行,但橘黄色表示命令执行结束后目标有状态的变化。如图2-3所示,ansible执行结果正确的结果返回中的圆圈1为橘黄色显示;而绿色表示命令执行结束后目标没有状态变化,如图2-3中的圆圈2显示。

《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍
《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍

不仅ansible命令的执行结果如此设置,ansible系列命令均如此设置,所以判断ansible系列命令的执行结果是否正常是一件非常容易的事情,只要看颜色即可。

2.4.2 ansible-galaxy

这里的galaxy和三星手机没有任何关系。ansible-galaxy的功能可以简单地理解为github或pip的功能,通过ansible-galaxy命令,我们可以根据下载量和关注量等信息,查找和安装优秀的roles。roles是ansible非常重要的一项功能,关于roles的详细功能会在第6章介绍。在ansible-galaxy上,我们可以上传和下载roles,这里也是优秀roles的聚集地,下载地址为httpsgalaxy.ansible.com。

ansible-galaxy命令使用格式如下:

[initinfoinstalllistremove] [--help] [options] ...

ansible-galaxy命令分三大部分:

(1)[initinfoinstalllistremove]

init:初始化本地的roles配置,以备上传roles至galaxy。

info:列表指定role的详细信息。

install:下载并安装galaxy指定的roles到本地。

list:列出本地已下载的roles。

remove:删除本地已下载的roles。

ansible 2.0版本中,针对ansible-galaxy增加了login、import、delete、setup等功能,但这些功能需基于login在galaxy认证成功后方可执行,主要为了方便对galaxy上已有的roles的配置工作。

(2)help用法显示[--help]

针对第一部分的init、info等功能,其后跟--help可单独显示该项用法。例如:

init ––help

执行后会返回ansible-galaxy init选项的用法说明。

usage

ansible-galaxy init [options] role_name

options

    -f, --force           force overwriting an existing role

    -h, --help 

          show this help message

and exit

    -c, --ignore-certs    ignore ssl certificate validation errors.

    -p init_path, --init-path=init_path

                          the path in which the

skeleton role will be created.

                          the default is the

current working directory.

    --offline             don't query the galaxy api when

creating roles

    -s api_server, --server=api_server

                          the api server

destination

    -v, --verbose         verbose mode (-vvv for more, -vvvv to

enable

                          connection debugging)

    --version             show program's version number and

exit

其他选项与help用法一样。

(3)参数项[options]

该部分结合第一部分的参数完成ansible-galaxy完整的功能用法,如:

init [options] role_name即ansible-galaxy init后跟[-f-h-c-p--offline-s server-v--version]参数,后跟role-name成为一条完整的命令。

具体可参考如下:

 下载用户hectcastro的nginx这个role到本地并忽略错误(默认存放在etcansibleroles)

--ignore-errors install azavea.git

因为ansible-galaxy是对httpsgalaxy.ansible.com网站的上传、下载、配置类工作,如有类似如下报错,请确保该网站可正常访问。

the api server

(galaxy.ansible.com) is not responding, please try again later.

2.4.3 ansible-pull

该指令的使用涉及ansible的另一种工作模式:pull模式(ansible默认使用push模式)。这和通常使用的push模式工作机理刚好相反,其适用于以下场景:①你有数量巨大的机器需要配置,即使使用高并发线程依旧要花费很多时间;②你要在刚启动的、没有网络连接的主机上运行anisble。

ansible-pull命令使用格式如下:

[options] [playbook.yml]

通过ansible-pull结合git和crontab一并实现,其原理如下:通过crontab定期拉取指定的git版本到本地,并以指定模式自动运行预先制订好的指令。

具体示例参考如下:

20     root usrlocalbinansible-pull -o -c 2.1.0

-d srvwwwking-gw -i etcansiblehosts -u git

git.kingifa.comking-gw-ansiblepull 

varlogansible-pull.log 2&1

ansible-pull通常在配置大批量机器的场景下会使用,灵活性稍有欠缺,但效率几乎可以无限提升,对运维人员的技术水平和前瞻性规划有较高要求。

2.4.4 ansible-doc

ansible-doc是ansible模块文档说明,针对每个模块都有详细的用法说明及应用案例介绍,功能和linux系统man命令类似。该命令使用方式如下:

[options] [module...]

ansible-doc命令后跟[options]参数或[模块名],显示模块用法说明,具体示例如下:

 列出支持的模块

ansible-doc –l

 模块功能说明

ansible-doc ping

2.4.5 ansible-playbook

ansible-playbook是日常应用中使用频率最高的命令,其工作机制是:通过读取预先编写好的playbook文件实现批量管理。要实现的功能与命令ansible一样,可以理解为按一定条件组成的ansible任务集。

ansible-playbook命令后跟yml格式的playbook文件,执行事先编排好的任务集,命令使用方式如下:

playbook.yml

具体示例如下:

 执行gw.yml这个playbook中定义的所有任务集

gw.yml

playbook具有编写简单、可定制性高、灵活方便,以及可固化日常所有操作的特点,运维人员应熟练掌握。

2.4.6 ansible-vault

ansible-vault主要用于配置文件加密,如编写的playbook配置文件中包含敏感信息,不希望其他人随意查看,ansible-vault可加密解密这个配置文件,具体使用方式如下:

ansible-vault [createdecrypteditencryptrekeyview] [--help] [options] file_name

具体示例如下。

设定如下密码,加密a.yml文件。

ansible-vault   encrypt a.yml

会有以下输入加密密码提示:

vault password

confirm vault

password

encryption

successful

这时,再打开a.yml文件后会发现该文件乱码,只有通过如下命令解密后方可正常查看。

decrypt a.yml

输入预设的密码后方可解密。

decryption

此时a.yml文件可正常查看。

到此,我们对ansible的用法及系列命令已经有了概念性的了解和掌握,接下来我们进一步了解ansible inventory文件的配置管理。

2.4.7 ansible-console

ansible-console是ansible为用户提供的一款交互式工具,用户可以在ansible-console虚拟出来的终端上像shell一样使用ansible内置的各种命令,这为习惯于使用shell交互方式的用户提供了良好的使用体验。ansible-console主要是针对1.x版本中ansible-shell工具而研发的,目前官网还没有对ansible-console进行详细的用法说明,最新版本的ansible软件包也没有对应的man文档说明。经笔者实测,ansible-console命令的使用格式如下。

在终端键入ansible-console命令后,会进入如图2-4所示的类似shell一样的交互式终端环境。

《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍

图2-4中的“root@all

(4)[f5]$”是提示符,该提示符表示“当前的使用用户@当前所在的inventory中定义的组,默认是all分组(inventory中all组所有主机的数量)[forks线程数]$”。

使用cd命令可切换至指定hosts或分组,同时提示符的相应信息也会随之变动,如图2-5所示。

《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍

如图2-5中的ansible-console命令用法2所示,cd至webs分组后,原来的root@all (4)[f5]$也相应地变更为root@webs (3)[f5],表示当前分组为webs分组,该分组所拥有的主机总数为3台。执行forks 2后,提示符再次变更为root@webs (3)[f2]$,表示设置并发的线程数为2。

所有的操作与shell类似,而且支持tab键补全,如启动httpd服务时,键入service后连续按两次tab键后会自动补全剩余的命令选项。ansible-console命令用法3如图2-6所示。

《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍

如需启动httpd服务,使用命令service

name=httpd state=started,命令用法与ad-hoc一致,只是格式上的使用习惯不同而已。如想获取service模块更详细的用法,输入help service命令即可。ansible-console命令用法4如图2-7所示。

《Ansible权威指南》一2.4 Ansible系列命令用法详解与使用场景介绍

使用完毕如希望退出,按快捷键ctrl+d或ctrl+c即可退出当前的虚拟终端。

ansible-console命令在实际工作中用于ad-hoc和ansible-playbooks之间的场景,常用于集中一批临时操作或命令,使用ad-hoc要键入很多次但整体操作的复杂度又不至于使用playbooks时,这时ansible-console是最佳选择。