Ansible最佳实践之Playbook高级循环任务如何操作
admin
2024-03-14 11:22:19
0次

写在前面


  • 今天和小伙伴分享一些ansible剧本中数据迭代的笔记
  • 博文内容比较简单
  • 主要介绍的常见的迭代对比
  • 使用过滤器和查找插件在复杂数据结构上实施迭代循环
  • 食用方式:了解Ansible基础语法
  • 理解不足小伙伴帮忙指正

傍晚时分,你坐在屋檐下,看着天慢慢地黑下去,心里寂寞而凄凉,感到自己的生命被剥夺了。当时我是个年轻人,但我害怕这样生活下去,衰老下去。在我看来,这是比死亡更可怕的事。--------王小波


循环和查找插件

Ansible 在 2.5 中引入了loop关键字。以前任务迭代通过使用with_开头并以查找的名称结尾的关键字的方法。与 loop 等效的是 with_list,设计用于在简单的扁平列表中进行迭代,对于简单的列表来讲,loop 是最佳语法。

以下三种语法具有相同的结果,其中第一个使用的loop是首选:

$ cat loop_demo.yaml
---
- name: loop Playhosts: serveragather_facts: novars:- mylist:- li- rui- longtasks:- name: using loopdebug: msg={{ item }}loop: "{{ mylist }}"- name: using with_listdebug: msg={{ item }}with_list: "{{ mylist }}"- name: using lookup plugindebug: msg={{ item }}loop: "{{ lookup('list',mylist) }}"
$

运行剧本是一样的效果,这里第三种方式通过,lookup插件的的方式实现的,lookup 插件是 Jinja2 模板引擎的 Ansible 扩展。通过插件使 Ansible 能够使用外部来源的数据,我们这里使用lookup来将一个数据转化为list

$ ansible-playbook  loop_demo.yamlPLAY [loop Play] *********************************************************************************************TASK [using loop] ********************************************************************************************
ok: [servera] => (item=li) => {"msg": "li"
}
ok: [servera] => (item=rui) => {"msg": "rui"
}
ok: [servera] => (item=long) => {"msg": "long"
}TASK [using with_list] ***************************************************************************************
ok: [servera] => (item=li) => {"msg": "li"
}
ok: [servera] => (item=rui) => {"msg": "rui"
}
ok: [servera] => (item=long) => {"msg": "long"
}TASK [using lookup plugin] ***********************************************************************************
ok: [servera] => (item=li) => {"msg": "li"
}
ok: [servera] => (item=rui) => {"msg": "rui"
}
ok: [servera] => (item=long) => {"msg": "long"
}PLAY RECAP ***************************************************************************************************
servera                    : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0$

使用 loop 关键字替代 with_* 样式的循环具有以下优点:

  • 无需记住或查找 with_* 样式关键字来满足当前迭代场景。
  • 专注于学习 Ansible 中提供的插件和过滤器,适用性比单纯的迭代更广泛。
  • 可以通过ansible-doc -t lookup命令访问查找插件文档,结合插件文档实现复杂遍历

使用loop关键字和dict插件替换"with_dict"关键字

---
- hosts: testBremote_user: rootgather_facts: novars:users:alice: femalebob: maletasks:- debug:msg: "{{item.key}} is {{item.value}}"loop: "{{ lookup('dict',users) }}"

在2.6版本的官网手册中,官方开始推荐使用 loop加filter 的方式来替代"loop加lookup"的方式,

---
- hosts: testBremote_user: rootgather_facts: novars:users:alice: femalebob: maletasks:- debug:msg: "{{item.key}} is {{item.value}}"loop: "{{ users | dict2items }}"

loop 方式还提供了 loop_control属性

可以用于控制循环的行为,添加索引之类,比如,使用loop_control的index_var选项,就能在遍历列表时,将元素对应的索引写入到指定的变量中,除了index_var选项,loop_control还有一些其他的选项可用,此处我们就来总结一下这些选项。

pause选项能够让我们设置每次循环之后的暂停时间,以秒为单位,换句话说就是设置每次循环之间的间隔时间,示例如下

迭代场景示例

在列表的列表上迭代

对于需要多级迭代的嵌套数据,使用传统的循环方式,往往获取不到子数据,即不能实现数据的扁平化处理。

---
- name: loop Playhosts: serveragather_facts: novars:- mylist:- ['l','i']- rui- longtasks:- name: using loopdebug: msg={{ item }}loop: "{{ mylist }}"- name: using with_listdebug: msg={{ item }}with_list: "{{ mylist }}"- name: using lookup plugindebug: msg={{ item }}loop: "{{ lookup('list',mylist) }}"

