ansible基本使用

Posted 2021-03-08 iyeqing

ansible是什么？

　　ansible是新出现的自动化运维工具，基于Python开发，集合了众多运维工具（puppet、chef、func、fabric）的优点，实现了批量系统配置、批量程序部署、批量运行命令等功能。

ansible的特点

1. 部署简单，只需在主控端部署Ansible环境，被控端无需做任何操作；
2. 默认使用SSH协议对设备进行管理；
3. 有大量常规运维操作模块，可实现日常绝大部分操作；
4. 配置简单、功能强大、扩展性强；
5. 支持API及自定义模块，可通过Python轻松扩展；
6. 通过Playbooks来定制强大的配置、状态管理；
7. 轻量级，无需在客户端安装agent，更新时，只需在操作机上进行一次更新即可；
8. 提供一个功能强大、操作性强的Web管理界面和REST API接口——AWX平台。

 

ansible的任务执行模式

　　Ansible 系统由控制主机对被管节点的操作方式可分为两类，即adhoc和playbook：

• ad-hoc模式(点对点模式)

　　使用单个模块，支持批量执行单条命令。ad-hoc 命令是一种可以快速输入的命令，而且不需要保存起来的命令。就相当于bash中的一句话shell。

• playbook模式(剧本模式)

　　是Ansible主要管理方式，也是Ansible功能强大的关键所在。playbook通过多个task集合完成一类功能，如Web服务的安装部署、数据库服务器的批量备份等。可以简单地把playbook理解为通过组合多条ad-hoc操作的配置文件。

ansible命令执行过程

1. 加载自己的配置文件，默认/etc/ansible/ansible.cfg；
2. 查找对应的主机配置文件，找到要执行的主机或者组；
3. 加载自己对应的模块文件，如 command；
4. 通过ansible将模块或命令生成对应的临时py文件(python脚本)， 并将该文件传输至远程服务器；
5. 对应执行用户的家目录的.ansible/tmp/XXX/XXX.PY文件；
6. 给文件 +x 执行权限；
7. 执行并返回结果；
8. 删除临时py文件，sleep 0退出；

　　简单理解就是Ansible在运行时， 首先读取ansible.cfg中的配置， 根据规则获取Inventory中的管理主机列表， 并行的在这些主机中执行配置的任务， 最后等待执行返回的结果。

 

ansible配置

ansible配置文件查找顺序

　　ansible与我们其他的服务在这一点上有很大不同，这里的配置文件查找是从多个地方找的，顺序如下：

1. 检查环境变量ANSIBLE_CONFIG指向的路径文件(export ANSIBLE_CONFIG=/etc/ansible.cfg)；
2. ~/.ansible.cfg，检查当前目录下的ansible.cfg配置文件；
3. /etc/ansible.cfg检查etc目录的配置文件。

ansible配置文件

ansible 的配置文件为/etc/ansible/ansible.cfg，ansible 有许多参数，下面我们列出一些常见的参数：

inventory = /etc/ansible/hosts #这个参数表示资源清单inventory文件的位置

library = /usr/share/ansible #指向存放Ansible模块的目录，支持多个目录方式，只要用冒号（：）隔开就可以

forks = 5       #并发连接数，默认为5

sudo_user = root        #设置默认执行命令的用户

remote_port = 22        #指定连接被管节点的管理端口，默认为22端口，建议修改，能够更加安全

host_key_checking = False   #设置是否检查SSH主机的密钥，值为True/False。关闭后第一次连接不会提示配置实例

timeout = 60        #设置SSH连接的超时时间，单位为秒

log_path = /var/log/ansible.log #指定一个存储ansible日志的文件（默认不记录日志）

ansible主机清单

　　inventory用于定义ansible要管理的主机列表，可以定义单个主机和主机组。上面的/etc/ansible/hosts就是默认的inventory。下面展示了inventory常用的定义规则。　　　

cat -n /etc/ansible/hosts
192.168.100.59:22
192.168.100.60 ansible_ssh_pass=‘123456‘ ansible_ssh_port=22
[nginx]
192.168.100.5[7:9]
[nginx:vars]
ansible_ssh_pass=‘123456‘
[webservers:children]
nginx 

