community.okd.openshift_adm_prune_builds 模块 – 修剪旧的已完成和失败的构建

注意

此模块是 community.okd 集合 (版本 4.0.0) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install community.okd。您需要满足其他要求才能使用此模块，请参阅 要求 以了解详情。

要在 playbook 中使用它，请指定：community.okd.openshift_adm_prune_builds。

community.okd 2.3.0 中的新增功能

概要

  • 此模块允许管理员删除旧的已完成和失败的构建。

  • 类似于 oc adm prune builds。

要求

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

  • python >= 3.6

  • kubernetes >= 12.0.0

参数

参数

注释

api_key

字符串

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

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 环境变量指定。

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 环境变量指定。

keep_younger_than

整数

指定构建被认为是修剪候选者的最小年龄（以分钟为单位）。

kubeconfig

任意

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

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

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

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”

orphans

布尔值

如果 true，则修剪所有关联的 BuildConfig 不再存在且状态为已完成、失败、错误或已取消的构建。

选项

  • false ← (默认)

  • true

password

字符串

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

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

persist_config

布尔值

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

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

默认为 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 代理的 Header。

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

basic_auth

字符串

用于基本身份验证 header 的冒号分隔的用户名:密码。

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

proxy_basic_auth

字符串

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

也可以通过 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 服务器的完整证书链。

示例

# Run deleting older completed and failed builds and also including
# all builds whose associated BuildConfig no longer exists
- name: Run delete orphan Builds
  community.okd.openshift_adm_prune_builds:
    orphans: true

# Run deleting older completed and failed builds keep younger than 2hours
- name: Run delete builds, keep younger than 2h
  community.okd.openshift_adm_prune_builds:
    keep_younger_than: 120

# Run deleting builds from specific namespace
- name: Run delete builds from namespace
  community.okd.openshift_adm_prune_builds:
    namespace: testing_namespace

返回值

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

键

描述

builds

复杂类型

已删除的构建

返回：成功

api_version

字符串

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

返回：成功

kind

字符串

表示此对象表示的 REST 资源。

返回：成功

metadata

字典

标准对象元数据。包括名称、命名空间、注释、标签等。

返回：成功

spec

字典

对象的特定属性。将根据api_version和kind而有所不同。

返回：成功

status

字典

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

返回：成功

作者

  • Aubin Bikouo (@abikouo)