上面迭代的数据为一个嵌套的list,使用前面所讲的迭代方式不能对嵌套的子数组进行迭代。

三种不同方式的测试,都不能做的扁平化的迭代

$ ansible-playbook  loop_demo.yamlPLAY [loop Play] *********************************************************************************************TASK [using loop] ********************************************************************************************
ok: [servera] => (item=['l', 'i']) => {"msg": ["l","i"]
}
ok: [servera] => (item=rui) => {"msg": "rui"
}
ok: [servera] => (item=long) => {"msg": "long"
}TASK [using with_list] ***************************************************************************************
ok: [servera] => (item=['l', 'i']) => {"msg": ["l","i"]
}
ok: [servera] => (item=rui) => {"msg": "rui"
}
ok: [servera] => (item=long) => {"msg": "long"
}TASK [using lookup plugin] ***********************************************************************************
ok: [servera] => (item=['l', 'i']) => {"msg": ["l","i"]
}
ok: [servera] => (item=rui) => {"msg": "rui"
}
ok: [servera] => (item=long) => {"msg": "long"
}PLAY RECAP ***************************************************************************************************
servera                    : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

这个时候,我们可以使用 with_items 关键字来迭代复杂的列表,实现列表数据的扁平化处理

$ cat loop_demos.yaml
---
- name: loop Playhosts: serveragather_facts: notasks:- name: using with_listdebug:msg: "{{ item }}"with_items:- [ 1,2,4 ]- [ r,u ]
$ ansible-playbook  loop_demos.yamlPLAY [loop Play] *********************************************************************************************TASK [using with_list] ***************************************************************************************
ok: [servera] => (item=1) => {"msg": 1
}
ok: [servera] => (item=2) => {"msg": 2
}
ok: [servera] => (item=4) => {"msg": 4
}
ok: [servera] => (item=r) => {"msg": "r"
}
ok: [servera] => (item=u) => {"msg": "u"
}PLAY RECAP ***************************************************************************************************
servera                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

获取序列

有时候希望在剧本里获取一些序列,可以通过 whit_sequence 关键字实现

$ cat loop_demo_sq.yaml
---
- name: liruilong demohosts: serveragather_facts: ntasks:- name: test whit_sequencedebug: msg={{ item }}with_sequence:start=1end=5stride=1
$ ansible-playbook  loop_demo_sq.yamlPLAY [liruilong demo] ****************************************************************************************TASK [test whit_sequence] ************************************************************************************
ok: [servera] => (item=1) => {"msg": "1"
}
ok: [servera] => (item=2) => {"msg": "2"
}
ok: [servera] => (item=3) => {"msg": "3"
}
ok: [servera] => (item=4) => {"msg": "4"
}
ok: [servera] => (item=5) => {"msg": "5"
}PLAY RECAP ***************************************************************************************************
servera                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

flatten 代替 with_items

若希望重构旧的剧本里的 with_items 任务以使用 loop 关键字,可使用 flatten 过滤器。

$ cat loop_demos.yaml
---
- name: loop Playhosts: serveragather_facts: notasks:- name: using with_listdebug:msg: "{{ item }}"#with_items:loop:- [ 1,2,4,[3,4,5,[6]] ]- [ r,u ]
$ ansible-playbook loop_demos.yamlPLAY [loop Play] *********************************************************************************************
TASK [using with_list] ***************************************************************************************
ok: [servera] => (item=[1, 2, 4, [3, 4, 5, [6]]]) => {"msg": [1,2,4,[3,4,5,[6]]]
}
ok: [servera] => (item=['r', 'u']) => {"msg": ["r","u"]
}PLAY RECAP ***************************************************************************************************
servera                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
$
  • flatten 过滤器将以递归方式搜索嵌入式列表,并从发现的值创建一个列表。

  • flatten 过滤器接受 levels 参数,用于指定搜索嵌入式列表的整数的级别数,levels = 1 与 with_items 隐式进行的相同的一级扁平化。

$ cat loop_demos.yaml
---
- name: loop Playhosts: serveragather_facts: notasks:- name: using with_listdebug:msg: "{{ item }}"loop: "{{ numList | flatten(levels=3) }}"vars:numList:- [ 1,2,4,[3,4,5,[6]] ]- [ r,u ]$

执行测试

