超简单ansible2.4.2.0与playbook入门教程
阅读原文时间:2021年04月26日阅读:1

文章目录

官方文档:https://docs.ansible.com/ansible/latest/index.html

原理图


host inventory主机清单
playbook剧本
plugin插件
core modules核心模块:复制,安装…
custom定制模块

测试环境

节点

ip

操作系统

ansible

192.168.0.110

CentOS7.4_x64 epel yum安装ansible

node1

192.168.0.111

CenOS7.4_x64

node2

192.168.0.112

CenOS7.2_x64

  • 从ansible上生成ssh私钥同步到两台node主机上,实现无密钥登录管理(推荐)
    ssh-keygen -t rsa
  • 同步到到两台node上
    ssh-copy-id -i ~/.ssh/id_rsa 192.168.0.111
    ssh-copy-id -i ~/.ssh/id_rsa 192.168.0.112

注意同步过程需要输入yes和各自的root密码即可

安装

yum install epel-release -y
yum install ansible -y
ansible --version#查看版本

配置及获取帮助说明

配置与执行文件说明
cat /etc/ansible/ansible.cfg 
#ansible的主配置文件
#这个文件主要定义了roles_path路径,主机清单路径,连接清单中的主机方式等配置,这些大部的默认配置已经足够我们平时使用,如需要特别配置可以自行去修改;
vim /etc/ansible/ansible.cfg
ssh key host: host_key_checking = False #关闭校验 
accelerate_port = 10000 #连接加速配置
accelerate_multi_key = yes   

cat /etc/ansible/hosts
#这个配置文件就是默认主机清单配置文件,可通过ansible.cfg重新定义的;

#定义一组主机:
vim /etc/ansible/hosts
egrep -v '(\^$|^#)' /etc/ansible/hosts
[websrvs]
192.168.0.111
192.168.0.112
#除了以上两个重要的配置文件还有三个重要的可执行文件分别是:
#ansible 主执行程序,一般用于命令行下执行
#ansible-playbook 执行playbook中的任务
#ansible-doc 获取各模块的帮助信息
ansible 使用格式
HOST-PATTERN      #匹配主机模式,如all表示所有主机
-m MOD_NAME       #模块名   如:ping
-a MOD_ARGS        #模块执行的参数
-f FORKS                  #生成几个子进行程执行
-C                               #(不执行,模拟跑)
-u Username             #某主机的用户名
-c  CONNection        #连接方式(default smart)    

#完整示例:
[root@ansible ~]# ansible all -m shell -a "ifconfig|grep ens33"
192.168.0.112 | SUCCESS | rc=0 >>
ens33: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500

192.168.0.111 | SUCCESS | rc=0 >>
ens33: flags=4163<UP,BROADCAST,RUNNING,MULTICAST>  mtu 1500
ansible-doc 获取帮助信息

ansible模块比较多,可以通过ansible-doc --help 显示帮助信息
ansible doc -l 获取所有当前版本下的可用模块及简要信息
ansible-doc -s 模块名 获取指定模块帮助信息说明

ansible常用模块

copy模块

从本地copy文件分发到目录主机路径

参数说明:
src= 源文件路径
dest= 目标路径 
注意src= 路径后面带/ 表示带里面的所有内容复制到目标目录下,不带/是目录递归复制过去
content= 自行填充的文件内容
owner 属主
group 属组
mode权限

#示例
ansible all  -m copy -a "src=/etc/fstab dest=/tmp/fstab.ansible mode=600"
ansible all -m copy -a "content='hi there\n' dest=/tmp/hi.txt"
到node1上查看
[root@node1 tmp]# ll
-rw------- 1 root root 465 2月   9 14:59 fstab.ansible
-rw-r--r-- 1 root root   9 2月   9 14:58 hi.txt
fetch模块

从远程主机拉取文件到本地

