Модуль kubernetes.core.k8s_info — описание объектов Kubernetes (K8s)

Примечание

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

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

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

Чтобы использовать его в плейбуке, укажите: kubernetes.core.k8s_info.

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Использует клиент Kubernetes для Python для выполнения операций чтения с объектами K8s.
Обеспечивает доступ ко всему набору API K8s.
Поддерживает аутентификацию с помощью файла конфигурации, сертификатов, пароля или токена.
Поддерживает режим проверки.
До Ansible 2.9 этот модуль назывался k8s_facts. Использование не изменилось.

Примечание

У этого модуля есть соответствующий модуль действий.

Псевдонимы: helm, helm_info, helm_plugin, helm_plugin_info, helm_repository, k8s, k8s_cluster_info, k8s_cp, k8s_drain, k8s_exec, k8s_json_patch, k8s_log, k8s_rollback, k8s_scale, k8s_service

Требования

На узле, который выполняет этот модуль, необходимы следующие компоненты.

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 для идентификации определенного объекта. Если указано определение ресурса, значение 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.
context строка	Имя контекста из файла конфигурации. Также можно задать с помощью переменной окружения K8S_AUTH_CONTEXT.
field_selectors список / элементы=строка	Список селекторов полей для фильтрации результатов По умолчанию: `[]`
hidden_fields список / элементы=строка добавлено в kubernetes.core 3.0.0	Скрывает поля в результате, соответствующие любому из заданных определений полей Например, это может быть `hidden_fields=[metadata.managedFields]` или `hidden_fields=[spec.containers[0].env[3].value]` или `hidden_fields=[metadata.annotations[kubectl.kubernetes.io/last-applied-configuration]]`
host строка	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 для идентификации определенного объекта. Если указано определение ресурса, значение kind из resource_definition переопределит этот параметр.
kubeconfig любой тип	Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно задать с помощью переменной окружения K8S_AUTH_KUBECONFIG. Можно указать несколько файлов конфигурации Kubernetes, используя разделитель ‘;’ в Windows или ‘:’ на других платформах. Конфигурацию Kubernetes можно указать в виде словаря. Для этой возможности требуется версия клиента Kubernetes для Python >= 17.17.0. Добавлено в версии 2.2.0.
label_selectors список / элементы=строка	Список селекторов меток для фильтрации результатов По умолчанию: `[]`
name строка	Указывает имя объекта. Используется для создания, удаления или обнаружения объекта без указания полного определения ресурса. Используется вместе с api_version, kind и namespace для идентификации определенного объекта. Если указано определение ресурса, значение metadata.name из resource_definition переопределит этот параметр.
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”
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 находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `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 строка	Строка, задающая требуемый user-agent, например foo/1.0. Также можно задать с помощью переменной окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
username строка	Имя пользователя для аутентификации в 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`
wait логический	Ожидать ли, пока определенные типы ресурсов не перейдут в требуемое состояние. По умолчанию модуль завершает работу сразу после того, как Kubernetes получит запрос. Реализовано для `state=present` для `Deployment`, `DaemonSet` и `Pod`, а также для `state=absent` для всех типов ресурсов. Для типов ресурсов без реализации `wait` немедленно возвращает управление, если не задано `wait_condition`. Варианты: `false` ← (по умолчанию) `true`
wait_condition словарь	Задает пользовательское условие для поля status, которого необходимо дождаться. Игнорируется, если `wait` не задано или имеет значение False.
reason строка	Значение поля reason в требуемом условии Например, если `Deployment` приостановлен, `Progressing` `type` будет иметь причину `DeploymentPaused`. Возможные причины в условии зависят от типа ресурса Kubernetes. Возможные значения см. в документации API для поля status соответствующего ресурса.
status строка	Значение поля status в требуемом условии. Например, если `Deployment` приостановлен, `Progressing` `type` будет иметь статус `Unknown`. Варианты: `"True"` ← (по умолчанию) `"False"` `"Unknown"`
type строка	Тип условия, которого необходимо дождаться. Например, для ресурса `Pod` будет установлено условие `Ready` (среди прочих). Обязательный параметр, если указано `wait_condition`. Если оставить поле пустым, поле `wait_condition` будет проигнорировано. Возможные типы условия зависят от типа ресурса Kubernetes. Возможные значения см. в документации API для поля status соответствующего ресурса.
wait_sleep целое число	Количество секунд ожидания между проверками. По умолчанию: `5`
wait_timeout целое число	Время ожидания в секундах, в течение которого ресурс должен перейти в требуемое состояние. Игнорируется, если `wait` не задано. По умолчанию: `120`

Примечания

Примечание

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

Примеры

- name: Get an existing Service object
  kubernetes.core.k8s_info:
    api_version: v1
    kind: Service
    name: web
    namespace: testing
  register: web_service

- name: Get a list of all service objects
  kubernetes.core.k8s_info:
    api_version: v1
    kind: Service
    namespace: testing
  register: service_list

- name: Get a list of all pods from any namespace
  kubernetes.core.k8s_info:
    kind: Pod
  register: pod_list

- name: Search for all Pods labelled app=web
  kubernetes.core.k8s_info:
    kind: Pod
    label_selectors:
      - app = web
      - tier in (dev, test)

- name: Using vars while using label_selectors
  kubernetes.core.k8s_info:
    kind: Pod
    label_selectors:
      - "app = {{ app_label_web }}"
  vars:
    app_label_web: web

- name: Search for all running pods
  kubernetes.core.k8s_info:
    kind: Pod
    field_selectors:
      - status.phase=Running

- name: List custom objects created using CRD
  kubernetes.core.k8s_info:
    kind: MyCustomObject
    api_version: "stable.example.com/v1"

- name: Wait till the Object is created
  kubernetes.core.k8s_info:
    kind: Pod
    wait: yes
    name: pod-not-yet-created
    namespace: default
    wait_sleep: 10
    wait_timeout: 360

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
api_found логический	Удалось ли сопоставить указанные api_version и kind с существующим API в целевом кластере. Добавлено в версии 1.2.0. Возвращается: всегда
resources сложный тип	Существующие объекты Возвращается: при успешном выполнении
api_version строка	Версионированная схема представления объекта. Возвращается: при успешном выполнении
kind строка	Представляет ресурс REST, который описывает этот объект. Возвращается: при успешном выполнении
metadata словарь	Стандартные метаданные объекта. Включают имя, пространство имен, аннотации, метки и т. д. Возвращается: при успешном выполнении
spec словарь	Определенные атрибуты объекта. Зависят от значений api_version и kind. Возвращается: при успешном выполнении
status словарь	Сведения о текущем состоянии объекта. Возвращается: при успешном выполнении

Авторы

Will Thames (@willthames)

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

© 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_info_module.html