$ ansible-playbook loop_demos.yamlPLAY [loop Play] *********************************************************************************************TASK [using with_list] ***************************************************************************************
ok: [servera] => (item=1) => {"msg": 1
}
ok: [servera] => (item=2) => {"msg": 2
}
ok: [servera] => (item=4) => {"msg": 4
}
ok: [servera] => (item=3) => {"msg": 3
}
ok: [servera] => (item=4) => {"msg": 4
}
ok: [servera] => (item=5) => {"msg": 5
}
ok: [servera] => (item=6) => {"msg": 6
}
ok: [servera] => (item=r) => {"msg": "r"
}
ok: [servera] => (item=u) => {"msg": "u"
}PLAY RECAP ***************************************************************************************************
servera                    : ok=1    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

迭代嵌套列表

subelements 过滤器从 names 变量数据中创建一个新列表。列表中的每一项本身是一个两元素列表。

$ cat  subelements.yaml
---
- name: liruilong demohosts: serveravars:names:- liruilong:- key: li- liruilong:- key: rui- liruilong:- key: longtasks:- name: loop demodebug: msg={{ item }}loop: "{{ names | subelements('liruilong') }}"

执行测试

$ ansible-playbook subelements.yaml -bPLAY [liruilong demo] ****************************************************************************************TASK [Gathering Facts] ***************************************************************************************
ok: [servera]TASK [loop demo] *********************************************************************************************
ok: [servera] => (item=[{'liruilong': [{'key': 'li'}]}, {'key': 'li'}]) => {"msg": [{"liruilong": [{"key": "li"}]},{"key": "li"}]
}
ok: [servera] => (item=[{'liruilong': [{'key': 'rui'}]}, {'key': 'rui'}]) => {"msg": [{"liruilong": [{"key": "rui"}]},{"key": "rui"}]
}
ok: [servera] => (item=[{'liruilong': [{'key': 'long'}]}, {'key': 'long'}]) => {"msg": [{"liruilong": [{"key": "long"}]},{"key": "long"}]
}PLAY RECAP ***************************************************************************************************
servera                    : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0
  • 第一个元素包含对每个用户的引用。
  • 第二个元素包含该用户的 liruilong 字典中的单个条目的引用。

迭代字典

在 Ansible 2.5 之前,必须使用 with_dict 关键字来迭代字典中的键值对。

item 变量具有两个属性:key 和 value。

key 属性包含一个字典键的值,而 value 属性则包含与字典关联的数据

$ cat dist_demo.yaml
---
- name: 字典 demohosts: serveravars:users:xiaoming:name: xiaomingxiaoli:name: xiaolitasks:- name: dist demodebug: msg={{ item.value.name }}loop: "{{ users | dict2items }}"- name: dist demo1debug: msg={{ item.key }}with_dict : "{{ users  }}"
$

这里使用 dict2item 可以实现相同的功能

$ ansible-playbook dist_demo.yamlPLAY [字典 demo] *************************************************************************************************************TASK [Gathering Facts] *****************************************************************************************************
ok: [servera]TASK [dist demo] ***********************************************************************************************************
ok: [servera] => (item={'key': 'xiaoming', 'value': {'name': 'xiaoming'}}) => {"msg": "xiaoming"
}
ok: [servera] => (item={'key': 'xiaoli', 'value': {'name': 'xiaoli'}}) => {"msg": "xiaoli"
}TASK [dist demo1] **********************************************************************************************************
ok: [servera] => (item={'key': 'xiaoming', 'value': {'name': 'xiaoming'}}) => {"msg": "xiaoming"
}
ok: [servera] => (item={'key': 'xiaoli', 'value': {'name': 'xiaoli'}}) => {"msg": "xiaoli"
}PLAY RECAP *****************************************************************************************************************
servera                    : ok=3    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0$

迭代文件通配模式

通过fileglob查找插件构建循环,以迭代与所提供的文件通配模式的文件列表:

$ cat file_loop.yaml
---
- name: demohosts: serverctasks:- name: file demodebug: msg={{lookup('fileglob','~/.bash*')}}

执行测试

$ ansible-playbook  file_loop.yamlPLAY [demo] ****************************************************************************************************************TASK [Gathering Facts] *****************************************************************************************************
ok: [serverc]TASK [file demo] ***********************************************************************************************************
ok: [serverc] => {"msg": "/home/student/.bash_logout,/home/student/.bash_profile,/home/student/.bashrc,/home/student/.bash_history"
}PLAY RECAP *****************************************************************************************************************
serverc                    : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0

