Ansible的使用2

#### 一、Ansible变量

##### facts变量

> facts组件是Ansible用于采集被控节点机器的设备信息，比如IP地址、操作系统、以太网设备、mac 地址、时间/日期相关数据，硬件信息等

- setup模块
  - 用于获取所有facts信息

```shell
## 常用参数
    filter：用于过滤指定信息

# 通过setup模块查看所有facts信息
ansible web1 -m setup

# facts变量是一个由庞大的{}构成的键值字典
# 在{}中，有很多层级的嵌套。可以通过参数过滤出第一个层级的内容
ansible webservers -m setup -a "filter=ansible_all_ipv4_addresses"
ansible webservers -m setup -a "filter=ansible_bios_version"
ansible webservers -m setup -a "filter=ansible_memtotal_mb"
ansible webservers -m setup -a "filter=ansible_hostname"
ansible webservers -m setup -a "filter=ansible_mem*"
ansible web1 -m setup > facts.txt; awk -F: '/mb/{print}' facts.txt
```

- debug模块
  - 用于基本中使用facts变量打印变量信息
  - 默认有Gathering Facts任务，收集到Facts信息后可以使用该模块打印
  - 调用变量格式：{{ 变量名 }}

```shell
## 常用参数
    msg：打印变量值，格式为：{{ 变量名 }}
    var：打印变量值，格式为：变量名

- name: test debug
  hosts: webservers
  tasks:
    - name: test debug msg
      debug:
        msg: "hostname: {{ansible_hostname}}; mem: {{ansible_memtotal_mb}}"

- name: test debug
  hosts: webservers
  tasks:
    - name: test debug var
      debug:
        var: ansible_hostname, ansible_bios_version
```

##### 自定义变量

- 通过变量的使用可以让剧本更加灵活，多次运行剧本只需要调整对应变量名即可
- Ansible支持十几种变量定义方式
- Ansible变量定义的位置，下列变量优先级从低到高
  - role defaults ：roles defaults目录下的变量
  - inventory vars：inventory文件中定义的变量
  - inventory group_vars：inventory文件组的变量
  - inventory host_vars：inventory文件主机的变量
  - playbook group_vars：剧本中组的变量
  - playbook host_vars：剧本中主机的变量
  - host facts：事实变量
  - play vars：vars定义的变量
  - play vars_prompt：vars_prompt定义的变量
  - play vars_files：vars_files导入的变量
  - registered vars：注册变量
  - role and include vars：roles中单独定义的及导入的变量
  - block vars (only for tasks in block)：block中定义的变量
  - task vars (only for the task)：任务中定义的变量
  - extra vars (always win precedence)：命令行指定的变量

- Ansible变量定义的分类

  - 节点变量

  ```shell
  ## 在inventory文件中定义变量
  [webservers]
  web[1:2]
  
  [dbs]
  db1 username="natasha"   #定义属于db1主机的变量
  ……
  
  ## 定义变量在Playbook中的使用
  - name: create user with host vars
    hosts: db1
    tasks:
      - name: test host vars
        user:
          name: "{{ username }}"
          state: present
  ```

  - 组变量

  ```shell
  ## 在inventory文件中定义变量
  [webservers]
  web[1:2]
  
  ……
  
  #定义属于组的变量，:vars是固定格式
  [webservers:vars]
  username="natasha"
  
  ## 定义变量在Playbook中的使用
  - name: create user with group vars
    hosts: webservers
    tasks:
      - name: test group vars
        user:
          name: "{{ username }}"
          state: present
  ```

  - 剧本变量

  ```shell
  ## Playbook中定义变量
  - name: create user with play vars
    hosts: webservers
    vars:                     #剧本中定义变量
      username: "natasha"        #定义变量
      password: "123456"      #定义变量，数字作为密码必须用引号，表示字符串
    tasks:
      - name: test play vars
        user:
          name: "{{ username }}"
          password: "{{ password|password_hash('sha512')}}"
          state: present
  ```

  - 文件变量

