Ansible 模块或插件的生命周期

Ansible 主存储库中的模块和插件具有定义的生命周期，从首次引入到最终删除。模块和插件的生命周期与 Ansible 发布周期 <release_cycle> 相关联。模块或插件可能会经历这四个阶段

当模块或插件首次被接受到 Ansible 中时，我们认为它处于技术预览阶段，并在文档中将其标记为技术预览。
如果模块或插件成熟，则文档中的“预览”标记将被删除。这些模块和插件的向后兼容性得到维护，但不能保证，这意味着它们的參數应该保持稳定的含义。
如果模块或插件的目标 API 发生根本性变化，或者有人创建了其功能的更好实现，我们可能会将其标记为已弃用。已弃用的模块和插件仍然可用，但它们正处于生命周期的末期。我们将保留已弃用的模块和插件 4 个发布周期，并提供弃用警告以帮助用户更新使用它们的剧本和角色。
当模块或插件被弃用 4 个发布周期后，它将被删除并替换为路由配置中的墓碑条目。已删除的模块和插件不再与 Ansible 一起提供。墓碑条目帮助用户查找替代模块和插件。

对于集合中的模块和插件，生命周期是类似的。自 ansible-base 2.10 以来，不再可能将模块标记为“预览”或“稳定”。

在 Ansible 主存储库中弃用模块和插件

要在 ansible-core 中弃用模块，您必须

将文件重命名，使其以 _ 开头，例如，将 old_cloud.py 重命名为 _old_cloud.py。这将使模块保持可用并将其标记为在模块索引页面上已弃用。
在相关的变更日志中提及弃用（通过创建一个带有 deprecated_features 部分的变更日志片段）。
在相关的 porting_guide_core_x.y.rst 中引用弃用。
将 deprecated: 添加到文档中，并使用以下子值

removed_in:

一个 string，例如 "2.10"；Ansible 将模块替换为仅文档模块存根的版本。通常为当前版本 +4。与 :removed_by_date: 互斥。

remove_by_date:

（在 ansible-base 2.10 中添加）。模块将被删除的 ISO 8601 格式日期。通常为模块被弃用日期后的 2 年。与 :removed_in: 互斥。

why:

用于详细说明原因的可选字符串。

alternatives:

告知用户他们应该怎么做，例如 Use M(whatmoduletouseinstead) instead.。

有关记录弃用示例，请参阅此弃用多个模块的 PR。PR 中的一些元素现在可能已过时。

在集合中弃用模块和插件

要在集合中弃用模块，您必须

在 meta/runtime.yml 中将 deprecation 条目添加到 plugin_routing 中。例如，要弃用模块 old_cloud，请添加
```
plugin_routing:
    modules:
        old_cloud:
            deprecation:
                removal_version: 2.0.0
                warning_text: Use foo.bar.new_cloud instead.
```
对于其他插件类型，您必须将 modules: 替换为 <plugin_type>:，例如 lookup: 用于查找插件。在弃用操作插件时，您需要添加两个条目：一个用于操作插件，另一个用于包含文档的模块文件。

除了 removal_version 之外，您还可以使用带有 ISO 8601 格式日期的 removal_date，该日期表示模块将在集合的新主要版本中被删除后的日期。
在相关的变更日志中提及弃用。如果集合使用 antsibull-changelog，请创建一个带有 deprecated_features 部分的变更日志片段。
将 deprecated: 添加到模块或插件的文档中，并使用以下子值

removed_in:

一个 string，例如 "2.10"；Ansible 将模块替换为仅文档模块存根的版本。通常为当前版本 +4。与 :removed_by_date: 互斥。

remove_by_date:

（在 ansible-base 2.10 中添加）。模块将被删除的 ISO 8601 格式日期。通常为模块被弃用日期后的 2 年。与 :removed_in: 互斥。

why:

用于详细说明原因的字符串。

alternative:

告知用户他们应该怎么做，例如 Use M(whatmoduletouseinstead) instead.。有关引用除模块以外的其他实体的方法，请参阅模块文档中的链接。

更改 Ansible 主存储库中的模块或插件名称

您还可以重命名模块并使用以 _ 开头的符号链接来保留旧名称的已弃用别名。此示例允许使用 fileinfo 调用 stat 模块，从而使以下示例等效

ln -s stat.py _fileinfo.py
ansible -m stat -a "path=/tmp" localhost
ansible -m fileinfo -a "path=/tmp" localhost

重命名集合中的模块或插件，或将模块或插件重定向到另一个集合

要重命名集合中的模块或插件，或将模块或插件重定向到另一个集合，您需要在 meta/runtime.yml 中将 redirect 条目添加到 plugin_routing 中。例如，要将模块 old_cloud 重定向到 foo.bar.new_cloud，请添加

plugin_routing:
    modules:
        old_cloud:
            redirect: foo.bar.new_cloud

如果您想弃用旧名称，请添加一个 deprecation: 条目（见上文）。

plugin_routing:
    modules:
        old_cloud:
            redirect: foo.bar.new_cloud
            deprecation:
                removal_version: 2.0.0
                warning_text: Use foo.bar.new_cloud instead.

您需要使用新的模块/插件名称的完全限定集合名称 (FQCN)，即使它位于与重定向相同的集合中。通过使用来自另一个集合的 FQCN，您可以将模块/插件重定向到该集合。

如果您需要支持 Ansible 2.9，请注意 Ansible 2.9 不了解 meta/runtime.yml。使用 Ansible 2.9，您仍然可以通过使用符号链接来重命名集合内的插件和模块。请注意，ansible-base 2.10、ansible-core 2.11 和更新版本将优先考虑 meta/runtime.yml 条目而不是符号链接。

将集合中的模块或插件变成墓碑

要从集合中删除已弃用的模块或插件，您需要将其变成墓碑

删除模块或插件文件以及相关的文件，如测试、文档引用和文档。
在 meta/runtime.yml 中添加一个墓碑条目。例如，要将模块 old_cloud 变成墓碑，请添加
```
plugin_routing:
    modules:
        old_cloud:
            tombstone:
                removal_version: 2.0.0
                warning_text: Use foo.bar.new_cloud instead.
```
除了 removal_version 之外，您还可以使用带有 ISO 8601 格式日期的 removal_date。该日期应为下一个主要版本的日期。