Ansible-core 2.11 移植指南

本节讨论 ansible-base 2.10 和 ansible-core 2.11 之间的行为变化。

旨在帮助您更新 playbook、插件以及 Ansible 基础架构的其他部分,以便它们与此版本的 ansible-core 兼容。

建议您阅读此页面以及 ansible-core 2.11 的变更日志,以了解您可能需要进行哪些更新。

ansible-core 主要面向仅希望使用可用集合的小型受控子集的开发人员和用户。普通用户应该安装 Ansible。

完整的移植指南列表可在 移植指南 中找到。

Playbook

  • jinja2_native 设置现在不影响模板模块,该模块隐式返回字符串。对于模板查找,有一个新的参数 jinja2_native(默认情况下关闭)来控制该功能。其余的 Jinja2 表达式仍然根据 jinja2_native 设置进行操作。

命令行

  • ansible-galaxy login 命令已被移除,因为它使用的用于 GitHub 身份验证的基础 API 已关闭。现在,使用 ansible-galaxy 将角色或集合发布到 Galaxy 需要将 Galaxy API 令牌通过令牌文件(默认位置 ~/.ansible/galaxy_token)传递到 CLI,或者(不安全地)使用 --token 参数传递到 ansible-galaxy

已弃用

常量 ansible.module_utils.basic._CHECK_ARGUMENT_TYPES_DISPATCHER 已弃用。请改用 ansible.module_utils.common.parameters.DEFAULT_TYPE_VALIDATORS

重大更改

AnsibleModule 的更改

随着使用 ArgumentSpecValidator 执行参数规范验证,AnsibleModule 中以下私有方法已被移除

使用这些私有方法的模块或插件应使用 ansible.module_utils.common.validationArgumentSpecValidator.validate() 中的公共函数,如果上面没有列出公共函数。

ansible.module_utils.common.parameters 的更改

以下 ansible.module_utils.common.parameters 中的函数现在是私有的,不应直接使用。请改用 ArgumentSpecValidator.validate()

  • list_no_log_values

  • list_deprecations

  • handle_aliases

其他

  • **升级**: 如果从 ansible < 2.10 或从 ansible-base 升级并使用 pip,则必须在安装 ansible-core 之前 pip uninstall ansiblepip uninstall ansible-base 以避免冲突。

  • 控制器节点上的 Python 3.8 是此版本的软性要求。 ansible-core 2.11 仍然可以使用与 ansible-base 2.10 相同版本的 Python,但是当在 Python 版本低于 3.8 的控制器节点上运行时,2.11 会发出警告。可以通过在环境中设置 ANSIBLE_CONTROLLER_PYTHON_WARNING=False 来禁用此警告。 ansible-core 2.12 将需要 Python 3.8 或更高版本。

  • 配置系统现在验证 choices 字段,因此任何违反该字段并在 2.10 中被忽略的设置都会在 2.11 中导致错误。例如,ANSIBLE_COLLECTIONS_ON_ANSIBLE_VERSION_MISMATCH=0 现在会导致错误(有效选择是 ignorewarnerror)。

  • ansible-galaxy 命令现在使用 resolvelib 来解决依赖关系。在大多数情况下,这除了性能更高之外,不应该对用户造成影响,但我们在这里记录它以备后用并完整起见。

  • 如果您将 Python module_utils 导入到您维护的任何模块中,您现在可以在模块有效负载构建期间将导入标记为可选,方法是在 import 语句中包装一个 tryif 块。这允许模块使用可能并非所有版本的 Ansible 或集合中都存在的 module_utils,并在模块运行时执行任意恢复或回退操作。

模块

  • apt_key 模块已明确定义 filedatakeyserverurl 互斥。它们不能再一起使用。

  • meta 模块现在支持用户定义任务的标签。将任务的标签设置为“always”以保持之前的行为。内部 meta 任务将继续始终运行。

已移除的模块

以下模块不再存在

  • 无重大更改

弃用通知

无重大更改

值得注意的模块更改

  • facts - 在 NetBSD 上,ansible_virtualization_type 现在尝试报告比虚拟化且未在 Xen 上运行时的 xen 更准确的结果。

  • facts - 虚拟化事实现在包括 virtualization_tech_guestvirtualization_tech_host 键。这些分别是访客所属的虚拟化技术列表或主机提供的虚拟化技术列表。例如,如果您设置主机以同时提供 KVM 和 VirtualBox,则这两个值都包含在 virtualization_tech_host 中。类似地,在由 KVM 提供支持的虚拟机上运行的 podman 容器具有 virtualization_tech_guest["kvm", "podman", "container"]

  • setup 模块中,参数 filter 类型从 string 更改为 list 以使用多个过滤器。以前的行为(使用 string)仍然保留并作为单个过滤器工作。

插件

  • 清单插件 - CachePluginAdjudicator.flush() 现在调用底层缓存插件的 flush(),而不是仅删除它已知的键。清单插件应使用 delete() 删除任何特定键。作为用户,这意味着当清单插件调用其 clear_cache() 方法时,事实也可能从缓存中刷新。为了解决此问题,用户可以配置清单插件以使用独立于事实缓存的缓存后端。

  • 回调插件 - meta 任务执行现在像任何其他任务一样发送到 v2_playbook_on_task_start。默认情况下,只有显式 meta 任务会被发送到那里。回调插件可以选择接收内部、隐式创建的任务以对它们进行操作,如插件开发文档中所述。

  • 现在验证了 choices,因此如果提供的值与之不匹配,则在 2.11 中使用不正确或不完整选择的插件会发出错误。这有一个简单的解决方法:更新 choices 中的条目以匹配实际情况。

移植自定义脚本

无重大更改