kubernetes.core.k8s_log 模块 – 从 Kubernetes 资源获取日志

注意

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

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

要安装它，请使用：ansible-galaxy collection install kubernetes.core。您需要进一步的要求才能使用此模块，请参阅 要求 以了解详细信息。

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

kubernetes.core 0.10.0 中的新增功能

概要

  • 使用 Kubernetes Python 客户端对 K8s 日志端点执行读取操作。

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

  • 支持检查模式。

  • 类似于 `kubectl logs` 或 `oc logs`

注意

此模块具有相应的 操作插件。

要求

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

  • python >= 3.9

  • kubernetes >= 24.2.0

  • PyYAML >= 3.11

参数

参数

注释

all_containers

boolean

在 kubernetes.core 2.4.0 中添加

如果设置为 true，则检索 pod 中所有容器的日志。

与 container 互斥。

选择

  • false

  • true

api_key

string

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

api_version

别名：api, version

string

用于指定 API 版本。

用于在不提供完整资源定义的情况下创建、删除或发现对象。

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

如果提供了 资源定义，则 resource_definition 中的 apiVersion 值将覆盖此选项。

默认： "v1"

ca_cert

别名：ssl_ca_cert

path

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

client_cert

别名：cert_file

path

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

client_key

别名：key_file

path

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

container

string

用于指定从中获取日志的 pod 中的容器。

如果只有一个容器，则默认使用该容器。

如果存在多个容器，则此选项是必需的，或者将 all_containers 设置为 true。

与 all_containers 互斥。

context

string

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

host

string

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

impersonate_groups

list / elements=string

在 kubernetes.core 2.3.0 中添加

操作要模拟的组。

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

impersonate_user

string

在 kubernetes.core 2.3.0 中添加

操作要模拟的用户名。

也可以通过 K8S_AUTH_IMPERSONATE_USER 环境指定。

kind

string

用于指定对象模型。

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

如果使用 label_selectors，则不能覆盖。

默认： "Pod"

kubeconfig

any

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

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

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

label_selectors

list / elements=string

用于筛选结果的标签选择器列表

name 和 label_selectors 只能提供其中一个。

默认值: []

name

string

用于指定对象名称。

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

name 和 label_selectors 只能提供其中一个。

namespace

string

用于指定对象命名空间。

在创建、删除或发现对象时，如果未提供完整的资源定义，则此选项非常有用。

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

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

no_proxy

string

在 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

string

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

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

persist_config

boolean

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

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

默认为 false。

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

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

选择

  • false

  • true

previous

boolean

在 kubernetes.core 2.4.0 中添加

如果为 true，则打印 pod 中容器上一个实例的日志（如果存在）。

选择

  • false ← (默认)

  • true

proxy

string

用于连接的 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

string

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

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

proxy_basic_auth

string

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

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

user_agent

string

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

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

since_seconds

string

在 kubernetes.core 2.2.0 中添加

显示日志的相对于当前时间的秒数。

tail_lines

整数

在 kubernetes.core 2.4.0 中添加

要检索的日志末尾的行数。

username

string

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

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

validate_certs

别名: verify_ssl

boolean

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

选择

  • false

  • true

注释

注意

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

示例

- name: Get a log from a Pod
  kubernetes.core.k8s_log:
    name: example-1
    namespace: testing
  register: log

# This will get the log from the first Pod found matching the selector
- name: Log a Pod matching a label selector
  kubernetes.core.k8s_log:
    namespace: testing
    label_selectors:
    - app=example
  register: log

# This will get the log from a single Pod managed by this Deployment
- name: Get a log from a Deployment
  kubernetes.core.k8s_log:
    api_version: apps/v1
    kind: Deployment
    namespace: testing
    name: example
    since_seconds: "4000"
  register: log

# This will get the log from a single Pod managed by this DeploymentConfig
- name: Get a log from a DeploymentConfig
  kubernetes.core.k8s_log:
    api_version: apps.openshift.io/v1
    kind: DeploymentConfig
    namespace: testing
    name: example
    tail_lines: 100
  register: log

# This will get the logs from all containers in Pod
- name: Get the logs from all containers in pod
  kubernetes.core.k8s_log:
    namespace: testing
    name: some-pod
    all_containers: true

返回值

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

键

描述

log

string

对象的文本日志

返回: 成功

log_lines

list / elements=string

对象的日志，按换行符分割

返回: 成功

作者

  • Fabian von Feilitzsch (@fabianvf)