kubernetes.core.k8s_rollback 模块 – 回滚 Kubernetes (K8S) 部署和 DaemonSets

注意

此模块是 kubernetes.core 集合 (版本 5.0.0) 的一部分。

如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install kubernetes.core。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在 playbook 中使用它，请指定：kubernetes.core.k8s_rollback。

kubernetes.core 1.0.0 中的新增功能

概要

  • 使用 Kubernetes Python 客户端执行回滚。

  • 使用配置文件、证书、密码或令牌进行身份验证。

  • 类似于 kubectl rollout undo 命令。

注意

此模块具有相应的 action 插件。

要求

执行此模块的主机需要以下要求。

  • python >= 3.9

  • kubernetes >= 24.2.0

  • PyYAML >= 3.11

参数

参数

注释

api_key

字符串

用于对 API 进行身份验证的令牌。也可以通过 K8S_AUTH_API_KEY 环境变量指定。

api_version

别名：api，version

字符串

用于指定 API 版本。

用于创建、删除或发现对象，无需提供完整的资源定义。

与 kind、name 和 namespace 结合使用以识别特定对象。

如果提供了 resource definition，则来自 resource_definition 的 apiVersion 值将覆盖此选项。

默认值： "v1"

ca_cert

别名：ssl_ca_cert

路径

用于对 API 进行身份验证的 CA 证书的路径。必须提供完整的证书链以避免证书验证错误。也可以通过 K8S_AUTH_SSL_CA_CERT 环境变量指定。

client_cert

别名：cert_file

路径

用于对 API 进行身份验证的证书的路径。也可以通过 K8S_AUTH_CERT_FILE 环境变量指定。

client_key

别名：key_file

路径

用于对 API 进行身份验证的密钥文件的路径。也可以通过 K8S_AUTH_KEY_FILE 环境变量指定。

context

字符串

配置文件中找到的上下文名称。也可以通过 K8S_AUTH_CONTEXT 环境变量指定。

field_selectors

列表 / 元素=字符串

用于过滤结果的字段选择器列表。

默认值： []

host

字符串

提供用于访问 API 的 URL。也可以通过 K8S_AUTH_HOST 环境变量指定。

impersonate_groups

列表 / 元素=字符串

kubernetes.core 2.3.0 中新增

要为操作模拟的用户组。

也可以通过 K8S_AUTH_IMPERSONATE_GROUPS 环境变量指定。例如：Group1,Group2

impersonate_user

字符串

kubernetes.core 2.3.0 中新增

要为操作模拟的用户名。

也可以通过 K8S_AUTH_IMPERSONATE_USER 环境变量指定。

kind

字符串

用于指定对象模型。

用于创建、删除或发现对象，无需提供完整的资源定义。

与 api_version、name 和 namespace 结合使用以识别特定对象。

如果提供了 resource definition，则来自 resource_definition 的 kind 值将覆盖此选项。

kubeconfig

任意

现有 Kubernetes 配置文件的路径。如果未提供，并且未提供其他连接选项，则 Kubernetes 客户端将尝试从 ~/.kube/config 加载默认配置文件。也可以通过 K8S_AUTH_KUBECONFIG 环境变量指定。

可以使用分隔符“;” (Windows 平台) 或“:” (其他平台) 提供多个 Kubernetes 配置文件。

Kubernetes 配置可以作为字典提供。此功能需要 python kubernetes 客户端版本 >= 17.17.0。在 2.2.0 版本中添加。

label_selectors

列表 / 元素=字符串

用于过滤结果的标签选择器列表。

默认值： []

name

字符串

用于指定对象名称。

用于创建、删除或发现对象，无需提供完整的资源定义。

与 api_version、kind 和 namespace 结合使用以识别特定对象。

如果提供了 resource definition，则来自 resource_definition 的 metadata.name 值将覆盖此选项。

namespace

字符串

用于指定对象命名空间。

在创建、删除或发现对象时无需提供完整的资源定义时很有用。

与 api_version、kind 和 name 结合使用以识别特定对象。

如果提供了 resource definition，则来自 resource_definition 的 metadata.namespace 值将覆盖此选项。

no_proxy

字符串

