[内容] Ansible 执行脚本 Playbook 的循环

注意:

在使用 Ansible Playbook 之前,要先安装 Ansible、添加被 Ansible 管理的主机,并且需要 root 权限

正文:

内容一:在 Ansible Playbook 里使用循环

1.1 在 Ansible Playbook 里使用简单的单循环

# vim test.yml

创建以下内容:

---
- name: test
  hosts: all
  tasks:
  - name: install rpms
    yum:
    - php
    - nginx
    - mariadb


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test,
3) 在所有服务器上执行,
4) 安装 php、nginx 和 mariadb,
的 Playbook 为例

1.2 在 Ansible Playbook 里使用数组实现单组循环

# vim test.yml

创建以下内容:

---
- name: test
  hosts: all
  tasks:
  - user:
      name: "{{item.name}}"
      group: "{{item.group}}"
      password: "{{'1' | password_hash('sha512',mysecretsalt)}}"
    with_items:
    - {name: "a1", group: "users"}
    - {name: "a2", group: "mail"}
    - {name: "a3", group: "wheel"}
    - {name: "a4", group: "root"}


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test
3) 在所有服务器上执行
4) 创建 1 个循环组的用户
的 Playbook 为例

1.3 在 Ansible Playbook 里使用变量实现单组循环

# vim test.yml

创建以下内容:

---
- name: test
  hosts: all
  vars:
    issue_all
    - issue_name: a
      issue_cont: 1
    - issue_name: b
      issue_cont: 2
    - issue_name: c
      issue_cont: 3
    - issue_name: d
      issue_cont: 4
    - issue_name: e
      issue_cont: 5
  tasks:
  - name: issue
    shell: "echo {{ item.issue_name }}={{ item.issue_cont }}"
    loop: "{{ issue_all }}"


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test
3) 在所有服务器上执行
4) 输出 1 个循环组的信息
的 Playbook 为例

1.4 在 Ansible Playbook 里使用数组实现多组循环

# vim test.yml

创建以下内容:

---
- name: test
  hosts: all
  remote_user: root
  vars:
    name: [a, b, c]
    id: [1, 2, 3]
  tasks:
  - shell: echo {{item}}
    with_nested:
    - "{{name}}"
    - "{{id}}"


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test
3) 在所有服务器上执行
4) 循环输出两个循环组的信息(本案例会输出信息:a1、a2、a3、b1、b2、b3、c1、c2、c3)
的 Playbook 为例

内容二:在 JSON 文档上使用单组循环

2.1 在 JSON 文档上使用单组循环

# vim hosts.j2

创建以下内容:

{% for host in groups['all'] %}
{{ hostvars[host]['ansible_facts']['hostname'] }} {{ hostvars[host]['ansible_facts']['default_ipv4']['address'] }}
{% endfor %}

(补充:这里以创建所有服务器名和 IP 地址对应的关系,名为 hosts.j2 的 json 文件为例)

2.2 使用 JSON 文档的 Ansible Playbook

# vim test.yml

添加以下内容:

......
  - name: template
    template:
      src: hosts.j2
      dest: /root/hosts.txt
......

(补充:这里以在 test.yml 中,使用 hosts.j2 创建 /root/hosts.txt 为例)

[内容] Ansible 事实变量 (Ansible 内部变量)

注意:

在使用 Ansible 事实变量之前,要先安装 Ansible、添加被 Ansible 管理的主机,并且需要 root 权限

正文:

内容一: 在命令行使用事实变量

1.1 显示所有事实变量

# ansible all -m setup

(补充:这里以显示所有服务器上的所有事实变量为例)

1.2 显示某一个事实变量

# ansible all -m setup -a filter=*hostname*

(补充:这里以显示所有服务器上的 hostname 事实变量为例)

内容二:在 Playbook 使用事实变量的方法

2.1 案例一:在 Playbook 使用事实变量里的信息

# vim test.yml

创建以下内容:

---
- name: test
  hosts: all
  vars:
  - server_name: IP_ADDRESS
    server_cont: "{{ ansible_default_ipv4.address }}"
  - server_name: HOST_NAME
    server_cont: "{{ ansible_hostname }}"
  tasks:
......

或者:

---
- name: test
  hosts: all
  vars:
  - server_name: IP_ADDRESS
    server_cont: "{{ ansible_facts['default_ipv4']['address'] }}"
  - server_name: HOST_NAME
    server_cont: "{{ ansible_facts['hostname'] }}"
  tasks:
......


补充:
这里以在 test.yml 中:
1) 创建一个名为 test,
2) 在所有服务器上执行,
3) 创建名为 IP_ADDRESS 的 IP 地址事实变量和名为 HOST_NAME 的服务器名称的事实变量,
的 Playbook 为例