```shell
# 变量文件创建一个fvars.yml文件
username: "natasha"
password: "654321"

## 定义变量文件在Playbook中的使用
- name: create user with vars files
  hosts: db1
  vars_files: fvars.yml     #调用定义变量的文件
  tasks:
    - name: test vars file
      user:
        name: "{{ username }}"
        password: "{{ password | password_hash('sha512')}}"
        state: present
```

##### 调用Facts变量信息收集

```shell
# 一定要开启Facts信息收集，gather_facts: yes
- name: copy file with facts
  hosts: webservers
  tasks:
    - name: use facts
      copy:
          #加\n换行，显示两条信息
        content: "hostname: {{ ansible_hostname }}\nbios_version: {{ ansible_bios_version }}"
        dest: /tmp/facts.txt

# 验证收集
ansible webservers -a "cat /tmp/facts.txt"
```

##### Ansible补充模块

- Firewalld模块
  - 该模块用于配置firewalld防火墙规则(默认拒绝访问)，对于明确允许的服务设置放行操作
  - 无论服务是否有名字，最终都基于TCP或UDP的端口，比如http服务基于TCP80端口。服务名和端口号对应关系的说明文件位于：/etc/services

```shell
## 常用参数
    port：声明放行端口与通信类型
    permanent：永久生效，但不会立即生效
    immediate：立即生效，临时生效
    state：enabled，放行；disabled拒绝

# 在webservers主机组安装nginx软件、启动服务
- name: test firewalld
  hosts: webservers
  tasks:
    - name: install nginx
      yum:
        name: nginx
        state: present

    - name: start nginx
      service:
        name: nginx
        state: started
        enabled: true
curl -I http://web1;curl -I http://web2        #测试访问

# 在webservers主机组安装firewalld防火墙软件、启动服务并访问测试
- name: test firewalld
  hosts: webservers
  tasks:
    ...
    - name: install firewalld
      yum:
        name: firewalld
        state: present

    - name: start firewalld
      service:
        name: firewalld
        state: started
        enabled: true

# 设置防火墙放行http访问
- name: test firewalld
  hosts: webservers
  tasks:
      ...
    - name: allow http
      firewalld:
        port: 80/tcp
        permanent: true
        immediate: true
        state: enabled
```

- Template模块
  - 用于上传具备特殊格式的文件(如文件中包含变量)，文件的语法叫Jinja2
  - 被控节点接收到文件时，模板文件中的变量名会被替换成具体的值
  - 相比于copy模块更加灵活

```shell
## 常用参数
    src：要上传的文件
    dest：目标文件路径

# 通过facts变量找到被控节点对应ip的变量
# 创建index.html.j2文件将变量对号入座，主机名对应hostname，ip地址对应address
Welcome to {{ ansible_hostname }} on {{ ansible_eth0.ipv4.address }}

- name: upload index
  hosts: webservers
  tasks:
    - name: create web index
      template:
        src: index.html.j2
        dest: /usr/share/nginx/html/index.html
```

#### 二、PlayBook进阶语法

##### 错误处理机制

> 当Playbook中有多个task时，其中某个任务执行过程中失败则后续任务将被终止执行
>
> 使用ignore_errors对可能出现错误的task进行忽略处理，可以作用于任务级也可作用于全局级

```shell
# 任务级忽略错误
- name: test error task
  hosts: webservers
  tasks:
    - name: start mysqld
      service: 
        name: mysqld
        state: started
        enabled: true
      ignore_errors: true       #任务级

    - name: touch file
      file:
        path: /tmp/mysql.txt
        state: touch

# 全局级忽略错误
- name: test error task
  hosts: webservers
  ignore_errors: true       #全局级
  tasks:
    - name: start mysqld
      service: 
        name: mysqld
        state: started
        enabled: true

    - name: touch file
      file:
        path: /tmp/mysql.txt
        state: touch
```