ansible all  -m fetch -a "src=/tmp/hi.txt dest=/tmp"
192.168.0.111 | SUCCESS => {
    "changed": true, 
    "checksum": "279d9035886d4c0427549863c4c2101e4a63e041", 
    "dest": "/tmp/192.168.0.111/tmp/hi.txt", 
    "md5sum": "12f6bb1941df66b8f138a446d4e8670c", 
    "remote_checksum": "279d9035886d4c0427549863c4c2101e4a63e041", 
    "remote_md5sum": null
}
192.168.0.112 | SUCCESS => {
    "changed": true, 
    "checksum": "279d9035886d4c0427549863c4c2101e4a63e041", 
    "dest": "/tmp/192.168.0.112/tmp/hi.txt", 
    "md5sum": "12f6bb1941df66b8f138a446d4e8670c", 
    "remote_checksum": "279d9035886d4c0427549863c4c2101e4a63e041", 
    "remote_md5sum": null
}
#说明:fetch使用很简单,src和dest,dest只要指定一个接收目录,默认会在后面加上远程主机及src的路径
command模块

在远程主机上执行命令,属于裸执行,非键值对显示;不进行shell解析

ansible all -m command -a "ifconfig"#执行成功
ansible all -m command -a "ifconfig|grep lo"#失败
192.168.0.111 | FAILED | rc=2 >>
[Errno 2] 没有那个文件或目录

192.168.0.112 | FAILED | rc=2 >>
[Errno 2] 没有那个文件或目录
#这就是因为command模块不是shell解析属于裸执行导致的
#为了能达成以上类似shell中的解析,ansible有一个shell模块;
shell模块

由于commnad只能执行裸命令(即系统环境中有支持的命令),至于管道之类的功能不支持,
shell模块可以做到

ansible all -m shell -a "ifconfig|grep lo"#执行成功
file模块

设置文件属性(创建文件)

常用参数:
path目标路径
state directory为目录,link为软件链接
group 目录属组
owner 属主
等,其他参数通过ansible-doc -s file 获取
#示例1:创建目录
ansible all -m file -a "path=/var/tmp/hello.dir state=directory"
#示例2:创建软件链接
ansible all -m file -a "src=/tmp/hi.txt path=/var/tmp/hi.link state=link"
cron模块

通过cron模块对目标主机生成计划任务

常用参数:
除了分(minute)时(hour)日(day)月(month)周(week)外
name: 本次计划任务的名称
state: present 生成(默认) |absent 删除 (基于name)
#示例1:对各主机添加每隔3分钟从time.windows.com同步时间
ansible all -m cron -a "minute=*/3 job='/usr/sbin/update time.windows.com &>/dev/null'  name=update_time"
#示例2:删除计划任务
 ansible all -m cron -a "name=update_time state=absent"
yum模块

安装软件包的模块