　　第一行和第二行单独定义主机，第一行带上了连接被管节点的端口，第二行带上了单独传递给ssh的参数，分别是ssh连接时的登录远程用户的密码参数和ssh的连接端口。

• 第三行和第四行定义的是nginx主机组，该组中包含了192.168.100.57到59这3台主机。还支持字母的扩展，如"web[a-d]"。
• 第五行和第六行定义了要传递给nginx主机组的变量。若定义为"[all:vars]"或"[*:vars]"则表示传递给所有主机的变量。                             　
• 第七和第八行定义了一个新的主机组webservers，该组的组成员有nginx组。

变量优先级

　　另外变量优先级：主机组包含组的变量最高>主机组所在的变量>全局变量

变量引用

　　ansible web -m shell -a ‘echo "{a1}" "{a2}"‘

 

ansible的常用模块

主机连通性测试

　　我们使用ansible web -m ping命令来进行主机连通性测试，效果如下：

[root@server ~]# ansible web -m ping

command 模块

　　这个模块可以直接在远程主机上执行命令，并将结果返回本主机。

注意，该命令不支持| 管道命令。

举例如下：

[root@gxw-server3 ~]# ansible  web -m command -a "ss -ntl"

shell 模块

　　shell模块可以在远程主机上调用shell解释器运行命令，支持shell的各种功能，例如管道等。

[root@gxw-server3 ~]# ansible web -m shell -a ‘cat /etc/passwd | tail -1 ‘

copy 模块

　　这个模块用于将文件复制到远程主机，同时支持给定内容生成文件和修改权限等。
　　其相关选项如下：

src　　　　#被复制到远程主机的本地文件。可以是绝对路径，也可以是相对路径。如果路径是一个目录，则会递归复制，用法类似于"rsync"
content　　　#用于替换"src"，可以直接指定文件的值
dest　　　　#必选项，将源文件复制到的远程主机的绝对路径
backup　　　#当文件内容发生改变后，在覆盖之前把源文件备份，备份文件包含时间信息
directory_mode　　　　#递归设定目录的权限，默认为系统默认权限
force　　　　#当目标主机包含该文件，但内容不同时，设为"yes"，表示强制覆盖；设为"no"，表示目标主机的目标位置不存在该文件才复制。默认为"yes"
others　　　　#所有的 file 模块中的选项可以在这里使用

• 拷贝文件

　　ansible web -m copy -a ‘src=~/hello dest=/data/hello‘ 

• 定内容生成文件，并制定权限

　　ansible web -m copy -a ‘content="I am keer " dest=/data/name mode=666‘

• 覆盖前备份

　　ansible web -m copy -a ‘content="I am keerya " backup=yes dest=/data/name mode=666‘

file 模块

　　该模块主要用于设置文件的属性，比如创建文件、创建链接文件、删除文件等。
　　下面是一些常见的命令：

force　　#需要在两种情况下强制创建软链接，一种是源文件不存在，但之后会建立的情况下；另一种是目标软链接已存在，需要先取消之前的软链，然后创建新的软链，有两个选项：yes|no

group　　#定义文件/目录的属组。后面可以加上mode：定义文件/目录的权限
owner　　#定义文件/目录的属主。后面必须跟上path：定义文件/目录的路径
recurse　　#递归设置文件的属性，只对目录有效，后面跟上src：被链接的源文件路径，只应用于state=link的情况
dest　　#被链接到的路径，只应用于state=link的情况
state　　#状态，有以下选项：

　　directory：如果目录不存在，就创建目录
　　file：即使文件不存在，也不会被创建
　　link：创建软链接
　　hard：创建硬链接
touch：如果文件不存在，则会创建一个新的文件，如果文件或目录已存在，则更新其最后修改时间
absent：删除目录、文件或者取消链接文件

创建目录

ansible web -m file -a ‘path=/data/app state=directory‘

删除文件

1. ansible web -m file -a ‘path=/data/a state=absent‘

创建链接

ansible web -m file -a ‘path=/data/bbb.jpg src=aaa.jpg state=link‘

template的用法

template模块?法和copy模块?法基本?致，它主要?于复制配置?件。

