Модуль kubernetes.core.k8s_log — Получение логов из ресурсов Kubernetes

Примечание

Этот модуль входит в коллекцию kubernetes.core (версия 3.2.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 путь	Путь к сертификату CA, используемому для аутентификации с API. Для избежания ошибок валидации сертификата необходимо предоставить полный цепочку сертификатов. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT.
client_cert псевдонимы: cert_file путь	Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE.
client_key псевдонимы: key_file путь	Путь к файлу ключа, используемому для аутентификации с 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 список / элементы=строка добавлен в 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 для идентификации конкретного объекта. Если используется label_selectors, не может быть переопределен. По умолчанию: `"Pod"`
kubeconfig любой	Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, Kubernetes клиент попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG. Несколько файлов конфигурации Kubernetes могут быть предоставлены с разделителем ‘;’ для платформы Windows или ‘:’ для других платформ. Конфигурация Kubernetes может быть предоставлена в виде словаря. Эта функция требует библиотеки Python kubernetes версии ≥ 17.17.0. Добавлен в версии 2.2.0.
label_selectors список / элементы=строка	Список селекторов меток для фильтрации результатов. Только один из name или label_selectors может быть предоставлен. По умолчанию: `[]`
name строка	Используется для указания имени объекта. Используется совместно с api_version, kind и namespace для идентификации конкретного объекта. Только один из name или label_selectors может быть предоставлен.
namespace строка	Используется для указания пространства имен объекта. Полезно при создании, удалении или обнаружении объекта без предоставления полного определения ресурса. Используется совместно с api_version, kind и name для идентификации конкретного объекта. Если предоставлено определение ресурса, значение metadata.namespace из resource_definition переопределит этот параметр.
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”

END_OF_DOCUMENT_MARKER

пароль строка	Укажите пароль для аутентификации с 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`
previous логическое значение добавлен в kubernetes.core 2.4.0	Если `true`, выводить логи для предыдущего экземпляра контейнера в подсети, если он существует. Варианты: `false` ← (по умолчанию) `true`
proxy строка	URL HTTP-прокси для подключения. Также можно указать через переменную окружения 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 строка	Строка, представляющая пользовательского агента, например, foo/1.0. Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
since_seconds строка добавлен в kubernetes.core 2.2.0	Относительное время в секундах до текущего времени, с которого нужно выводить логи.
tail_lines целое число добавлен в kubernetes.core 2.4.0	Количество строк с конца логов для получения.
имя пользователя строка	Укажите имя пользователя для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер использует другой тип аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует изучить модуль community.okd.k8s_auth, так как он может выполнить необходимые действия.
validate_certs псевдонимы: verify_ssl логическое значение	Проверять ли 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_lines список / элементы=строка	Лог объекта, разделенный на новые строки Возвращаемое значение: успех

Авторы

Fabian von Feilitzsch (@fabianvf)

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

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