Ansible 2.8 移植指南
本节讨论 Ansible 2.7 和 Ansible 2.8 之间的行为变化。
旨在帮助您更新您的剧本、插件以及 Ansible 基础设施的其他部分,以便它们能够与 Ansible 的此版本一起使用。
我们建议您阅读此页面以及 Ansible 2.8 的变更日志,以了解您可能需要进行哪些更新。
本文档是移植集合的一部分。完整的移植指南列表可在 移植指南 中找到。
剧本
发行版信息
针对 ansible_distribution_*
组的信息可能略有更改。Ansible 2.8 使用一个新的后端库来获取有关发行版的信息:nir0s/distro。此库在 Python-3.8 上运行,并修复了许多错误,包括更正发行版和版本名称。
在剧本中最常使用的两个信息是 ansible_distribution
和 ansible_distribution_major_version
,它们不应该发生变化。如果您发现这些信息发生了变化,请提交错误报告,以便我们解决差异。但是,其他信息(如 ansible_distribution_release
和 ansible_distribution_version
)可能会发生变化,因为错误信息会被更正。
导入作为处理器
从 2.8 版本开始,任务不能通知在 handlers
中指定的 import_tasks
或静态 include
。
静态导入的目标是充当预处理器,其中导入将被导入文件中定义的任务替换。使用导入时,任务可以通知导入文件中任何命名的任务,但不能通知导入本身的名称。
要实现通知单个名称但运行多个处理器的结果,请使用 include_tasks
或 listen
处理器:在发生更改时运行操作。
Jinja 未定义值
从 2.8 版本开始,尝试访问 Jinja 中未定义值的属性将返回另一个未定义值,而不是立即抛出错误。这意味着您现在可以在嵌套数据结构中简单地使用带有值的默认值,而无需知道中间值是否已定义。
在 Ansible 2.8 中
{{ foo.bar.baz | default('DEFAULT') }}
在 Ansible 2.7 及更早版本中
{{ ((foo | default({})).bar | default({})).baz | default('DEFAULT') }}
或
{{ foo.bar.baz if (foo is defined and foo.bar is defined and foo.bar.baz is defined) else 'DEFAULT' }}
模块选项转换为字符串
从 2.8 版本开始,如果模块期望一个字符串,但传递了一个非字符串值并自动转换为字符串,Ansible 将发出警告。这突出了潜在的问题,例如,yes
或 true
(解析为真值布尔值)将转换为字符串 'True'
,或者版本号 1.10
(解析为浮点数)将转换为 '1.1'
。根据上下文,此类转换可能导致意外行为。
可以通过设置 ANSIBLE_STRING_CONVERSION_ACTION
环境变量或在 ansible.cfg
的 defaults
部分设置 string_conversion_action
配置来更改此行为,使其成为错误或被忽略。
命令行信息
cmdline
信息将在系统中被弃用,取而代之的是 proc_cmdline
。此更改处理内核命令行参数包含多个具有相同键的值的特殊情况。
条件语句中的裸变量
在 Ansible 2.7 及更早版本中,顶级变量有时会将布尔字符串视为布尔值。这导致基于定义为字符串的顶级变量构建的条件测试出现不一致的行为。Ansible 2.8 开始更改此行为。例如,如果您设置了如下两个条件
tasks:
- include_tasks: teardown.yml
when: teardown
- include_tasks: provision.yml
when: not teardown
基于您 **作为字符串** 定义的变量(变量值周围带有引号)
在 Ansible 2.7 及更早版本中,如果
teardown: 'true'
,则上述两个条件分别评估为True
和False
在 Ansible 2.7 及更早版本中,如果
teardown: 'false'
,则两个条件都评估为False
在 Ansible 2.8 及更高版本中,您可以选择禁用条件裸变量,因此当
teardown
是非空字符串(包括'true'
或'false'
)时,when: teardown
始终评估为True
,而when: not teardown
始终评估为False
最终,只要 'string'
不为空,when: 'string'
将始终评估为 True
,而 when: not 'string'
将始终评估为 False
,即使 'string'
本身的值看起来像布尔值。对于依赖于旧行为的剧本用户,我们添加了一个配置设置来保留它。您可以使用 ANSIBLE_CONDITIONAL_BARE_VARS
环境变量或 ansible.cfg
的 defaults
部分中的 conditional_bare_variables
在您的控制节点上选择所需的 behaviour。默认设置为 true
,保留旧行为。将配置值或环境变量设置为 false
以开始使用新选项。
注意
在 2.10 中,conditional_bare_variables
的默认设置将更改为 false
。在 2.12 中,旧行为将被弃用。
更新您的剧本
要为新行为准备您的剧本,您必须更新您的条件语句,使其仅接受布尔值。对于变量,您可以使用 bool
过滤器将字符串 'false'
评估为 False
vars:
teardown: 'false'
tasks:
- include_tasks: teardown.yml
when: teardown | bool
- include_tasks: provision.yml
when: not teardown | bool
或者,您可以将变量重新定义为布尔值(不带引号)而不是字符串
vars:
teardown: false
tasks:
- include_tasks: teardown.yml
when: teardown
- include_tasks: provision.yml
when: not teardown
对于字典和列表,使用 length
过滤器将字典或列表的存在评估为 True
- debug:
when: my_list | length > 0
- debug:
when: my_dictionary | length > 0
不要将 bool
过滤器与列表或字典一起使用。如果将 bool
与列表或字典一起使用,Ansible 将始终将其评估为 False
。
双重插值
conditional_bare_variables
设置也会影响基于其他变量设置的变量。旧的行为意外地对这些变量进行了双重插值。例如:
vars:
double_interpolated: 'bare_variable'
bare_variable: false
tasks:
- debug:
when: double_interpolated
在 Ansible 2.7 及更早版本中,
when: double_interpolated
的值为bare_variable
,在本例中为False
。如果变量bare_variable
未定义,则条件判断失败。在 Ansible 2.8 及更高版本中,禁用裸变量后,Ansible 将
double_interpolated
评估为字符串'bare_variable'
,其值为True
。
要进行双重插值,请使用花括号。
vars:
double_interpolated: "{{ other_variable }}"
other_variable: false
嵌套变量
conditional_bare_variables
设置不影响嵌套变量。分配给子键的任何字符串值都会被尊重,不会被视为布尔值。如果 complex_variable['subkey']
是一个非空字符串,则 when: complex_variable['subkey']
始终为 True
,而 when: not complex_variable['subkey']
始终为 False
。如果希望像 complex_variable['subkey']
这样的字符串子键被评估为布尔值,则必须使用 bool
过滤器。
收集事实
在 Ansible 2.8 中,Play 中隐式的“收集事实”任务被更改为服从 Play 标签。在 2.8 之前,“收集事实”任务会忽略 Play 标签和从命令行提供的标签,并在任务中始终运行。
此行为更改会影响以下示例 Play。
- name: Configure Webservers
hosts: webserver
tags:
- webserver
tasks:
- name: Install nginx
package:
name: nginx
tags:
- nginx
在 Ansible 2.8 中,如果提供 --tags nginx
,则隐式的“收集事实”任务将被跳过,因为该任务现在继承了 webserver
的标签,而不是 always
。
如果未设置 Play 级别的标签,“收集事实”任务将被赋予 always
标签,并将有效地匹配之前的行为。
可以通过在 tasks
列表中使用显式的 gather_facts
任务来获得与 2.8 之前版本类似的结果。
- name: Configure Webservers
hosts: webserver
gather_facts: false
tags:
- webserver
tasks:
- name: Gathering Facts
gather_facts:
tags:
- always
- name: Install nginx
package:
name: nginx
tags:
- nginx
Python 解释器发现
在 Ansible 2.7 及更早版本中,Ansible 默认将 /usr/bin/python 作为 ansible_python_interpreter
的设置。如果在安装了不同名称或不同路径的 Python 的系统上运行 Ansible,则您的 Playbook 将失败,显示 /usr/bin/python: bad interpreter: No such file or directory
,除非您将 ansible_python_interpreter
设置为该系统的正确值,或者在 usr/bin/python 中添加了 Python 解释器和任何必要的依赖项。
从 Ansible 2.8 开始,Ansible 会在每个目标系统上搜索 Python 的正确路径和可执行文件名,首先在常用发行版的默认 Python 解释器查找表中搜索,然后在可能的 Python 解释器名称/路径的排序回退列表中搜索。
依赖于从回退列表中设置的 Python 解释器是有风险的,因为解释器可能会在将来的运行中发生变化。如果从回退列表较高位置安装了解释器(例如,作为安装其他软件包的副作用),则原始解释器及其依赖项将不再被使用。出于这个原因,当 Ansible 使用从回退列表中发现的 Python 解释器时,会发出警告。如果看到此警告,最佳解决方案是显式地将 ansible_python_interpreter
设置为这些目标系统上正确解释器的路径。
您仍然可以在任何变量级别(作为主机变量、在 vars 文件中、在 Playbook 中等)将 ansible_python_interpreter
设置为特定路径。如果您希望使用 Python 解释器发现行为,请使用 Ansible 2.8 中引入的 ansible_python_interpreter
的四个新值之一。
新值 |
行为 |
---|---|
auto |
如果发现了 Python 解释器,即使 /usr/bin/python 也存在,Ansible 也会使用发现的 Python。在使用回退列表时会发出警告。 |
auto_legacy |
如果发现了 Python 解释器,并且 /usr/bin/python 不存在,Ansible 就会使用发现的 Python。在使用回退列表时会发出警告。 如果发现了 Python 解释器,并且 /usr/bin/python 存在,Ansible 就会使用 /usr/bin/python,并打印关于未来默认行为的弃用警告。在使用回退列表时会发出警告。 |
auto_legacy_silent |
行为类似于 |
auto_silent |
行为类似于 |
在 Ansible 2.12 中,Ansible 将默认值从 auto_legacy
更改为 auto
。行为上的差异在于 auto_legacy
会在存在时使用 /usr/bin/python,并在不存在时回退到发现的 Python。 auto
将始终使用发现的 Python,而不管 /usr/bin/python 是否存在。 auto_legacy
设置提供了与之前版本的 Ansible 的兼容性,这些版本始终默认为 /usr/bin/python。
如果将 Python 和依赖项(boto
等)安装到 /usr/bin/python 作为在具有不同默认 Python 解释器(例如,Ubuntu 16.04+、RHEL8、Fedora 23+)的发行版上的解决方法,则有两个选项:
将现有依赖项迁移到每个平台/发行版/版本的默认 Python。
使用
auto_legacy
。此设置允许 Ansible 在具有该设置的主机上查找和使用解决方法 Python,同时还在较新的主机上查找正确的默认 Python。但请记住,默认设置将在 4 个版本后更改。
重试文件创建默认值
在 Ansible 2.8 中,retry_files_enabled
现在默认为 False
,而不是 True
。可以通过编辑默认的 ansible.cfg
文件并将该值设置为 True
来修改行为以使其与旧版本一致。
命令行
获取权限提示
从 2.8 版本开始,默认情况下,Ansible 将使用单词 BECOME
提示您输入提升权限的密码(Unix 系统上的 sudo
权限或网络设备上的 enable
模式)。
Ansible 2.8 默认情况下:
ansible-playbook --become --ask-become-pass site.yml
BECOME password:
如果希望提示显示正在使用的特定 become_method
,而不是通用值 BECOME
,请在 Ansible 配置文件中将 AGNOSTIC_BECOME_PROMPT 设置为 False
。
Ansible 2.7 默认情况下,或 Ansible 2.8 中使用 AGNOSTIC_BECOME_PROMPT=False
时:
ansible-playbook --become --ask-become-pass site.yml
SUDO password:
已弃用
使用
ANSIBLE_ASYNC_DIR
作为任务/Play 环境键来设置异步目录已弃用,并将从 Ansible 2.12 中删除。您可以通过将ansible_async_dir
作为变量来设置,例如:- name: run task with custom async directory command: sleep 5 async: 10 vars: ansible_async_dir: /tmp/.ansible_async
需要
FactCache
对象的插件编写者需要注意两个弃用项:FactCache
类已从ansible.plugins.cache.FactCache
移动到ansible.vars.fact_cache.FactCache
。这是因为FactCache
不是缓存插件 API 的一部分,缓存插件作者不应该对其进行子类化。FactCache
仍然可以通过其旧位置访问,但当从该位置使用时会发出弃用警告。旧位置将在 Ansible 2.12 中删除。FactCache.update()
方法已转换为遵循字典 API。它现在只接受一个字典作为参数,并使用字典的项更新自身。之前的 API(其中update()
接收一个键和一个值)现在将发出弃用警告,并将从 2.12 中删除。如果需要旧的行为,请切换到FactCache.first_order_merge()
。
通过
self.cache
支持基于文件的缓存已弃用,并将从 Ansible 2.12 中删除。如果您维护一个清单插件,请将其更新为使用self._cache
作为字典。有关实现细节,请参阅 清单插件开发者指南。直接导入缓存插件已弃用,将在 Ansible 2.12 中移除。请使用 plugin_loader,以便可以通过配置系统(而不是常量)协调直接选项、环境变量和其他配置方式。
from ansible.plugins.loader import cache_loader cache = cache_loader.get('redis', **kwargs)
模块
此处详细说明了常用模块中的主要更改
运行 PowerShell 模块的 exec 包装器已更改为全局设置 $ErrorActionPreference = "Stop"
。这可能意味着自定义模块如果隐式依赖于此行为,则可能会失败。要恢复旧行为,请在模块顶部添加 $ErrorActionPreference = "Continue"
。进行此更改是为了恢复先前版本中意外删除的 EAP 的旧行为,并确保模块对执行过程中可能发生的错误具有更强的弹性。
Ansible 的 2.8.14 版本将基于文件的任务的默认模式更改为
0o600 & ~umask
,前提是用户在基于文件的任务上未指定mode
参数。这是针对 CVE 报告做出的回应,我们已经重新考虑了该报告。因此,在 2.8.15 中已恢复了mode
更改,并且mode
现在将默认为0o666 & ~umask
,与 Ansible 的先前版本相同。如果在使用 2.8.14 时更改了任何任务以指定限制较少的权限,则在 2.8.15 中这些更改将不再需要(但不会造成任何损害)。
为了避免 CVE-2020-1736 中提出的问题,请在所有接受它的基于文件的任务中指定
mode
参数。dnf
和yum
- 从 2.8.15 版本开始,dnf
模块(以及当它使用dnf
时yum
操作)现在可以正确验证软件包的 GPG 签名(CVE-2020-14365)。如果看到类似于Failed to validate GPG signature for [package name]
的错误,请确保已为正在使用的 DNF 存储库和/或软件包导入了正确的 GPG 密钥。一种方法是使用rpm_key
模块。尽管我们不鼓励这样做,但在某些情况下可能需要禁用 GPG 检查。这可以通过在dnf
或yum
任务中显式添加disable_gpg_check: yes
来完成。
已移除的模块
以下模块不再存在
ec2_remote_facts
azure
cs_nic
netscaler
win_msi
弃用通知
以下模块将在 Ansible 2.12 中移除。请相应地更新您的 playbook。
foreman
请改用 foreman-ansible-modules。katello
请改用 foreman-ansible-modules。github_hooks
请改用 github_webhook 和 github_webhook_facts。digital_ocean
请改用 digital_ocean_droplet。gce
请改用 gcp_compute_instance。gcspanner
请改用 gcp_spanner_instance 和 gcp_spanner_database。gcdns_record
请改用 gcp_dns_resource_record_set。gcdns_zone
请改用 gcp_dns_managed_zone。gcp_forwarding_rule
请改用 gcp_compute_global_forwarding_rule 或 gcp_compute_forwarding_rule。gcp_healthcheck
请改用 gcp_compute_health_check、gcp_compute_http_health_check 或 gcp_compute_https_health_check。gcp_backend_service
请改用 gcp_compute_backend_service。gcp_target_proxy
请改用 gcp_compute_target_http_proxy。gcp_url_map
请改用 gcp_compute_url_map。panos
请改用 Palo Alto Networks Ansible Galaxy 角色。
值得注意的模块更改
foreman
和katello
模块已弃用,取而代之的是一组按实体细分的模块,这些模块更注重幂等性。foreman
和katello
模块的替换正式成为 Foreman 社区的一部分,并得到那里的支持。tower_credential
模块最初要求ssh_key_data
是 ssh_key_file 的路径。为了使其与 AWX/Tower/RHAAP 类似,ssh_key_data
现在包含文件的内容。可以通过lookup('file', '/path/to/file')
实现之前的行为。win_scheduled_task
模块弃用了将触发器重复指定为列表的支持,此格式将在 Ansible 2.12 中移除。请改用将重复指定为字典值。win_feature
模块已删除弃用的restart_needed
返回值,请改用标准化的reboot_required
值。win_package
模块已删除弃用的restart_required
和exit_code
返回值,请改用标准化的reboot_required
和rc
值。win_get_url
模块已删除弃用的win_get_url
返回字典,包含的值将直接返回。win_get_url
模块已删除弃用的skip_certificate_validation
选项,请改用标准化的validate_certs
选项。vmware_local_role_facts
模块现在返回字典列表,而不是字典的字典,用于角色信息。如果
docker_network
或docker_volume
使用diff: yes
、check_mode: yes
或debug: yes
调用,则会返回一个名为diff
的类型为list
的返回值。为了启用正确的差异输出,将其更改为类型dict
;原始list
将作为diff.differences
返回。na_ontap_cluster_peer
模块已将source_intercluster_lif
和dest_intercluster_lif
字符串选项替换为source_intercluster_lifs
和dest_intercluster_lifs
列表选项现在,
modprobe
模块能够检测内核内置模块。之前,尝试移除(使用state: absent
)一个内置内核模块时,会成功执行且没有任何错误信息,因为modprobe
没有检测到该模块是present
状态。现在,如果内核模块是内置的并且state: absent
,modprobe
将会失败(并输出类似于modprobe: ERROR: Module nfs is builtin.
的错误信息),如果state: present
,则会成功执行且不报告更改。任何使用changed_when: no
来掩盖此问题的 playbook 可以安全地移除该解决方法。为了获得在将state: absent
应用于内置内核模块时的先前行为,请在您的 playbook 中使用failed_when: false
或ignore_errors: true
。digital_ocean
模块已被弃用,建议使用不需要外部依赖项的模块。这使得 Ansible 具有更大的灵活性和更好的模块支持。docker_container
模块已弃用返回的事实docker_container
。相同的值可以通过返回的变量container
获取。返回的事实将在 Ansible 2.12 中移除。docker_network
模块已弃用返回的事实docker_container
。相同的值可以通过返回的变量network
获取。返回的事实将在 Ansible 2.12 中移除。docker_volume
模块已弃用返回的事实docker_container
。相同的值可以通过返回的变量volume
获取。返回的事实将在 Ansible 2.12 中移除。docker_service
模块已重命名为 docker_compose。重命名的
docker_compose
模块过去会为每个服务返回一个同名的事实。现在,这些事实的字典将作为常规返回值services
返回。返回的事实将在 Ansible 2.12 中移除。docker_swarm_service
模块不再为以下选项设置默认值user
。之前,默认值为root
。update_delay
。之前,默认值为10
。update_parallelism
。之前,默认值为1
。
vmware_vm_facts
过去会返回一个包含虚拟机信息的字典的字典。从 Ansible 2.8 开始,将返回一个包含虚拟机信息的字典的列表。请参阅vmware_vm_facts
模块文档以获取示例。vmware_guest_snapshot
模块过去会返回results
。由于 Ansible 2.8 及更高版本中results
是一个保留关键字,因此它被替换为snapshot_results
。请参阅vmware_guest_snapshots
模块文档以获取示例。panos
模块已被弃用,建议使用 Palo Alto Networks 的 [Ansible Galaxy 角色](https://galaxy.ansible.com/PaloAltoNetworks/paloaltonetworks)。您可以 [在这里](https://github.com/PaloAltoNetworks/ansible-pan) 为该角色贡献代码。ipa_user
模块最初会始终将password
发送到 FreeIPA,无论密码是否更改。现在,该模块仅在update_password
设置为always
时发送password
,这是默认设置。win_psexec
已弃用未公开的模块选项extra_opts
。此选项将在 Ansible 2.10 中移除。win_nssm
模块已弃用以下选项,建议使用win_service
模块在使用win_nssm
安装服务后配置服务:*dependencies
,请改用win_service
的dependencies
*start_mode
,请改用win_service
的start_mode
*user
,请改用win_service
的username
*password
,请改用win_service
的password
这些选项将在 Ansible 2.12 中移除。win_nssm
模块还弃用了status
选项的start
、stop
和restart
值。您应该使用win_service
模块来控制服务的运行状态。此更改将在 Ansible 2.12 中移除。win_nssm
的status
模块选项的默认值已更改为present
。之前,默认值为start
。因此,使用win_nssm
创建服务后,服务不再默认启动,如果需要,您应该使用win_service
模块启动它。win_nssm
的app_parameters
模块选项已被弃用;请改用argument
。此更改将在 Ansible 2.12 中移除。win_nssm
的app_parameters_free_form
模块选项已别名为新的arguments
选项。win_dsc
模块现在将验证 DSC 资源的输入选项。在以前的版本中,无效的选项会被忽略,但现在不会。openssl_pkcs12
模块现在将在磁盘上的文件与传递给模块的参数之间存在差异时重新生成 pkcs12 文件。
插件
当使用 macOS 作为控制节点时,Ansible 不再默认使用
paramiko
连接插件。Ansible 现在将在 macOS 控制节点上默认使用ssh
连接插件。由于ssh
支持任务和 playbook 运行之间的连接持久性,因此它的性能优于paramiko
。如果您使用密码身份验证,则在使用ssh
连接插件时需要安装sshpass
。或者,您可以显式地将连接类型设置为paramiko
以在 macOS 上保持 2.8 之前的行为。连接插件已标准化,允许使用
ansible_<conn-type>_user
和ansible_<conn-type>_password
变量。诸如ansible_<conn-type>_pass
和ansible_<conn-type>_username
之类的变量的优先级低于标准化名称,并且将来可能会被弃用。一般来说,应使用ansible_user
和ansible_password
变量,除非有理由使用特定于连接的变量。现在,
powershell
shell 插件使用async_dir
来定义结果文件的异步路径,默认路径已更改为%USERPROFILE%\.ansible_async
。要控制此路径,请设置ansible_async_dir
变量或配置文件 ini 中powershell
部分的async_dir
值。已更新启用的清单插件顺序(INVENTORY_ENABLED),auto 现在位于 yaml 和 ini 之前。
回调插件的
CallbackBase
类已删除私有属性_options
。如果您有需要访问命令行参数的第三方回调插件,请使用以下代码代替尝试使用self._options
from ansible import context [...] tags = context.CLIARGS['tags']
context.CLIARGS
是一个只读字典,因此像CLIARGS.get('tags')
和CLIARGS['tags']
这样的普通字典检索方法可以按预期工作,但您将无法修改任何命令行参数。现在,任务重述除了统计
ok
、changed
、unreachable
、failed
和skipped
任务外,还统计ignored
和rescued
任务,这得益于default
回调插件中的两个额外的统计计数器。失败并设置了ignore_errors: yes
的任务将被列为ignored
。失败然后执行恢复部分的任务将被列为rescued
。请注意,与 Ansible 2.7(及更早版本)不同,rescued
任务不再计入failed
任务。osx_say
回调插件已重命名为 say。清单插件现在通过缓存插件支持缓存。要开始使用清单的缓存插件,请参阅 清单指南 中关于缓存的部分。要移植自定义缓存插件以使其与清单兼容,请参阅 缓存插件开发指南。
移植自定义脚本
显示类
从 Ansible 2.8 开始,Display
类现在是“单例”。每个文件都应该导入并实例化 ansible.utils.display.Display
,而不是使用 __main__.display
。
旧版 在 Ansible 2.7(及更早版本)中,使用以下方法访问 display
对象
try:
from __main__ import display
except ImportError:
from ansible.utils.display import Display
display = Display()
新版 在 Ansible 2.8 中,应使用以下方法
from ansible.utils.display import Display
display = Display()
网络
eos_config
、ios_config
和nxos_config
模块已删除弃用的save
和force
参数,使用save_when
参数来复制其功能。nxos_vrf_af
模块已删除safi
参数。此参数在 Ansible 2.4 中已弃用,并且从那时起对模块没有任何影响。