kubernetes.core 2.3.0 中新增

不应该通过代理的宿主/域名/IP/CIDR 的逗号分隔列表。也可以通过 K8S_AUTH_NO_PROXY 环境变量指定。

请注意，此模块不会从环境中获取典型的代理设置（例如 NO_PROXY）。

此功能需要 kubernetes>=19.15.0。当 kubernetes 库小于 19.15.0 时，即使 no_proxy 正确设置也会失败。

示例值是“localhost,.local,.example.com,127.0.0.1,127.0.0.0/8,10.0.0.0/8,172.16.0.0/12,192.168.0.0/16”

password

字符串

提供用于对 API 进行身份验证的密码。也可以通过 K8S_AUTH_PASSWORD 环境变量指定。

请阅读 username 选项的描述，了解此选项适用的情况。

persist_config

布尔值

是否保存 kube 配置刷新令牌。也可以通过 K8S_AUTH_PERSIST_CONFIG 环境变量指定。

当 k8s 上下文使用具有刷新令牌的用户凭据（如 oidc 或 gke/gcloud auth）时，令牌会由 k8s python 客户端库刷新，但默认情况下不会保存。因此，旧的刷新令牌可能会过期，并且下一次身份验证可能会失败。将此标志设置为 true 将告诉 k8s python 客户端将新的刷新令牌保存到 kube 配置文件。

默认为 false。

请注意，当前版本的 k8s python 客户端库尚不支持将此标志设置为 True。

此 k8s python 库的修复程序位于：https://github.com/kubernetes-client/python-base/pull/169

选项

  • false

  • true

proxy

字符串

用于连接的 HTTP 代理的 URL。也可以通过 K8S_AUTH_PROXY 环境变量指定。

请注意，此模块不会从环境中获取典型的代理设置（例如 HTTP_PROXY）。

proxy_headers

字典

kubernetes.core 2.0.0 版本中添加

用于 HTTP 代理的标头。

文档可在此处找到 https://urllib3.readthedocs.io/en/latest/reference/urllib3.util.html?highlight=proxy_headers#urllib3.util.make_headers。

basic_auth

字符串

用于基本身份验证标头的，以冒号分隔的用户名:密码。

也可以通过 K8S_AUTH_PROXY_HEADERS_BASIC_AUTH 环境变量指定。

proxy_basic_auth

字符串

用于代理基本身份验证标头的，以冒号分隔的用户名:密码。

也可以通过 K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH 环境变量指定。

user_agent

字符串

表示您想要的 user-agent 的字符串，例如 foo/1.0。

也可以通过 K8S_AUTH_PROXY_HEADERS_USER_AGENT 环境变量指定。

username

字符串

提供用于对 API 进行身份验证的用户名。也可以通过 K8S_AUTH_USERNAME 环境变量指定。

请注意，这仅适用于配置为使用 HTTP 基本身份验证的集群。如果您的集群采用不同的身份验证方式（例如 OpenShift 中的 OAuth2），则此选项将无法按预期工作，您应该查看 community.okd.k8s_auth 模块，因为它可能满足您的需求。

validate_certs

别名：verify_ssl

布尔值

是否验证 API 服务器的 SSL 证书。也可以通过 K8S_AUTH_VERIFY_SSL 环境变量指定。

选项

  • false

  • true

备注

注意

  • 当 validate_certs 为 True 时，为避免 SSL 证书验证错误，必须通过 ca_cert 或 kubeconfig 文件提供 API 服务器的完整证书链。

示例

- name: Rollback a failed deployment
  kubernetes.core.k8s_rollback:
    api_version: apps/v1
    kind: Deployment
    name: web
    namespace: testing

返回值

常用的返回值已在此处记录 此处，以下是此模块特有的字段

键

描述

rollback_info

复杂类型

已回滚的对象。

返回：成功

api_version

字符串

此对象表示的版本化模式。

返回：成功

code

字符串

响应的 HTTP 代码

返回：成功

kind

字符串

状态

返回：成功

metadata

字典

标准对象元数据。

包括名称、命名空间、注释、标签等。

返回：成功

status

字典

对象的当前状态详细信息。

返回：成功

作者

  • Julien Huon (@julienhuon)