常用参数说明:
enablerepo,disablerepo表示启用与禁用某repo库
name 安装包名
state (present' orinstalled', latest')表示安装, (absent' or removed') 表示删除
#示例:通过安装epel扩展源并安装nginx
ansible all -m yum -a "name=epel-release state=installed"
ansible all -m yum -a "name=nginx state=installed"
service模块

服务管理模块

常用参数:
name:服务名
state:服务状态
enabled: 是否开机启动 true|false
runlevel: 启动级别 (systemed方式忽略)
#示例:
 ansible all -m service -a "name=nginx state=started enabled=true"
script模块

把本地的脚本传到远端执行;前提是到远端可以执行,不要把Linux下的脚本同步到windows下执行

#示例
cat test.sh 
#!/bin/bash
echo "ansible script test!" > /tmp/ansible.txt
ansible all -m script -a "/root/test.sh"

playbook

playbook是指导手册,目标远程主机就是库存和原料对象
playbook是ansible的配置,部署和编排的语言
playbook是基于YAML语言格式配置
基础教程:https://www.runoob.com/w3cnote/yaml-intro.html

yaml基础语法
快速入门

下面立刻展示YAML最基本,最常用的一些使用格式:
首先YAML中允许表示三种格式,分别是常量值,对象和数组

#即表示url属性值;
url: http://www.wolfcode.cn 
#即表示server.host属性的值;
server:
    host: http://www.wolfcode.cn 
#数组,即表示server为[a,b,c]
server:
    - 120.168.117.21
    - 120.168.117.22
    - 120.168.117.23
#常量
pi: 3.14   #定义一个数值3.14
hasChild: true  #定义一个boolean值
name: '你好YAML'   #定义一个字符串

注释
和properties相同,使用#作为注释,YAML中只有行注释。

基本格式要求
1,YAML大小写敏感;
2,使用缩进代表层级关系;
3,缩进只能使用空格,不能使用TAB,不要求空格个数,只需要相同层级左对齐(一般2个或4个空格)
对象
#使用冒号代表,格式为key: value。冒号后面要加一个空格:
key: value

#可以使用缩进表示层级关系;
key: 
    child-key: value
    child-key2: value2

#YAML中还支持流式(flow)语法表示对象,比如上面例子可以写为:
key: {child-key: value, child-key2: value2}

#较为复杂的对象格式,可以使用问号加一个空格代表一个复杂的key,配合一个冒号加一个空格代表一个value:
?  
    - complexkey1
    - complexkey2
:
    - complexvalue1
    - complexvalue2
#意思即对象的属性是一个数组[complexkey1,complexkey2],对应的值也是一个数组[complexvalue1,complexvalue2]
数组
#使用一个短横线加一个空格代表一个数组项:
hobby:
    - Java
    - LOL
    - 
#当然也可以有这样的写法:
-
    - Java
    - LOL
#可以简单理解为:[[Java,LOL]]

#一个相对复杂的例子:
companies:
    -
        id: 1
        name: company1
        price: 200W
    -
        id: 2
        name: company2
        price: 500W
#意思是companies属性是一个数组,每一个数组元素又是由id,name,price三个属性构成;

#数组也可以使用流式(flow)的方式表示:
companies: [{id: 1,name: company1,price: 200W},{id: 2,name: company2,price: 500W}]
常量
#YAML中提供了多种常量结构,包括:整数,浮点数,字符串,NULL,日期,布尔,时间。下面使用一个例子来快速了解常量的基本使用:

boolean: 
    - TRUE  #true,True都可以
    - FALSE  #false,False都可以
float:
    - 3.14
    - 6.8523015e+5  #可以使用科学计数法
int:
    - 123
    - 0b1010_0111_0100_1010_1110    #二进制表示
null:
    nodeName: 'node'
    parent: ~  #使用~表示null
string:
    - 哈哈
    - 'Hello world'  #可以使用双引号或者单引号包裹特殊字符
    - newline
      newline2    #字符串可以拆成多行,每一行会被转化成一个空格
date:
    - 2018-02-17    #日期必须使用ISO 8601格式,即yyyy-MM-dd
datetime: 
    -  2018-02-17T15:02:31+08:00    #时间使用ISO 8601格式,时间和日期之间使用T连接,最后使用+代表时区
一些特殊符号
YAML中提供了很多特殊符号,在这里简单介绍常用的一些:
1,--- YAML可以在同一个文件中,使用---表示一个文档的开始;比如Springboot中profile的定义:
server:
    address: 192.168.1.100
---
spring:
    profiles: development
    server:
        address: 127.0.0.1
---
spring:
    profiles: production
    server:
        address: 192.168.1.120

代表定义了两个profile,一个是development,一个production;也常常使用---来分割不同的内容,比如记录日志:
---
Time: 2018-02-17T15:02:31+08:00
User: ed
Warning:
     This is an error message for the log file
---
Time: 2018-02-17T15:05:21+08:00
User: ed
Warning:
    A slightly different error message.
2,... 和---配合使用,在一个配置文件中代表一个文件的结束:

---
time: 20:03:20
player: Sammy Sosa
action: strike (miss)
...
---
time: 20:03:47
player: Sammy Sosa
action: grand slam
...

相当于在一个yaml文件中连续写了两个yaml配置项。
3,!! YAML中使用!!做类型强行转换:

string:
    - !!str 54321
    - !!str true
相当于把数字和布尔类型强转为字符串。当然允许转型的类型很多,比如:

--- !!set
- Mark McGwire: 65
- Sammy Sosa: 63
- Sammy Sosa: 63
- Ken Griffy: 58
将数组解析为set,简单理解,转化的内容就是:[{Ken Griffy=58}, {Mark McGwire=65}, {Sammy Sosa=63}],重复的Sammy Sosa去掉;

4,>在字符串中折叠换行,| 保留换行符,这两个符号是YAML中字符串经常使用的符号,比如:
accomplishment: >
 Mark set a major league
 home run record in 1998.
stats: |
 65 Home Runs
 0.278 Batting Average
那么结果是:

stats=65 Home Runs
 0.278 Batting Average,
即| 符号保留了换行符,而accomplishment的结果为:

accomplishment=Mark set a major league home run record in 1998.
即将换行符转化成了空格;要注意一点的是,每行的文本前一定要有一个空格。
|符号常见用于在YAML中配置HTML片段:

phraseTemplate: |
  <p style="color: red">
    some template ${msg}
  </p>
5,引用。重复的内容在YAML中可以使用&来完成锚点定义,使用*来完成锚点引用,例如:

hr:
- Mark McGwire
- &SS Sammy Sosa
rbi:
- *SS 
- Ken Griffey
可以看到,在hr中,使用&SS为Sammy Sosa设置了一个锚点(引用),名称为SS,在rbi中,使用*SS完成了锚点使用,那么结果为:

{rbi=[Sammy Sosa, Ken Griffey], hr=[Mark McGwire, Sammy Sosa]}
我们也可以这样定义:

SS: &SS Sammy Sosa
hr:
 - Mark McGwire
 - *SS
rbi:
 - *SS 
 - Ken Griffey
注意,不能独立的定义锚点,比如不能直接这样写: &SS Sammy Sosa;另外,锚点能够定义更复杂的内容,比如:

default: &default
    - Mark McGwire
    - Sammy Sosa
hr: *default
那么hr相当于引用了default的数组,注意,hr: *default要写在同一行。

6,合并内容。主要和锚点配合使用,可以将一个锚点内容直接合并到一个对象中。来看一个示例:

merge:
  - &CENTER { x: 1, y: 2 }
  - &LEFT { x: 0, y: 2 }
  - &BIG { r: 10 }
  - &SMALL { r: 1 }

sample1: 
    <<: *CENTER
    r: 10

sample2:
    << : [ *CENTER, *BIG ]
    other: haha

sample3:
    << : [ *CENTER, *BIG ]
    r: 100
在merge中,定义了四个锚点,分别在sample中使用。
sample1中,<<: *CENTER意思是引用{x: 1,y: 2},并且合并到sample1中,那么合并的结果为:sample1={r=10, y=2, x=1}

sample2中,<<: [*CENTER, *BIG] 意思是联合引用{x: 1,y: 2}和{r: 10},并且合并到sample2中,那么合并的结果为:sample2={other=haha, x=1, y=2, r=10}

sample3中,引入了*CENTER, *BIG,还使用了r: 100覆盖了引入的r: 10,所以sample3值为:sample3={r=100, y=2, x=1}

有了合并,我们就可以在配置中,把相同的基础配置抽取出来,在不同的子配置中合并引用即可。

以上示例均通过Snakeyaml测试通过
了解更多

如果要了解更多关于YAML的详情,可以了解(本文参考):
1,YAML1.2规范:http://yaml.org/spec/1.2/spec.pdf
2,JS-YAML在线示例:http://nodeca.github.io/js-yaml/

playbook的核心元素

hosts : playbook配置文件作用的主机
tasks: 任务列表
variables: 变量
templates:包含模板语法的文本文件
handlers :由特定条件触发的任务
roles :用于层次性、结构化地组织playbook。roles 能够根据层次型结构自动装载变量文件、tasks以及handlers等

playbook运行方式

ansible-playbook --check 只检测可能会发生的改变,但不真执行操作
ansible-playbook --list-hosts 列出运行任务的主机
ansible-playbook --syntax-check playbook.yaml 语法检测
ansible-playbook -t TAGS_NAME playbook.yaml 只执行TAGS_NAME任务

通过playbook安装管理redis服务
#在家目录下创建playbooks
[root@ansible ~]# mkidr playbooks
[root@ansible ~]# cd playbooks
[root@ansible playbooks]# cat redis_first.yaml
- hosts: all 
  remote_user: root
  tasks:
  - name: install redis
    yum: name=redis state=latest

  - name: start redis
    service: name=redis state=started
#语法检测:
[root@ansible playbooks]# ansible-playbook --syntax-check redis_first.yaml 
playbook: redis_first.yaml

#执行
[root@ansible playbooks]# ansible-playbook --list-hosts redis_first.yaml
playbook: redis_first.yaml
  play #1 (all): all    TAGS: []
    pattern: [u'all']
    hosts (2):
      192.168.0.111
      192.168.0.112

[root@ansible playbooks]# ansible-playbook redis_first.yaml
带配置文件的安装管理redis
#首先复制一个redis.conf到本地并进行修改
[root@ansible ~]# ansible 192.168.0.111 -m fetch -a "src=/etc/redis.conf dest=./"
[root@ansible ~]# mv /root/192.168.0.111/etc/redis.conf  /root/playbooks/redis.conf
修改bind 0.0.0.0
cat redis_second.yaml
- hosts: all                   #所有远程主机
  remote_user: root      #以远程主机上root用户执行
  tasks:                        #任务
  - name: install redis      #任务之安装
    yum: name=redis state=latest        #动作调用yum模块安装
  - name: copy config file     #任务之复制同步配置文件到远程目标主机
    copy: src=/root/playbooks/redis.conf dest=/etc/redis.conf owner=redis       #动作copy模块执行
    notify: restart redis      #触发的动作
    tags: configfile         #任务标记名configfile
  - name: start redis      #任务之启动redis
    service: name=redis state=started    #动作调用sevice模块
  handlers:              #特定情况下,接收到其他任务的通知时被触发
  - name: restart redis
    service: name=redis state=restarted
#测试并执行
[root@ansible playbooks]# ansible-playbook  redis_second.yaml 
#可以在redis.conf中添加一个登录密码再执行测试
[root@ansible playbooks]# ansible-playbook -t configfile redis_second.yaml 
安装zabbix
---
- hosts: all
  become: true
  tasks:
  - name: install zabbix rpm source
    yum:
      name: http://repo.zabbix.com/zabbix/3.4/rhel/7/x86_64/zabbix-release-3.4-2.el7.noarch.rpm
      state: installed
    when: ansible_distribution == 'CentOS'
  - name: donwload ubuntu deb
    get_url:
      url: http://repo.zabbix.com/zabbix/3.4/ubuntu/pool/main/z/zabbix-release/zabbix-release_3.4-1+xenial_all.deb
      dest: /tmp/zabbix.deb
    when: ansible_distribution == 'Ubuntu'
  - name: install zabbix source
    apt:
      deb: /tmp/zabbix.deb
    when: ansible_distribution == 'Ubuntu'
  - name: install centos zabbix package
    yum:
      name: ['zabbix-server-mysql','zabbix-proxy-mysql','zabbix-web-mysql']
      state: installed
    when: ansible_distribution == 'CentOS'
  - name: install ubuntu zabbix package
    yum:
      name: zabbix-agent
      update_cache: yes
    when: ansible_distribution == 'Ubuntu'
  - name: modify zabbix config
    replace:
      path:  /etc/zabbix/zabbix_server.conf 
      regexp: DBUser=zabbix
      replace: DBUser=root
    when: ansible_distribution == 'CentOS'
  - name: import zabbix sql table
    shell: zcat /usr/share/doc/zabbix-server-mysql-3.4.7/create.sql.gz | mysql -uroot zabbix
    when: ansible_distribution == 'CentOS'
  - name: disable selinux
    selinux:
      state: disabled
    when: ansible_distribution == 'CentOS'
  - name: start zabbix-server
    systemd:
      name: zabbix-server
      state: started
    when: ansible_distribution == 'CentOS'
  - name: start zabbix-agent
    systemd:
      name: zabbix-agent
      state: started
    when: ansible_distribution == 'CentOS'