可以使用 query 代替 lookup, 以列表的形式展示

$ sed 's/lookup/query/' file_loop.yaml -i
$ ansible-playbook  file_loop.yamlPLAY [demo] ****************************************************************************************************************TASK [Gathering Facts] *****************************************************************************************************
ok: [serverc]TASK [file demo] ***********************************************************************************************************
ok: [serverc] => {"msg": ["/home/student/.bash_logout","/home/student/.bash_profile","/home/student/.bashrc","/home/student/.bash_history"]
}PLAY RECAP *****************************************************************************************************************
serverc                    : ok=2    changed=0    unreachable=0    failed=0    skipped=0    rescued=0    ignored=0$

博文参考


《Red Hat Ansible Engine 2.8 DO447》

相关内容

热门资讯

蜻蜓订购APP贵金属订购非法期...   蜻蜓订购APP以"投资平台"名义对外宣传,主打贵金属期货(订购)交易。该平台一方面强调自身"正规...
悟空订购APP非法期货交易欺骗...   近期,有投资者反映,“悟空订购APP”等平台以白银、贵金属订购为名,宣传所谓“高收益”“低门槛”...
小赢淘金APP期货投资骗局,平...   “小赢淘金”之流,最擅长的就是用“注册送现金”、“充值返券”的糖衣炮弹来引流。别天真地以为那是福...
八方淘金APP非法期货交易欺骗...   警惕!八方生财、每日淘金、小赢淘金、悟空订购、蜻蜓订购、斗金订购等APP均涉嫌非法期货交易!  ...
智易购APP贵金属订购交易骗局...   很多人看到“3元起投”“充值送福利”“操作简单”“随时提现”这类宣传,很容易把智易购APP当成普...
喜玛银庄APP商品订购投资骗局...   喜玛银庄APP白银、铂金“现货订购”骗局警示:无资质平台涉嫌非法期货交易,投资者爆仓后如何维权?...
吉鑫乐享APP炒贵金属订购交易...   近期,多名投资者反映在“吉鑫乐享APP”进行贵金属投资时遭遇严重亏损,甚至血本无归。看似正规的“...
易掘金APP虚假期货投资骗局,...   “易掘金”的APP它打着“高收益、灵活投资”的旗号,宣称通过“商品订购”就能轻松赚钱,吸引了不少...
在大吉订购APP订购交易亏损被...   近期,不少投资者反映在“大吉订购App”上投资白银、铂金等商品遭遇严重亏损。该平台宣称提供现货订...
铂银壹号APP商品订购交易亏损...   许多中小投资者误以为网上的“商品现货订购”是合规合法的理财渠道,殊不知这背后隐藏着巨大的合规风险...
兴鑫淘金APP贵金属订购交易亏...   白银、贵金属或其他商品类投资,除国家批准的正规期货交易场所及持牌期货公司外,市面上大量第三方交易...
铂银掘金APP无资质的违规平台...   铂银掘金等平台的投资者,往往是被“注册送现金”“充值返现券”“首单免亏”等广告话术吸引,进而下载...
八方淘金APP订购交易不合规,...   “八方淘金APP”“铂银掘金APP”“铂银壹号APP”等软件被指以“现货订购”为名,实际采用高杠...
在指尖订购APP订购商品亏损被...   指尖订购APP这类平台,表面是“订购交易”,实则是披着电商外衣的非法期货陷阱。绝大多数投资者被蒙...
在犀贝易购APP做商品订购交易...   市面上打着“现货投资”“贵金属交易”旗号的APP并不少,但真正合规、受监管的平台并不多。犀贝易购...
易达淘金APP虚假商品订购交易...   易达淘金APP存在严重的虚假宣传与违规交易行为。该平台打着“商品订购”的旗号,实则通过不合规的交...
大浪淘金APP白银订购亏损被骗...   大浪淘金APP最隐蔽的套路,在于其完全封闭的内盘交易系统。表面上,它宣称与国际贵金属市场接轨;实...
一品好购APP上订购白银出现亏...   一品好购APP原名“一品订购”,运营方为上海宝智未来信息技术有限公司。近期不少投资者反映在该平台...
九州订购APP贵金属订购投资骗...   九州订购APP正通过抖.音、快手、今日头条等平台大量投放投资广告,用“5元起投”“充值返现”“0...
坚锅淘金APP交易软件并不正规...   当前,市面上大量所谓的“现货商城订购”交易软件,早已偏离了正常的实物商品买卖,演变为高杠杆、高手...