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

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

当模块或插件首次被接受到 Ansible 时，我们认为它处于技术预览阶段，并会在文档中将其标记为预览版。
如果模块或插件成熟，则会删除文档中的“预览”标记。将维护这些模块和插件的向后兼容性，但不保证，这意味着它们的 parameters 应保持稳定的含义。
如果模块或插件的目标 API 发生根本性更改，或者有人创建了更好的功能实现，我们可能会将其标记为已弃用。已弃用的模块和插件仍然可用，但它们正在接近生命周期结束。我们将保留已弃用的模块和插件 4 个发布周期，并提供弃用警告，以帮助用户更新使用它们的 playbook 和角色。
当模块或插件已弃用四个发布周期后，它将被删除，并在路由配置中替换为墓碑条目。已删除的模块和插件不再与 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 格式日期。通常为模块弃用日期后的两年。与 :removed_in: 互斥。

why:

用于详细说明为何删除它的可选字符串。

alternatives:

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

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

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

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

向meta/runtime.yml中的plugin_routing添加deprecation条目。例如，要弃用模块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:。弃用 action 插件时，需要添加两个条目：一个用于 action 插件，一个用于包含文档的模块文件。

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

removed_in:

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

remove_by_date:

(在 ansible-base 2.10 中添加)。模块将在新的主要版本中删除的 ISO 8601 格式日期。通常为模块弃用日期后的两年。与 :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中的plugin_routing添加redirect条目。例如，要将模块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，您也可以使用removal_date，并使用ISO 8601格式的日期。此日期应为下一个主要版本的发布日期。