ansible基本使用教程，ansible使用教程
ansible基本使用教程，ansible使用教程
转载请注明出处http://www.cnblogs.com/chenxianpao/p/7360349.html
一、 介绍
1. 简介 ansible是新出现的自动化运维工具，基于Python开发，集合了众多运维工具（puppet、cfengine、chef、func、fabric）的优点，实现了批量系统配置、批量程序部署、批量运行命令等功能。 ansible是基于模块工作的，本身没有批量部署的能力。真正具有批量部署的是ansible所运行的模块，ansible只是提供一种框架。主要包括： (1)、连接插件connection plugins：负责和被监控端实现通信； (2)、host inventory：指定操作的主机，是一个配置文件里面定义监控的主机； (3)、各种模块核心模块、command模块、自定义模块； (4)、借助于插件完成记录日志邮件等功能； (5)、playbook：剧本执行多个任务时，非必需可以让节点一次性运行多个任务。 github地址：https://github.com/ansible/ansible/ 官网地址：https://docs.ansible.com 在线playbook分享平台：https://galaxy.ansible.com 2. 特性 (1)、no agents：不需要在被管控主机上安装任何客户端； (2)、no server：无服务器端，使用时直接运行命令即可； (3)、modules in any languages：基于模块工作，可使用任意语言开发模块； (4)、yaml，not code：使用yaml语言定制剧本playbook； (5)、ssh by default：基于SSH工作； (6)、strong multi-tier solution：可实现多级指挥。 3. 优点 (1)、轻量级，无需在客户端安装agent，更新时，只需在操作机上进行一次更新即可； (2)、批量任务执行可以写成脚本，而且不用分发到远程就可以执行； (3)、使用python编写，维护更简单，ruby语法过于复杂； (4)、支持sudo。 4. 基本架构（懒人，图源于网络，谢作图之人）
· 核心引擎：即ansible
· 核心模块（core modules）：这些都是ansible自带的模块，ansible模块资源分发到远程节点使其执行特定任务或匹配一个特定的状态。
· 自定义模块（custom modules）：如果核心模块不足以完成某种功能，可以添加自定义模块。
· 插件（plugins）：完成模块功能的补充，借助于插件完成记录日志、邮件等功能
· 剧本（playbook）：定义ansible任务的配置文件，可以将多个任务定义在一个剧本中，由ansible自动执行，剧本执行支持多个任务，可以由控制主机运行多个任务，同时对多台远程主机进行管理。
· playbook是ansible的配置、部署和编排语言，可以描述一个你想要的远程系统执行策略，或一组步骤的一般过程。如果ansible模块作为你的工作室工具，playbook就是设计方案。在基本层面上，剧本可以用于管理配置和部署远程机器。在更高级的应用中，可以序列多层应用及滚动更新，并可以把动作委托给其他主机，与监控服务器和负载平衡器交互。
· 连接插件（connection plugins）：ansible基于连接插件连接到各个主机上，负责和被管理节点实现通信。虽然ansible是使用ssh连接到各被管理节点，但它还支持其他的连接方法，所以需要有连接插件。
· 主机清单（host inventory）：定义ansible管理的主机策略，默认是在ansible的hosts配置文件中定义被管节点，同时也支持自定义动态主机清单和指定配置文件路径。
ansible采用paramiko协议库（Fabric也使用这个），通过ssh或者ZeroMQ等连接主机。ansible在控制主机主机将ansible模块通过ssh协议（或者Kerberos、LDAP）推送到被管节点执行，执行完之后自动删除。控制主机与被管理节点之间支持local、SSH、ZeroMQ三种连接方式，默认使用基于SSH的连接。在规模较大的情况下使用ZeroMQ连接方式会明显改善执行速度。
5. 任务执行模式（懒人，图源于网络，谢作图之人）
ansible系统由控制主机对被管节点的操作方式可分为两类，即ad-hoc和playbook。
ad-hoc模式使用单个模块，支持批量执行单条命令。
playbook模式是ansible的主要管理方式，通过多个task集合完成一类功能，可以简单的理解为通过组合多条ad-hoc操作的配置文件。
6. ansible与其他配置管理软件的对比
技术特性比较：
| 项目 | Puppet | Saltstack | Ansible |
| 开发语言 | Ruby | Python | Python |
| 是否有客户端 | 是 | 是 | 否 |
| 是否支持二次开发 | 不支持 | 支持 | 支持 |
| 服务器与远程机器是否相互验证 | 是 | 是 | 是 |
| 服务器与远程机器通信是否加密 | 是，标准SSL协议 | 是，使用AES加密 | 是，使用OpenSSH |
| 是否提供WEB UI | 提供 | 提供 | 提供，但是商业版本 |
| 配置文件格式 | Ruby语法 | YAML | YAML |
| 命令行执行 | 不支持，但可以通过配置模块实现 | 支持 | 支持 |
二、ansible组件介绍
1. ansible inventory 在大规模的配置管理工作中我们需要管理不同业务的机器，这些机器的信息都存放在ansible的inventory组件里。在我们工作中配置部署针对的主机必须先存放在inventory里，这样才能使用ansible对它进行操作。默认ansible的inventory是一个静态的ini文件/etc/ansible/hosts。亦可通过ANSIBLE_HOSTS环境变量指定或者命令运行时用-i参数临时设置。 参考示例： 定义主机和主机组 1、100.0.0.1 ansible_ssh_pass='123456' 2、100.0.0.2 ansible_ssh_pass='123456' 3、[docker] 4、100.0.0.1[1:3] 5、[docker:vars] 6、ansible_ssh_pass='123456' 7、[ansible:children] 8、docker 第一、二行定义一个主机，指定ssh登录密码 第三行定义了一个叫docker的组 第四行定义了docker组下面四个主机从100.0.0.11-100.0.0.13 第五、六行定义了docker组的ssh登录密码 第七、八行定义了ansible组，ansible组包含docker组 2.inventory内置参数| 参考 | 解释 | 例子 |
| ansible_ssh_host | 将要连接的远程主机名.与你想要设定的主机的别名不同的话,可通过此变量设置. | ansible_ssh_host=192.169.1.123 |
| ansible_ssh_port | ssh端口号.如果不是默认的端口号,通过此变量设置. | ansible_ssh_port=5000 |
| ansible_ssh_user | 默认的 ssh 用户名 | ansible_ssh_user=cxpadmin |
| ansible_ssh_pass | ssh 密码(这种方式并不安全,我们强烈建议使用 --ask-pass 或 SSH 密钥) | ansible_ssh_pass=’123456’ |
| ansible_sudo_pass | sudo 密码(这种方式并不安全,我们强烈建议使用 --ask-sudo-pass) | ansible_sudo_pass=’123456’ |
| ansible_sudo_exe | sudo 命令路径(适用于1.8及以上版本) | ansible_sudo_exe=/usr/bin/sudo |
| ansible_connection | 与主机的连接类型.比如:local, ssh 或者 paramiko. Ansible 1.2 以前默认使用 paramiko.1.2 以后默认使用 'smart','smart' 方式会根据是否支持 ControlPersist, 来判断'ssh' 方式是否可行. | ansible_connection=local |
| ansible_ssh_private_key_file | ssh 使用的私钥文件.适用于有多个密钥,而你不想使用 SSH 代理的情况. | ansible_ssh_private_key_file=/root/key |
| ansible_shell_type | 目标系统的shell类型.默认情况下,命令的执行使用 'sh' 语法,可设置为 'csh' 或 'fish'. | ansible_shell_type=zsh |
| ansible_python_interpreter | 目标主机的 python 路径.适用于的情况: 系统中有多个 Python, 或者命令路径不是"/usr/bin/python",比如 \*BSD, 或者 /usr/bin/python 不是 2.X 版本的 Python.我们不使用 "/usr/bin/env" 机制,因为这要求远程用户的路径设置正确,且要求 "python" 可执行程序名不可为 python以外的名字(实际有可能名为python26). |
ansible_python_interpreter=/usr/bin/python2.6 |
| ansible_*_interpreter | 定义其他语言解释器 | ansible_*_interpreter=/usr/bin/ruby |
| ansible_sudo | 定义sudo用户 | ansible_sudo=cxpadmin |
常用模块介绍
① ping模块 ping模块的作用与其名相同，即判断远程主机的网络是否畅通 示例：ansible cluster_hosts -m ping ② copy模块 copy模块在ansible里的角色就是把ansible执行机器上的文件拷贝到远程节点上。与fetch模块相反的操作。 常用模块参数| 参数名 | 是否必须 | 默认值 | 选项 | 说明 |
| src | no | 用于定位ansible执行的机器上的文件，需要绝对路径。如果拷贝的是文件夹，那么文件夹会整体拷贝，如果结尾是”/”,那么只有文件夹内的东西被考过去。一切的感觉很像rsync | ||
| content | no | 用来替代src，用于将指定文件的内容，拷贝到远程文件内 | ||
| dest | yes | 用于定位远程节点上的文件，需要绝对路径。如果src指向的是文件夹，这个参数也必须是指向文件夹 | ||
| backup | no | no | yes/no | 备份远程节点上的原始文件，在拷贝之前。如果发生什么意外，原始文件还能使用。 |
| directory_mode | no | 这个参数只能用于拷贝文件夹时候，这个设定后，文件夹内新建的文件会被拷贝。而老旧的不会被拷贝 | ||
| follow | no | no | yes/no | 当拷贝的文件夹内有link存在的时候，那么拷贝过去的也会有link |
| force | no | yes | yes/no | 默认为yes,会覆盖远程的内容不一样的文件（可能文件名一样）。如果是no，就不会拷贝文件，如果远程有这个文件 |
| group | no | 设定一个群组拥有拷贝到远程节点的文件权限 | ||
| mode | no | 等同于chmod，参数可以为“u+rwx or u=rw,g=r,o=r” | ||
| owner | no | 设定一个用户拥有拷贝到远程节点的文件权限 |
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 |
[root@node1 ansible]# ansible testservers -m copy -a 'src=/root/install.log dest=/tmp/install.log owner=testuser group=testgroup' 192.168.100.131 | success >> { "changed": true, "checksum": "7b3626c84bb02d12472c03d2ece878fdc4756c94", "dest": "/tmp/install.log", "gid": 1100, "group": "testgroup", "md5sum": "c7d8a01a077940859e773b7770d2e07e", "mode": "0644", "owner": "testuser", "size": 9458, "src": "/root/.ansible/tmp/ansible-tmp-1456387213.94-229503410500766/source", "state": "file", "uid": 1000 } 192.168.100.132 | success >> { "changed": true, "checksum": "7b3626c84bb02d12472c03d2ece878fdc4756c94", "dest": "/tmp/install.log", "gid": 1100, "group": "testgroup", "md5sum": "c7d8a01a077940859e773b7770d2e07e", "mode": "0644", "owner": "testuser", "size": 9458, "src": "/root/.ansible/tmp/ansible-tmp-1456387213.94-186055595812050/source", "state": "file", "uid": 1000 } |
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 |
[root@node1 ansible]# echo "test " >> /root/install.log [root@node1 ansible]# ansible testservers -m copy -a 'src=/root/install.log dest=/tmp/install.log owner=testuser group=testgroup backup=yes' 192.168.100.132 | success >> { "backup_file": "/tmp/install.log.2016-02-25@16:01:26~", "changed": true, "checksum": "b5da7af32ad02eb98f77395b28f281a965b4c1f5", "dest": "/tmp/install.log", "gid": 1100, "group": "testgroup", "md5sum": "d39956add30a18019cb5ad2381a0cd43", "mode": "0644", "owner": "testuser", "size": 9464, "src": "/root/.ansible/tmp/ansible-tmp-1456387285.87-128685659798967/source", "state": "file", "uid": 1000 } 192.168.100.131 | success >> { "backup_file": "/tmp/install.log.2016-02-25@16:01:26~", "changed": true, "checksum": "b5da7af32ad02eb98f77395b28f281a965b4c1f5", "dest": "/tmp/install.log", "gid": 1100, "group": "testgroup", "md5sum": "d39956add30a18019cb5ad2381a0cd43", "mode": "0644", "owner": "testuser", "size": 9464, "src": "/root/.ansible/tmp/ansible-tmp-1456387285.86-134452201968647/source", "state": "file", "uid": 1000 } [root@node1 ansible]# ansible testservers -m raw -a 'ls -lrth /tmp/install*' 192.168.100.131 | success | rc=0 >> -rw-r--r-- 1 root root 9.3K 2 25 16:00 /tmp/install.log.2016-02-25@16:01:26~ -rw-r--r-- 1 testuser testgroup 9.3K 2 25 16:01 /tmp/install.log 192.168.100.132 | success | rc=0 >> -rw-r--r-- 1 root root 9.3K 2 25 16:00 /tmp/install.log.2016-02-25@16:01:26~ -rw-r--r-- 1 testuser testgroup 9.3K 2 25 16:01 /tmp/install.log |
| 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 |
[root@node1 ansible]# tree testdir testdir ├── a │ ├── e │ │ └── ansible.cfg │ ├── f │ └── g ├── b │ ├── e │ ├── f │ └── g └── c ├── ansible.cfg ├── e ├── f └── g [root@node1 ansible]# ansible testservers -m copy -a 'src=/etc/ansible/testdir dest=/tmp/ owner=testuser group=testgroup backup=yes' 192.168.100.131 | success >> { "changed": true, "dest": "/tmp/", "src": "/etc/ansible/testdir" } 192.168.100.132 | success >> { "changed": true, "dest": "/tmp/", "src": "/etc/ansible/testdir" } [root@node1 ansible]# ansible testservers -m command -a 'tree /tmp/testdir' 192.168.100.131 | success | rc=0 >> /tmp/testdir |-- a | `-- e | `-- ansible.cfg |-- b | `-- e | `-- hosts `-- c `-- ansible.cfg 5 directories, 3 files 192.168.100.132 | success | rc=0 >> /tmp/testdir |-- a | `-- e | `-- ansible.cfg |-- b | `-- e | `-- hosts `-- c `-- ansible.cfg 5 directories, 3 files |
| 参数名 | 参数说明 | 返回值 | 返回值类型 | 样例 |
| src | 位于ansible执行机上的位置 | changed | string | /home/httpd/.ansible/tmp/ansible-tmp-1423796390.97-147729857856000/source |
| backup_file | 将原文件备份 | changed and if backup=yes | string | /path/to/file.txt.2015-02-12@22:09~ |
| uid | 在执行后，拥有者的ID | success | int | 100 |
| dest | 远程节点的目标目录或文件 | success | string | /path/to/file.txt |
| checksum | 拷贝文件后的checksum值 | success | string | 6e642bb8dd5c2e027bf21dd923337cbb4214f827 |
| md5sum | 拷贝文件后的md5 checksum值 | when supported | string | 2a5aeecc61dc98c4d780b14b330e3282 |
| state | 执行后的状态 | success | string | file |
| gid | 执行后拥有文件夹、文件的群组ID | success | int | 100 |
| mode | 执行后文件的权限 | success | string | 0644 |
| owner | 执行后文件所有者的名字 | success | string | httpd |
| group | 执行后文件所有群组的名字 | success | string | httpd |
| size | 执行后文件大小 | success | int | 1220 |
| 参数 | 是否必须 | 默认值 | 选项 | 说明 |
| chdir | no | 跟command一样的，运行shell之前cd到某个目录 | ||
| creates | no | 跟command一样的，如果某个文件存在则不运行shell | ||
| removes | no | 跟command一样的，如果某个文件不存在则不运行shell |
| 参数 | 是否必须 | 默认值 | 选项 | 说明 |
| chdir | no | 运行command命令前先cd到这个目录 | ||
| creates | no | 如果这个参数对应的文件存在，就不运行command | ||
| executable | no | 将shell切换为command执行，这里的所有命令需要使用绝对路径 | ||
| removes | no | 如果这个参数对应的文件不存在，就不运行command |
| 参数 | 必填 | 默认值 | 选项 | 说明 |
| Dest | Yes | 用来存放文件的目录，例如存放目录为backup，源文件名称为/etc/profile在主机pythonserver中，那么保存为/backup/pythonserver/etc/profile | ||
| Fail_on_missing | No | No | Yes/no | 当源文件不存在的时候，标识为失败 |
| Flat | No | 允许覆盖默认行为从hostname/path到/file的，如果dest以/结尾，它将使用源文件的基础名称 | ||
| Src | Yes | 在远程拉取的文件，并且必须是一个file，不能是目录 | ||
| Validate_checksum | No | Yes | Yes/no | 当文件fetch之后进行md5检查 |
| 参数 | 必填 | 默认 | 选项 | 说明 |
| Follow | No | No | Yes/no | 这个标识说明这是系统链接文件，如果存在，应该遵循 |
| Force | No | No | Yes/no | 强制创建链接在两种情况下：源文件不存在（过会会存在）；目标存在但是是文件（创建链接文件替代） |
| Group | No | 文件所属用户组 | ||
| Mode | No | 文件所属权限 | ||
| Owner | No | 文件所属用户 | ||
| Path | Yes | 要控制文件的路径 | ||
| Recurse | No | No | Yes/no | 当文件为目录时，是否进行递归设置权限 |
| Src | No | 文件链接路径，只有状态为link的时候，才会设置，可以是绝对相对不存在的路径 | ||
| State | No | File | File/link Directory Hard/touch Absent |
如果是目录不存在，那么会创建目录；如果是文件不存在，那么不会创建文件；如果是link，那么软链接会被创建或者修改；如果是absent，那么目录下的所有文件都会被删除，如果是touch，会创建不存在的目录和文件 |
| 参数名 | 是否必须 | 默认值 | 选项值 | 参数说明 |
| conf_file | no | 设定远程yum执行时所依赖的yum配置文件 | ||
| disable_gpg_check | no | No | Yes/No | 在安装包前检查包，只会影响state参数为present或者latest的时候 |
| list | No | 只能由ansible调用，不支持playbook，这个干啥的大家都懂 | ||
| name | Yes | 你需要安装的包的名字，也能如此使用name=python=2.7安装python2.7 | ||
| state | no | present | present/latest/absent | 用于描述安装包最终状态，present/latest用于安装包，absent用于remove安装包 |
| update_cache | no | no | yes/no | 用于安装包前执行更新list,只会影响state参数为present/latest的时候 |
| 参数名 | 是否必须 | 默认值 | 选项 | 说明 |
| enabled | no | yes/no | 启动os后启动对应service的选项。使用service模块的时候，enabled和state至少要有一个被定义 | |
| name | yes | 需要进行操作的service名字 | ||
| state | no | stared/stoped/restarted/reloaded | service最终操作后的状态。 |
| 参数名 | 是否必须 | 默认值 | 选项 | 说明 |
| backup | 对远程主机上的原任务计划内容修改之前做备份 | |||
| cron_file | 如果指定该选项，则用该文件替换远程主机上的cron.d目录下的用户的任务计划 | |||
| day | 日（1-31，*，*/2,……） | |||
| hour | 小时（0-23，*，*/2，……） | |||
| minute | 分钟（0-59，*，*/2，……） | |||
| month | 月（1-12，*，*/2，……） | |||
| weekday | 周（0-7，*，……） | |||
| job | 要执行的任务，依赖于state=present | |||
| name | 该任务的描述 | |||
| special_time | 指定什么时候执行，参数：reboot,yearly,annually,monthly,weekly,daily,hourly | |||
| state | 确认该任务计划是创建还是删除 | |||
| user | 以哪个用户的身份执行 |
| 参数名 | 是否必须 | 默认值 | 选项 | 说明 |
| home | 指定用户的家目录，需要与createhome配合使 | |||
| groups | 指定用户的属组 | |||
| uid | 指定用的uid | |||
| password | 指定用户的密码 | |||
| name | 指定用户名 | |||
| createhome | 是否创建家目录 yes|no | |||
| system | 是否为系统用户 | |||
| remove | 当state=absent时，remove=yes则表示连同家目录一起删除，等价于userdel -r | |||
| state | 是创建还是删除 | |||
| shell | 指定用户的shell环境 |
| 参数名 | 是否必须 | 默认值 | 选项 | 说明 |
| sha256sum | 下载完成后进行sha256 check； | |||
| timeout | 下载超时时间，默认10s | |||
| url | 下载的URL | |||
| url_password、url_username | 主要用于需要用户名密码进行验证的情况 | |||
| use_proxy | 是事使用代理，代理需事先在环境变更中定义 |
| 参数名 | 是否必须 | 默认值 | 选项 | 说明 |
| archive | 归档，相当于同时开启recursive(递归)、links、perms、times、owner、group、-D选项都为yes ，默认该项为开启 | |||
| checksum | 跳过检测sum值，默认关闭 | |||
| compress | 是否开启压缩 | |||
| copy_links | 复制链接文件，默认为no ，注意后面还有一个links参数 | |||
| delete | 删除不存在的文件，默认no | |||
| dest | 目录路径 | |||
| dest_port | dest_port：默认目录主机上的端口 ，默认是22，走的ssh协议 | |||
| dirs | 传速目录不进行递归，默认为no，即进行目录递归 | |||
| rsync_opts | rsync参数部分 | |||
| set_remote_user | 主要用于/etc/ansible/hosts中定义或默认使用的用户与rsync使用的用户不同的情况 | |||
| mode | push或pull 模块，push模的话，一般用于从本机向远程主机上传文件，pull 模式用于从远程主机上取文件 |
评论暂时关闭