不求甚解--详解ansible-playbook中roles的用法

伤心客  金牌会员 | 2024-12-10 14:46:19 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 817|帖子 817|积分 2451

前言

本文将具体先容ansible-playbook中roles的各种用法，它允许你将相关的使命、变量、处置惩罚器、文件和模板等聚集在一起，以便于在不同的项目中复用
环境准备

组件版本操作系统Ubuntu 22.04.4 LTSansible2.17.6基本用法

文件结构
  1. .
  2. ├── deploy.hosts
  3. ├── deploy.yaml
  4. └── roles
  5.     └── base
  6.         └── tasks
  7.             └── main.yaml
复制代码

  • deploy.hosts作为目标呆板的列表文件
    1. ▶ cat deploy.hosts
    2. 10.22.11.166
    复制代码
  • deploy.yaml作为入口文件
    1. ▶ cat deploy.yaml
    2. - name: deploy
    3.   hosts: all
    4.   remote_user: wilson
    5.   gather_facts: no
    6.   vars:
    7.     ansible_ssh_pass: '123456'
    8.     ansible_python_interpreter: /usr/bin/python3
    9.   roles:
    10.     - base
    复制代码

    • name：指定作业的名字：deploy
    • hosts：all代表deploy.hosts文件中所有的呆板（也可以指定呆板的分类信息）
    • remote_user：目标呆板的登录用户
    • gather_facts: 是否需要收罗目标呆板的基本数据，默认收罗。脚本指定的是不收罗，为了进步执行速度
    • vars.ansible_ssh_oass：目标呆板登录用户的密码
    • vars.ansible_python_interpreter：目标呆板python3的路径
    • roles：指定本次作业所使用的角色 base

  • roles目录作为ansible-playbook中一系列作业使命的聚集，其中一个聚集的名字叫做base

    • tasks中的main.yaml作为base的入口文件
      1. ▶ cat roles/base/tasks/main.yaml
      2. - name: first
      3.   command: echo 'hello world'
      复制代码

      • base当前只有1个使命，就是登录到目标呆板，执行hello world


运行
  1. ▶ ansible-playbook -i deploy.hosts deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : first] **********************************************************************************************
  6. changed: [10.22.11.166]
  8. PLAY RECAP *******************************************************************************************************
  9. 10.22.11.166               : ok=1    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
在屏幕上显示执行结果

需要改造roles/base/tasks/main.yaml
  1. ▶ cat roles/base/tasks/main.yaml
  2. - name: first
  3.   command: echo 'hello world'  register: display_result- name: display  debug:    msg: "{{ display_result }}"
复制代码
把结果放入变量display_result，然后通过模版语言打印出来，而且是json格式的
运行：
  1. ▶ ansible-playbook -i deploy.hosts deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : first] **********************************************************************************************
  6. changed: [10.22.11.166]
  8. TASK [base : display] ********************************************************************************************
  9. ok: [10.22.11.166] => {
  10.     "msg": {
  11.         "changed": true,
  12.         "cmd": [
  13.             "echo",
  14.             "hello world"
  15.         ],
  16.         "delta": "0:00:00.002740",
  17.         "end": "2024-11-19 07:22:22.226036",
  18.         "failed": false,
  19.         "msg": "",
  20.         "rc": 0,
  21.         "start": "2024-11-19 07:22:22.223296",
  22.         "stderr": "",
  23.         "stderr_lines": [],
  24.         "stdout": "hello world",
  25.         "stdout_lines": [
  26.             "hello world"
  27.         ]
  28.     }
  29. }
  31. PLAY RECAP *******************************************************************************************************
  32. 10.22.11.166               : ok=2    changed=1    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
引用环境变量

将操作系统的环境变量传入，可以通过lookup来引用，好比：要使用PATH，可以通过lookup('env', 'PATH')
改造roles/base/tasks/main.yaml
  1. ▶ cat roles/base/tasks/main.yaml
  2. - name: first
  3.   debug:
  4.     msg: "{{ lookup('env', 'PATH') }}"
复制代码
运行：
  1. ▶ ansible-playbook -i deploy.hosts deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : first] **********************************************************************************************
  6. ok: [10.22.11.166] => {
  7.     "msg": "/home/wilson/.local/bin:/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin:/usr/games:/usr/local/games:/snap/bin:/snap/bin:/usr/local/go/bin:/usr/local/go/bin"
  8. }
  10. PLAY RECAP *******************************************************************************************************
  11. 10.22.11.166               : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
使用ansible变量

这里的ansible变量，其中一部门ansible默认的变量，一部门是ansible运行的时候，会默认去收罗目标呆板的基本信息，好比操作系统、cpu、内存、磁盘等等的基本信息
部门内置变量