backup # 拷贝的同时也创建?个包含时间戳信息的备份?件，默认为no dest=  # ?标路径

force  # 设置为yes (默认)时，将覆盖远程同名?件。设置为no时，忽略同名?件的拷贝group      # 设置远程?件的所属组

owner # 设置远程?件的所有者

mode  # 设置远程?件的权限。使?数值表?时不能省略第?位，如0644。# 也可以使?‘u+rwx‘ or ‘u=rw,g=r,o=r‘等?式设置

src= # ansible控制器上Jinja2格式的模板所在位置，可以是相对或绝对路径validate       #在复制到?标主机后但放到?标位置之前，执?此选项指定的命令。

# ?般?于检查配置?件语法，语法正确则保存到?标位置。

# 如果要引??标?件名，则使?%s，下?的?例中的s%即表??标机器上的/etc/nginx/nginx.conf

 

虽然template模块可以按需求修改配置?件内容来复制模板到被控主机上，但是有?种情况它是不能解决的：不同被控节点所需的配置?件差异很?

例如在centos 6和centos 7上安装的nginx 配置文件内容相差?常?

这时就有必要在复制模板时挑选对应发?版的模板?件进?配对复制，例如要复制到 centos6上的源模板是nginx6.conf .j2，复制到cent os 7上的源模板是nginx7 .conf .j2。这种?为可以称之为"基于变量选择文件或模板"。

ansible centos -m template -a "src=/tmp/nginx.conf.j2 dest=/etc/nginx/nginx.conf mode=0770 owner=root group=root ba ckup=yes validate=‘nginx -t -c %s‘" -o -f 6

 

yaml语法和playbook写法

一个简单的playbook

playbook里不能有tab键

格式：

---

       - hosts:

         remote_users:

         tasks:
　　　　- name: 

                 shell:

notify:

         tasks: 
              - shell: 

         handlers:

 　　yaml文件以---开头，以表明这是一个yaml文件，就像xml文件在开头使用<?xml version="1.0" encoding="utf-8"?>宣称它是xml文件一样。但即使没有使用---开头，也不会有什么影响。

1. yaml中使用"#"作为注释符，可以注释整行，也可以注释行内从"#"开始的内容。
2. yaml中的字符串通常不用加任何引号，即使它包含了某些特殊字符。但有些情况下，必须加引号，最常见的是在引用变量的时候。具体见后文。
3. 关于布尔值的书写格式，即true/false的表达方式。其实playbook中的布尔值类型非常灵活，可分为两种情况：
4. 模块的参数：这时布尔值作为字符串被ansible解析。接受yes/on/1/true/no/off/0/false，这时被ansible解析。例如上面示例中的update_cache=yes。
5. 非模块的参数：这时布尔值被yaml解释器解析，完全遵循yaml语法。接受不区分大小写的true/yes/on/y/false/no/off/n。例如上面的gpgcheck=no和enabled=True。

　　建议遵循ansible的官方规范，模块的布尔参数采用yes/no，非模块的布尔参数采用True/False

列表

使用"- "(减号加一个或多个空格)作为列表项，也就是json中的数组。yaml的列表在playbook中极重要，必须得搞清楚它的写法。

例如：

- zhangsan

- lisi

- wangwu

还支持内联写法：使用中括号。

[zhangsan,lisi,wangwu]

字典

官方手册上这么称呼，其实就是key=value的另一种写法。使用"冒号+空格"分隔，即key: value。它一般当作列表项的属性。

1. ---

2.     - hosts: localhost              # 列表1

3.       remote_user: root

4.       tasks:

5.         - name: test1               # 子列表，下面是shell模块，是一个动作，所以定义为列表，只不过加了个name

6.           shell: echo /tmp/a.txt

7.           register: hi_var

8.         - debug: var=hi_var.stdout  # 调用模块，这是动作，所以也是列表

9.         - include: /tmp/nginx.yml   # 同样是动作，包含文件

10.                   - include: /tmp/mysql.yml

11.                   - copy:                     # 调用模块，定义为列表。但模块参数是虚拟性内容，应定义为字典而非列表

12.                       src: /etc/resolv.conf   # 模块参数1