2.2 案例二:在 Playbook 使用事实变量作为条件判断

# vim test.yml

创建以下内容:

......    
    when:
        - ansible_facts['os_family'] in ["RedHat"]
        - ansible_facts['distribution_major_version'] in ["9"]
        - ansible_facts['userspace_architecture'] == "x86_64"

(补充:这里以在 test.yml 中,当满足 os_family 是 RedHat、distribution_major_version 是 9,userspace_architecture 是 x86_64 时才执行前面的内容为例)

内容三:在 JSON 文档上使用事实变量

# vim index.html.j2

创建以下内容:

{{ ansible_hostname }} {{ ansible_default_ipv4.address }}

或者:

{{ ansible_facts['hostname'] }} {{ ansible_facts['default_ipv4']['address'] }}

(补充:这里以创建 1 个名称为 index.html.j2,包含服务器名称的事实变量和服务器 IP 地址的事实变量的 JSON 文件为例)

补充: Ansible 在 Playbook 里关闭事实收集的方法

# vim test.yml

创建以下内容:

---
- name: test
  hosts: all
  gather_facts: false
  tasks:
......

(补充:这里以在 test.yml 中,创建 1 个名称为 test,在所有服务器上取消事实变量的 playbook 为例)

参考文献:

https://www.redhat.com/sysadmin/playing-ansible-facts

[内容] Ansible 变量的优先级

第 1 优先级

全局范围的变量(例如:执行临时命令时指定的变量)

第 2 优先级

Playbook 里的变量。

第 3 优先级

主机范围里的变量(例如:清单中的服务器或服务器组)

(补充:清单中的服务器优先级高于清单中的服务器组)

[内容] Ansible 魔法变量

注意:

在使用 Ansible 魔法变量之前,要先安装 Ansible、添加被 Ansible 管理的主机,并且需要 root 权限

正文:

内容一:Ansible 常用魔法变量

1) inventory_hostname

显示服务器名


2) group_names

显示服务器所在组


3) groups

显示服务器所在组,以及组里的所有服务器


4) hostvars

显示所有相关信息

内容二:Ansible 魔法变量的使用

2.1 在命令行使用魔法变量

2.1.1 魔法变量的使用格式
# ansible <Ansible server name or Ansible group name> -m debug -a var=<Ansible magic variable name>
2.1.2 魔法变量的使用案例
2.1.2.1 显示所有魔法变量
# ansible -m debug -a var=hostvars all

(补充:这里以显示所有服务器上的所有魔法变量为例)

2.1.2.2 显示某 1 个魔法变量
# ansible -m debug -a var=inventory_hostname all

(补充:这里以显示所有服务器上的 inventory_hostname 魔法变量为例)

2.2 在 Ansible Playbook 使用魔法变量

2.2.1 在 Ansible Playbook 的变量中使用魔法变量
# vim test.yml
---
- name: test
  hosts: all
  vars:
    server_all:
    - server_name: IP_ADDRESS
      server_cont: "{{ ansible_default_ipv4.address }}"
    - server_name: HOST_NAME
      server_cont: "{{ inventory_hostname }}"
  tasks:
......


补充:这里以
1) 在 test.yml 中,
2) 创建 1 个名为 test,
3) 在所有服务器上执行,
4) 创建名为 server_all 的变量数组,
5) 里面有名为 IP_ADDRESS 的 IP 地址事实变量和名为 HOST_NAME 的服务器名称版本事实变量,
的 playbook 为例

2.2.2 在 Ansible Playbook 的条件判断 when 中使用魔法变量
2.2.2.1 案例一:使用 1 个魔法变量
# vim test.yml

添加以下内容:

......
when: "'test' in group_names"
......

(补充:这里以在 test.yml 中, test 为服务器的所属组为条件判断为例)

2.2.2.2 案例二:使用 2 个魔法变量
# vim test.yml

添加以下内容:

......
when: inventory_hostname in groups.test
......

(补充:这里以在 test.yml 中,服务器名在 test 组中为条件判断为例)

2.3 在 JSON 文档上使用魔法变量

2.3.1 在 JSON 文档上使用魔法变量
# vim hosts.j2

创建以下内容:

{% for host in groups['all'] %}
{{ hostvars[host]['ansible_facts']['hostname'] }} {{ hostvars[host]['ansible_facts']['default_ipv4']['address'] }}
{% endfor %}

(补充:这里以创建所有服务器名和 IP 地址对应的关系,名为 hosts.j2 的 json 文件为例)

2.3.2 使用 JSON 文档的 Playbook
# vim test.yml

添加以下内容:

......
  - name: template
    template:
      src: hosts.j2
      dest: /root/hosts.txt
......

(补充:这里以在 test.yml 中,使用 hosts.j2 创建 /root/hosts.txt 为例)

[内容] Ansible 自定义变量

注意:

在使用 Ansible 自定义变量之前,要先安装 Ansible、添加被 Ansible 管理的主机,并且需要 root 权限

正文:

内容一:Ansible 全局变量的使用

# ansible dev -m shell -a whoami -e ansible_user=root -e ansible_password=redhat

(补充:这里以 root 是管理被管理服务器所使用的用户,redhat 是这个用户的密码为例)

内容二:Ansible 服务器列表变量的设置

2.1 给某台服务器设置变量的案例

# vim host

创建以下内容:

[web]
192.168.1.1 ansible_password=root


补充:这里以
1) 在 host 文件里
2) 设置 192.168.1.1 的 Ansible 密码是 root(当它被 Ansible 操作时需要输入此密码)
为例

2.2 给某 1 个组设置变量的案例

# vim host

创建以下内容:

[web]
192.168.1.1
192.168.1.2 
192.168.1.3 

[web:vars]
ansible_user=root
ansible_password=root
......


补充:这里以
1) 在 host 文件里
2) 设置 web 组的 Ansible 用户是 root,密码是 root(当它们被 Ansible 操作时需要输入此密码)
为例

2.3 给所有服务器设置变量的案例

# vim host

创建以下内容:

[web]
192.168.1.1
192.168.1.2
192.168.1.3

[db]
192.168.1.4
192.168.1.5
192.168.1.6

[all:vars]
ansible_user=root
ansible_password=root
......


补充:这里以
1) 在 host 文件里
2) 设置所有服务器的 Ansible 用户是 root,密码是 root(当它们被 Ansible 操作时需要输入此密码)
为例

内容三:Ansible Playbook 变量的设置

3.1 Ansible Playbook 直接设置变量的案例

# vim test.yaml

创建以下内容:

---
- name: test
  hosts: all
  vars:
    user: tom
    home: /home/joe
  tasks:
  - name: Add a user
    user:
      name: "{{ user }}"
      comment: name is {{ user }}
......


补充:这里以
1) 在 test.yml 中
2) 创建一个名为 test
3) 在所有服务器上执行
4) 设置 user 变量为 tom
5) home 变量为 /home/joe
6) 创建名为 user 注释内容为 user 的用户
的 playbook 为例

3.2 Ansible Playbook 直接设置数组变量的案例

# vim test.yaml

创建以下内容:

---
- name: test
  hosts: all
  vars:
  - user1:
      a_name: zhang
      b_name: san
  - user2:
      a_name: li
      b_name: si
  tasks:
  - name: Add a user
    user:
      name: "{{ users.user1.a_name }}{{ users.user1.b_name }}"
......


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test
3) 在所有服务器上执行
4) 导入了变量文件 vars.yaml
5) 使用其中的变量 users.user1.a_name 和 users.user1.b_name
的 playbook 为例

3.3 Ansible Playbook 设置变量文件的案例

3.3.1 创建变量文件
# vim vars.yaml

创建以下内容:

user: tom
home: /home/joe

(补充:这里以在 vars.ymal 中添加变量 user 值为 tom,变量 home 值为 /home/joe 为例)

3.3.2 导入变量文件
# vim test.yaml

创建以下内容:

---
- name: test
  hosts: all
  vars_files:
    - vars.yaml
  tasks:
  - name: Add a user
    user:
      name: "{{ user }}"
      comment: name is {{ user }}
......


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test
3) 在所有服务器上执行
4) 导入了变量文件 vars.yaml
5) 使用其中的变量 user 和 home
的 playbook 为例

3.4 Ansible Playbook 设置数组变量文件的案例

3.4.1 创建变量文件

# vim vars.yaml

创建以下内容:

users:
  user1:
    a_name: san
    b_name: zhang
    c_name: /home/zhangsan
  user2:
    a_name: si
    b_name: li
    c_name: /home/lisi

(补充:这里以在 vars.ymal 中添加 user1 和 user2 两组数组变量为例)

3.4.2 导入变量文件

# vim test.yaml

创建以下内容:

---
- name:
  hosts:
  vars_files:
  - vars.yaml
  tasks:
  - name: Add a user
    user:
      name: "{{ users.user1.a_name }}{{ users.user1.b_name }}"
......


补充:这里以
1) 在 test.yml 中
2) 创建 1 个名为 test
3) 在所有服务器上执行
4) 导入了变量文件 vars.yaml
5) 使用其中的变量 users.user1.a_name 和 users.user1.b_name
的 playbook 为例