Ansible-core 2.11 移植指南

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

它旨在帮助您更新剧本、插件和 Ansible 基础架构的其他部分，以便它们与此版本的 ansible-core 一起工作。

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

ansible-core 主要对只希望使用可用集合中的一小部分受控子集的开发人员和用户感兴趣。普通用户应安装 Ansible。

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

剧本

  • jinja2_native 设置现在不影响隐式返回字符串的 template 模块。对于 template lookup，有一个新的参数 jinja2_native（默认关闭）来控制该功能。其余的 Jinja2 表达式仍然基于 jinja2_native 设置运行。

命令行

  • 已删除 ansible-galaxy login 命令，因为它用于 GitHub 身份验证的底层 API 已被关闭。现在，使用 ansible-galaxy 将角色或集合发布到 Galaxy 需要将 Galaxy API 令牌传递给 CLI，可以使用令牌文件（默认位置 ~/.ansible/galaxy_token）或（不安全地）使用 --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.validation 或 ArgumentSpecValidator.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 ansible 或 pip 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 现在会导致错误（有效选项为 ignore、warn 或 error）。

  • ansible-galaxy 命令现在使用 resolvelib 来解析依赖项。在大多数情况下，除了性能更高之外，这不应该对用户造成任何影响，但为了完整性和方便，我们在此说明。

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

模块

  • apt_key 模块已明确定义 file 与 data、keyserver 和 url 互斥。它们不能再一起使用。

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

删除的模块

以下模块不再存在

  • 没有重大更改

弃用通知

没有重大更改

值得注意的模块更改

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

  • facts - 虚拟化事实现在包括 virtualization_tech_guest 和 virtualization_tech_host 键。这些是客户机所属或主机提供的虚拟化技术列表。例如，如果您设置主机以同时提供 KVM 和 VirtualBox，则这两个值都包含在 virtualization_tech_host 中。同样，在 KVM 驱动的 VM 上运行的 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 中的条目以匹配实际情况。

移植自定义脚本

没有重大更改