13.                       dest: /tmp              # 模块参数2

14.            

15.               - hosts: 192.168.100.65           # 列表2

16.                 remote_user: root

17.                 vars:

18.                   nginx_port: 80                # 定义变量，是虚拟性的内容，应定义为字典而非列表

19.                   mysql_port: 3306

20.                 vars_files: 

21.                   - nginx_port.yml              # 无法写成key/value格式，且是实体文件，因此定义为列表

22.                 tasks:

23.                   - name: test2

24.                     shell: echo /tmp/a.txt

25.                     register: hi_var            # register是和最近一个动作绑定的

26.                   - debug: var=hi_var.stdout

分行写

playbook中有3种方式进行续行。

• 在"key: "的后面使用大于号。
• 在"key: "的后面使用竖线。这种方式可以像脚本一样写很多行语句。
• 多层缩进。

例如，下面的3中方法。

         - shell: echo 2 >>/tmp/test.txt
             creates=/tmp/haha.txt          # 比模块shell缩进更多

         - shell: >                         # 在"key: "后使用大于号
            echo 2 >>/tmp/test.txt
            creates=/tmp/haha.txt

         - shell: |                         # 指定多行命令
                       echo 2 >>/tmp/test.txt
                       echo 3 >>/tmp/test.txt
                       creates: /tmp/haha.txt?

 

向模块传递参数

模块的参数一般来说是key=value格式的，有3种传递的方式：

• 直接写在模块后，此时要求使用"key=value"格式。这是让ansible内部去解析字符串。因为可分行写，所以有多种写法。
• 写成字典型，即"key: value"。此时要求多层缩进。这是让yaml去解析字典。
• 使用内置属性args，然后多层缩进定义参数列表。这是让ansible明确指定用yaml来解析。

例如：

          - yum: name=unix2dos state=installed    # key=value直接传递

          - yum: 
            name: unxi2dos
            state: installed            # "key: value"字典格式传递

         - yum: 
           args:                               # 使用args传递
                      name: unix2dos
                      state:installed

 

playbook中什么时候使用引号

playbook中定义的都是些列表和字典。绝大多数时候，都不需要使用引号，但有两个特殊情况需要考虑使用引号。

出现大括号"{}"。

出现冒号加空格时": “

---
   - hosts: localhost
      tasks:
        - shell: ‘echo "{{inventory_hostname}}: haha"‘
            register: hello
        - debug: ‘msg="{{hello.stdout}}: heihei"‘

 

roles自动化批量安装

roles简介

roles意为角色，主要用于封装playbook实现复用性。在ansible中，roles通过文件的组织结构来展现。

对于一个role，它的文件组织结构如下图所示。

首先需要有一个roles目录。同时，在roles目录所在目录中，还要有一个playbook文件，此处为nginx.yml，nginx.yml文件是ansible-playbook需要执行的文件，在此文件中定义了角色，当执行到角色时，将会到roles中对应的角色目录中寻找相关文件。

roles目录中的子目录是即是各个role。例如，此处只有一个名为nginx的role，在role目录中，有几个固定名称的目录(如果没有则忽略)。在这些目录中，还要有一些固定名称的文件，除了固定名称的文件，其他的文件可以随意命名。以下是各个目录的含义：

• tasks目录：存放task列表。若role要生效，此目录必须要有一个主task文件main.yml，在main.yml中可以使用include包含同目录(即tasks)中的其他文件。
• handlers目录：存放handlers的目录，若要生效，则文件必须名为main.yml文件。
• files目录：在task中执行copy或script模块时，如果使用的是相对路径，则会到此目录中寻找对应的文件。
• templates目录：在task中执行template模块时，如果使用的是相对路径，则会到此目录中寻找对应的模块文件。
• vars目录：定义专属于该role的变量，如果要有var文件，则必须为main.yml文件。
• defaults目录：定义角色默认变量，角色默认变量的优先级最低，会被任意其他层次的同名变量覆盖。如果要有var文件，则必须为main.yml文件。
• meta目录：用于定义角色依赖，如果要有角色依赖关系，则文件必须为main.yml。

playbook中使用roles

vim mariadb.yaml
---
    - hosts: web
      roles: mariadb