Модуль kubernetes.core.k8s_log — получение журналов ресурсов Kubernetes

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 6.4.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install kubernetes.core. Для работы с этим модулем требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: 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`, получить журналы всех контейнеров в подах. Взаимоисключающий параметр с `container`. Варианты: `false` `true`
api_key string	Токен для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_API_KEY.
api_version псевдонимы: api, version string	Указывает версию API. Используется для создания, удаления или обнаружения объекта без предоставления полного описания ресурса. Используется вместе с kind, name и namespace для идентификации определенного объекта. Если указано описание ресурса, значение apiVersion из resource_definition переопределит этот параметр. По умолчанию: `"v1"`
ca_cert псевдонимы: ssl_ca_cert path	Путь к сертификату CA, используемому для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо указать полную цепочку сертификатов. Также можно задать с помощью переменной окружения 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	Указывает контейнер в поде, из которого нужно получить журнал. Если контейнер только один, по умолчанию будет выбран он. Если контейнеров несколько, этот параметр обязателен, либо задайте для all_containers значение `true`. Взаимоисключающий параметр с `all_containers`.
context string	Имя контекста из файла конфигурации. Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.
host string	URL для доступа к API. Также можно задать с помощью переменной окружения 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. Можно указать несколько файлов конфигурации Kubernetes, разделив их символом «;» в Windows или «:» на других платформах. Конфигурацию Kubernetes можно передать в виде словаря. Для этой возможности требуется версия клиента Kubernetes для Python не ниже 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 для идентификации определенного объекта. Если указано описание ресурса, значение metadata.namespace из resource_definition переопределит этот параметр.
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 находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
previous boolean добавлено в kubernetes.core 2.4.0	Если `true`, вывести журналы предыдущего экземпляра контейнера в поде, если он существует. Варианты: `false` ← (по умолчанию) `true`
proxy string	URL HTTP-прокси, используемого для подключения. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY. Обратите внимание: этот модуль не использует стандартные настройки прокси из окружения (например, HTTP_PROXY).
proxy_headers dictionary добавлено в 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 integer добавлено в kubernetes.core 2.4.0	Количество строк журнала с конца, которые нужно получить.
username string	Имя пользователя для аутентификации в API. Также можно задать с помощью переменной окружения K8S_AUTH_USERNAME. Обратите внимание: этот параметр работает только с кластерами, настроенными на использование базовой HTTP-аутентификации. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом. В таком случае обратитесь к модулю community.okd.k8s_auth — возможно, он подойдет для вашей задачи.
validate_certs псевдонимы: verify_ssl boolean	Проверять ли SSL-сертификаты сервера API. Также можно задать с помощью переменной окружения K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`

Примечания

Примечание

Чтобы избежать ошибок проверки SSL-сертификатов, когда для validate_certs задано значение True, необходимо указать полную цепочку сертификатов сервера API с помощью ca_cert или в файле kubeconfig.

Примеры

- 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)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/kubernetes/core/k8s_log_module.html