操作数据
在许多情况下,您需要对变量执行复杂的操作。虽然不建议将 Ansible 作为数据处理/操作工具,但您可以结合使用现有的 Jinja2 模板和许多添加的 Ansible 过滤器、查找和测试来执行一些非常复杂的转换。
- 让我们从每个插件类型的快速定义开始
查找 (lookups):主要用于查询“外部数据”,在 Ansible 中,它们是使用
with_<lookup>
结构循环的主要部分,但它们可以独立使用以返回数据进行处理。由于它们之前提到的在循环中的主要功能,它们通常返回一个列表。与lookup
或query
Jinja2 运算符一起使用。过滤器 (filters):用于更改/转换数据,与
|
Jinja2 运算符一起使用。测试 (tests):用于验证数据,与
is
Jinja2 运算符一起使用。
循环和列表推导式
大多数编程语言都有循环(for
、while
等)和列表推导式,用于对列表(包括对象列表)进行转换。Jinja2 有一些过滤器可以提供此功能:map
、select
、reject
、selectattr
、rejectattr
。
map:这是一个基本的 for 循环,它允许您更改列表中的每个项目,使用“attribute”关键字,您可以基于列表元素的属性进行转换。
select/reject:这是一个带有条件的 for 循环,它允许您创建一个子列表,该子列表基于条件结果匹配(或不匹配)。
selectattr/rejectattr:与上述非常相似,但它使用列表元素的特定属性进行条件语句。
使用循环创建指数退避。
- name: try wait_for_connection up to 10 times with exponential delay
ansible.builtin.wait_for_connection:
delay: '{{ item | int }}'
timeout: 1
loop: '{{ range(1, 11) | map("pow", 2) }}'
loop_control:
extended: true
ignore_errors: "{{ not ansible_loop.last }}"
register: result
when: result is not defined or result is failed
从列表中提取与字典元素匹配的键
Python 等效代码如下
chains = [1, 2]
for chain in chains:
for config in chains_config[chain]['configs']:
print(config['type'])
在 Ansible 中有几种方法可以做到这一点,这只是一个示例
tasks:
- name: Show extracted list of keys from a list of dictionaries
ansible.builtin.debug:
msg: "{{ chains | map('extract', chains_config) | map(attribute='configs') | flatten | map(attribute='type') | flatten }}"
vars:
chains: [1, 2]
chains_config:
1:
foo: bar
configs:
- type: routed
version: 0.1
- type: bridged
version: 0.2
2:
foo: baz
configs:
- type: routed
version: 1.0
- type: bridged
version: 1.1
ok: [localhost] => {
"msg": [
"routed",
"bridged",
"routed",
"bridged"
]
}
vars:
unique_value_list: "{{ groups['all'] | map ('extract', hostvars, 'varname') | list | unique}}"
查找挂载点
在这种情况下,我们想找到给定路径在我们的机器上的挂载点,由于我们已经收集了挂载事实,我们可以使用以下方法
- hosts: all
gather_facts: True
vars:
path: /var/lib/cache
tasks:
- name: The mount point for {{path}}, found using the Ansible mount facts, [-1] is the same as the 'last' filter
ansible.builtin.debug:
msg: "{{(ansible_facts.mounts | selectattr('mount', 'in', path) | list | sort(attribute='mount'))[-1]['mount']}}"
从列表中省略元素
特殊的 omit
变量仅适用于模块选项,但我们仍然可以在其他方面将其用作标识符来定制元素列表
- name: Enable a list of Windows features, by name
ansible.builtin.set_fact:
win_feature_list: "{{ namestuff | reject('equalto', omit) | list }}"
vars:
namestuff:
- "{{ (fs_installed_smb_v1 | default(False)) | ternary(omit, 'FS-SMB1') }}"
- "foo"
- "bar"
另一种方法是避免首先将元素添加到列表中,这样您就可以直接使用它
- name: Build unique list with some items conditionally omitted
ansible.builtin.set_fact:
namestuff: ' {{ (namestuff | default([])) | union([item]) }}'
when: item != omit
loop:
- "{{ (fs_installed_smb_v1 | default(False)) | ternary(omit, 'FS-SMB1') }}"
- "foo"
- "bar"
合并同一字典列表中的值
结合上面示例中的正向和负向过滤器,您可以获得“存在时的值”和“不存在时的回退值”。
- hosts: localhost
tasks:
- name: Check hosts in inventory that respond to ssh port
wait_for:
host: "{{ item }}"
port: 22
loop: '{{ has_ah + no_ah }}'
vars:
has_ah: '{{ hostvars|dictsort|selectattr("1.ansible_host", "defined")|map(attribute="1.ansible_host")|list }}'
no_ah: '{{ hostvars|dictsort|rejectattr("1.ansible_host", "defined")|map(attribute="0")|list }}'
基于变量的自定义 Fileglob
此示例使用 Python 参数列表解包基于变量创建自定义文件全局列表。
- hosts: all
vars:
mygroups:
- prod
- web
tasks:
- name: Copy a glob of files based on a list of groups
copy:
src: "{{ item }}"
dest: "/tmp/{{ item }}"
loop: '{{ q("fileglob", *globlist) }}'
vars:
globlist: '{{ mygroups | map("regex_replace", "^(.*)$", "files/\1/*.conf") | list }}'
复杂类型转换
Jinja 为简单数据类型转换提供过滤器(int
、bool
等),但是当您想转换数据结构时,事情就没那么容易了。您可以像上面所示那样使用循环和列表推导式来帮助,还可以链式使用其他过滤器和查找来实现更复杂的转换。
从列表创建字典
在大多数语言中,从一对列表创建字典(也称为 map/关联数组/hash 等)很容易。在 Ansible 中,有几种方法可以做到这一点,哪种方法最适合您可能取决于您的数据来源。
这些示例产生 {"a": "b", "c": "d"}
vars:
single_list: [ 'a', 'b', 'c', 'd' ]
mydict: "{{ dict(single_list[::2] | zip_longest(single_list[1::2])) }}"
vars:
list_of_pairs: [ ['a', 'b'], ['c', 'd'] ]
mydict: "{{ dict(list_of_pairs) }}"
两者最终都是相同的,zip_longest
将 single_list
转换为 list_of_pairs
生成器。
更复杂一点,使用 set_fact
和 loop
从 2 个列表中创建/更新带有键值对的字典
- name: Uses 'combine' to update the dictionary and 'zip' to make pairs of both lists
ansible.builtin.set_fact:
mydict: "{{ mydict | default({}) | combine({item[0]: item[1]}) }}"
loop: "{{ (keys | zip(values)) | list }}"
vars:
keys:
- foo
- var
- bar
values:
- a
- b
- c
这会产生 {"foo": "a", "var": "b", "bar": "c"}
。
您甚至可以将这些简单的示例与其他过滤器和查找结合使用,通过匹配变量名称的模式来动态创建字典
vars:
xyz_stuff: 1234
xyz_morestuff: 567
myvarnames: "{{ q('varnames', '^xyz_') }}"
mydict: "{{ dict(myvarnames|map('regex_replace', '^xyz_', '')|list | zip(q('vars', *myvarnames))) }}"
快速解释一下,因为这两行需要大量解包
varnames
查找返回与“以xyz_
开头”匹配的变量列表。然后将上一步的列表输入到
vars
查找中以获取值列表。*
用于“取消引用列表”(在 Jinja 中工作的 pythonism),否则它会将列表作为单个参数。两个列表都传递给
zip
过滤器,将它们配对成一个统一的列表(键、值、键 2、值 2,……)。然后,dict 函数采用此“对列表”来创建字典。
一个示例,说明如何使用事实来查找满足条件 X 的主机数据
vars:
uptime_of_host_most_recently_rebooted: "{{ansible_play_hosts_all | map('extract', hostvars, 'ansible_uptime_seconds') | sort | first}}"
一个示例,显示主机正常运行时间(以天/小时/分钟/秒为单位)(假设已收集事实)。
- name: Show the uptime in days/hours/minutes/seconds
ansible.builtin.debug:
msg: Uptime {{ now().replace(microsecond=0) - now().fromtimestamp(now(fmt='%s') | int - ansible_uptime_seconds) }}
另请参阅
- 使用过滤器来操作数据
Ansible 中包含的 Jinja2 过滤器
- 测试
Ansible 中包含的 Jinja2 测试
- Jinja2 文档
Jinja2 文档,包括核心过滤器和测试的列表