本文档采用自动化机器翻译技术翻译。 尽管我们力求提供准确的译文,但不对翻译内容的完整性、准确性或可靠性作出任何保证。 若出现任何内容不一致情况,请以原始 英文 版本为准,且原始英文版本为权威文本。

标记弃用

K3s 是一个快速发展的项目,因此我们需要一种方法来弃用标记和配置选项。本页面概述了弃用标记和配置选项的过程。为了确保用户不会对标记的移除感到惊讶,该过程类似于 Kubernetes 弃用策略

过程

  1. 标记可以在任何时候声明为 "待弃用"。

  2. 凡被声明为“待弃用”的标记,必须在所有当前支持版本的下一个补丁中予以标注。此外,该标记将开始警告用户它将在下一个小版本中被弃用。

  3. 在下一个小版本中,标记将在文档中标记为弃用,并在代码中转换为隐藏标记。该标记将继续运行并向用户发出警告。

  4. 在随后的小版本分支中,弃用的标记将变为 "非操作性",如果使用将导致致命错误。此错误必须向用户解释任何替代此标记的新标记或配置。

  5. 在下一个小版本中,非操作性标记将从文档和代码中去除。

示例

过程示例:

  • --foo 存在于 v1.22.14、v1.23.10 和 v1.24.2 中。

  • 在 v1.24.2 发布后,决定弃用 --foo,改用 --new-foo

  • 在 v1.22.15、v1.23.11 和 v1.24.3 中,--foo 继续存在,但会警告用户:

    [Warning] --foo will be deprecated in v1.25.0, use `--new-foo` instead

    --foo 将继续作为操作标记存在于 v1.22、v1.23 和 v1.24 的生命周期内。

  • 在 v1.25.0 中,--foo 在文档中标记为弃用,并将在代码中隐藏。它将继续工作并警告用户迁移到 --new-foo

  • 在 v1.26.0 中,--foo 如果被使用将导致致命错误。错误讯息将会显示:

    [Fatal] exit 1: --foo is no longer supported, use --new-foo instead
  • 在 v1.27.0 中,--foo 将会从所有代码和文档中完全去除。