变量名描述inventory_hostname当前使命执行的主机名（来自 Inventory 文件）ansible_facts包罗所有收集到的主机事实（facts）hostvars所有主机变量的聚集，包罗当前和其他主机收罗目标呆板的基本信息

需要把之前收罗ansible基本信息的开关打开gather_facts: yes，打开之后会牺牲运行速度
改造roles/base/tasks/main.yaml
  1. - name: first
  2.   debug:
  3.     msg: "{{ hostvars }}"
复制代码
运行：
由于数据量太大，只展示部门，而且json格式，可以直接拿想要的值
  1. ▶ ansible-playbook -i deploy.hosts deploy.yaml
  3. PLAY [deploy] ******************************************************************
  5. TASK [Gathering Facts] *********************************************************
  6. ok: [10.22.11.166]
  8. TASK [base : first] ************************************************************
  9. ok: [10.22.11.166] => {
  10.     "msg": {
  11.         "10.22.11.166": {
  12.             "ansible_all_ipv4_addresses": [
  13.                 "10.22.11.166"
  14.             ],
  15.             "ansible_all_ipv6_addresses": [
  16.                 "fe80::a00:27ff:fef6:82c4"
  17.             ],
  18.             "ansible_apparmor": {
  19.                 "status": "enabled"
  20.             },
  21.             "ansible_architecture": "x86_64",
  22.             "ansible_bios_date": "12/01/2006",
  23.             "ansible_bios_vendor": "innotek GmbH",
  24.             "ansible_bios_version": "VirtualBox",
  25.             "ansible_board_asset_tag": "NA",
  26.             "ansible_board_name": "VirtualBox",
  27.             "ansible_board_serial": "NA",
  28.             "ansible_board_vendor": "Oracle Corporation",
  29.             ...
  30.             "inventory_dir": "/home/wilson/workspace/ansible",
  31.             "inventory_file": "/home/wilson/workspace/ansible/deploy.hosts",
  32.             "inventory_hostname": "10.22.11.166",
  33.             "inventory_hostname_short": "10.22.11.166",
  34.             "module_setup": true,
  35.             "playbook_dir": "/home/wilson/workspace/ansible"
  36.         }
  37.     }
  38. }
  40. PLAY RECAP *********************************************************************
  41. 10.22.11.166               : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
是否收罗目标的基本信息

上面已经演示过，只需要gather_facts: yes即可
从命令行传入变量

ansible-playbook可以通过-e传入变量使用
  1. ▶ cat roles/base/tasks/main.yaml
  2. - name: first
  3.   debug:
  4.     msg: "{{ app_name }} - {{ app_version }}"
复制代码
运行：
  1. ▶ ansible-playbook -i deploy.hosts -e "app_name=prom app_version=1.0" deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [Gathering Facts] *******************************************************************************************
  6. ok: [10.22.11.166]
  8. TASK [base : first] **********************************************************************************************
  9. ok: [10.22.11.166] => {
  10.     "msg": "prom - 1.0"
  11. }
  13. PLAY RECAP *******************************************************************************************************
  14. 10.22.11.166               : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
动态选择host

1）将主机分组
修改deploy.hosts文件
  1. ▶ cat deploy.hosts
  2. [ga]
  3. 10.22.11.166
  5. [gb]
  6. 10.22.11.166
  7. 127.0.0.1
复制代码
2）改造入口文件
  1. ▶ cat deploy.yaml
  2. - name: deploy
  3.   hosts: '{{h}}'
  4.   remote_user: wilson
  5.   gather_facts: no
  6.   vars:
  7.     ansible_ssh_pass: '123456'
  8.     ansible_python_interpreter: /usr/bin/python3
  9.   roles:
  10.     - base
复制代码
将hosts改在成为'{{h}}'，通过传入h变量来动态定义
3）运行
指定h为ga
  1. ▶ ansible-playbook -i deploy.hosts -e "h=ga" deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : first] **********************************************************************************************
  6. ok: [10.22.11.166] => {
  7.     "msg": "hello world"
  8. }
  10. PLAY RECAP *******************************************************************************************************
  11. 10.22.11.166               : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
指定h为gb
  1. ▶ ansible-playbook -i deploy.hosts -e "h=gb" deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : first] **********************************************************************************************
  6. ok: [10.22.11.166] => {
  7.     "msg": "hello world"
  8. }
  9. ok: [127.0.0.1] => {
  10.     "msg": "hello world"
  11. }
  13. PLAY RECAP *******************************************************************************************************
  14. 10.22.11.166               : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
  15. 127.0.0.1                  : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