##### 触发执行任务

- 通过handlers定义一组任务
- 仅当某个任务触发（notify）handlers时才会执行相应任务
- 如果有多个notify触发执行handlers任务，也仅执行一次
- 仅当任务的执行状态为changed是handlers任务才执行
- handlers任务在所有其他任务都执行后才执行

```shell
# 获取nginx配置文件
- name: get nginx config file
  hosts: webservers
  tasks:
    - name: fetch nginx config file
      fetch:
        src: /etc/nginx/nginx.conf
        dest: ./
        flat: yes

# 编辑获取文件的服务端口，调整为facts变量
vim +39 nginx.conf
...
        listen       {{ http_port }} default_server;
        listen       [::]:{{http_port}} default_server;
...

# 修改nginx服务端口为8000并重启服务
- name: configure nginx
  hosts: webservers
  vars:
    http_port: 8000
  tasks:
    - name: upload nginx.conf
      template:
        src: nginx.conf
        dest: /etc/nginx/nginx.conf

    - name: restart nginx
      service:
        name: nginx
        state: restarted

######执行上条命令，修改文件并重启服务，第二次执行命令，未修改文件但重启服务
# 实现目标：只有修改了配置文件才会重启服务
# 加入handlers触发器
- name: configure nginx
  hosts: webservers
  vars:
    http_port: 80
  tasks:
    - name: upload nginx.conf
      template:
        src: nginx.conf
        dest: /etc/nginx/nginx.conf
      notify: restart nginx service     #任务状态为changed时触发指定任务执行

  handlers:
    - name: restart nginx service
      service:
        name: nginx
        state: restarted

####！！！！！注意notify与handlers的name要一致否则回报错
ERROR! The requested handler 'restart nginx service' was not found in either the main handlers list nor in the listening handlers list
```

##### when条件判断

- 满足条件时才执行任务，多任务使用and或or进行连接，表达逻辑关系
- when表达式中的变量不需要使用{{}}

```shell
## 常用操作符
    ==：相等
    !=：不等
    >：大于
    <：小于
    <=：小于等于
    >=：大于等于

# 单条件测试：当目标主机内存至少4G时安装MySQL软件
- name: test when
  hosts: dbs
  tasks:
    - name: install mysql soft
      yum:
        name: mysql-server
        state: present
      when:
        ansible_memtotal_mb >= 4096

# 多条件测试：当目标主机系统为Rocky8时发送文件，/etc/motd是用户登录时屏幕显示的内容
- name: test when
  hosts: webservers
  tasks:
    - name: modify /etc/motd
      copy: 
        src: motd
        dest: /etc/motd
      when: >   #多条件合并成1行
        ansible_distribution == "Rocky"
        and
        ansible_distribution_major_version == "8"
```

##### register注册变量

- register用于捕获和保存任务执行结果，它允许将其他任务的输出作为变量使用
- register也是一个关键字，可以将任务执行的结果赋值给指定的变量名称，并在后续任务中使用
- register可以捕获各种类型的输出，包括stdout、stderr、rc、changed等并与其他模块一起使用，例如"when"条件、"loop"循环等

```shell
# 在web1主机执行创建/tmp/reg1.txt，捕获命令执行结果并打印
- name: test register
  hosts: web1
  tasks:
    - name: create file
      file:
        path: /tmp/reg1.txt
        state: touch
      register: result

    - name: display result
      debug:
        msg: "{{result}}" 

# 在web1主机上执行任务，创建文件/tmp/abcdemo/abc。如果创建不成功，则通过debug输出create failed
- name: test register
  hosts: web1
  ignore_errors: true   #如果不忽略则任务2无法执行
  tasks:
    - name: create file
      file:
        path: /tmp/abcdemo/abc
        state: touch
      register: result

    - name: debug out
      debug:
        msg: "create failed"
      when: result.failed
```