条件选择when
  1. ▶ cat roles/base/tasks/main.yaml
  2. - name: first
  3.   debug:
  4.     msg: "version 1"
  5.   when: version == '1'
  7. - name: second
  8.   debug:
  9.     msg: "version 2"
  10.   when: version == '2'
复制代码
定义暂时变量

通过-e传入的变量来产生暂时变量
  1. - name: first
  2.   set_fact:
  3.     tag: "hello-{{ version }}"
  5. - name: second
  6.   debug:
  7.     msg: "{{ tag }}"
复制代码
运行：
  1. ▶ ansible-playbook -i deploy.hosts -e "version=2" deploy.yaml
  3. ...
  5. TASK [base : second] *********************************************************************************************
  6. ok: [10.22.11.166] => {
  7.     "msg": "hello-2"
  8. }
  10. ...
复制代码
调用多个role

1）新增role： advance
  1. .
  2. ├── deploy.hosts
  3. ├── deploy.yaml
  4. └── roles
  5.     ├── advance
  6.     │   └── tasks
  7.     │       └── main.yaml
  8.     └── base
  9.         └── tasks
  10.             └── main.yaml
复制代码
2）直接在入口文件deploy.yaml引用
  1. .
  2. ├── deploy.hosts
  3. ├── deploy.yaml
  4. └── roles
  5.     ├── advance
  6.     │   └── tasks
  7.     │       └── main.yaml
  8.     └── base
  9.         └── tasks
  10.             └── main.yaml
复制代码
运行：
  1. ▶ ansible-playbook -i deploy.hosts -e "version=2" deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : first] **********************************************************************************************
  6. ok: [10.22.11.166]
  8. TASK [base : second] *********************************************************************************************
  9. ok: [10.22.11.166] => {
  10.     "msg": "hello-2"
  11. }
  13. TASK [advance : new-first] ***************************************************************************************
  14. ok: [10.22.11.166] => {
  15.     "msg": "new hello world"
  16. }
  18. PLAY RECAP *******************************************************************************************************
  19. 10.22.11.166               : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码
3）在roles base中引用 advance
  1. ▶ cat deploy.yaml
  2. - name: deploy
  3.   hosts: all
  4.   remote_user: wilson
  5.   gather_facts: no
  6.   vars:
  7.     ansible_ssh_pass: '123456'
  8.     ansible_python_interpreter: /usr/bin/python3
  9.   roles:
  10.     - base
复制代码
  1. ▶ cat roles/base/tasks/main.yaml
  2. - name: base first
  3.   debug:
  4.     msg: "base {{ version }}"
  6. - name: base second
  7.   include_role:
  8.     name: advance
  9.   vars:
  10.     role_pipe_from_base: "hello world from base"
  12. - name: base third
  13.   debug:
  14.     msg: "{{ role_pipe_from_advance }}"
复制代码
  1. ▶ cat roles/advance/tasks/main.yaml
  2. - name: advance first
  3.   debug:
  4.     msg: "advance {{ version }}"
  6. - name: advance second
  7.   debug:
  8.     msg: "{{ role_pipe_from_base }}"
  10. - name: advance third
  11.   set_fact:
  12.     role_pipe_from_advance: "hello world from advance"
复制代码
运行：
  1. ▶ ansible-playbook -i deploy.hosts -e "version=2" deploy.yaml
  3. PLAY [deploy] ****************************************************************************************************
  5. TASK [base : base first] *****************************************************************************************
  6. ok: [10.22.11.166] => {
  7.     "msg": "base 2"
  8. }
  10. TASK [base second] ***********************************************************************************************
  11. included: advance for 10.22.11.166
  13. TASK [advance : advance first] ***********************************************************************************
  14. ok: [10.22.11.166] => {
  15.     "msg": "advance 2"
  16. }
  18. TASK [advance : advance second] **********************************************************************************
  19. ok: [10.22.11.166] => {
  20.     "msg": "hello world from base"
  21. }
  23. TASK [advance : advance third] ***********************************************************************************
  24. ok: [10.22.11.166]
  26. TASK [base : base third] *****************************************************************************************
  27. ok: [10.22.11.166] => {
  28.     "msg": "hello world from advance"
  29. }
  31. PLAY RECAP *******************************************************************************************************
  32. 10.22.11.166               : ok=6    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
复制代码

这个例子呈现了：

  • 传入变量version是共用的
  • 如何在role通报参数
  • 执行过程中定义的暂时变量role_pipe_from_advance可以跨role持续
  • 多role执行是串行的
小结


  • 联系我，做深入的交换

至此，本文结束
在下才疏学浅，有撒汤漏水的，请各位不吝见教...

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

伤心客

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表