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

Примечание

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

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

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

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

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

Описание

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

Примечание

Данному модулю соответствует плагин действия.

Требования

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

python >= 3.9
kubernetes >= 24.2.0
PyYAML >= 3.11

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
api_key строка	Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
api_version псевдонимы: api, версия строка	Используется для указания версии 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 2.5.0	Скрыть поля, соответствующие любым определениям полей в результате Пример: `hidden_fields=[metadata.managedFields]` Поддерживаются только определения полей, которые не ссылаются на элементы списка (например, `spec.containers[0]` не сработает)
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 можно предоставить в виде словаря. Эта функция требует версии python kubernetes client >= 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 string added in 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 auth), токен обновляется библиотекой k8s на Python, но по умолчанию не сохраняется. Поэтому старый токен обновления может истечь, и последующая аутентификация может завершиться ошибкой. Установка этого флага в значение true укажет библиотеке k8s на Python сохранить новый токен обновления в файл конфигурации kube. По умолчанию false. Обратите внимание, что текущая версия библиотеки k8s на Python пока не поддерживает установку этого флага в значение True. Исправление для этой библиотеки k8s на Python находится здесь: https://github.com/kubernetes-client/python-base/pull/169 Варианты: `false` `true`
proxy string	URL HTTP-прокси-сервера, который нужно использовать для подключения. Также может быть задан через переменную среды K8S_AUTH_PROXY. Обратите внимание, что этот модуль не подхватывает стандартные настройки прокси из среды (например, HTTP_PROXY).
proxy_headers dictionary added in 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	Имя пользователя и пароль для аутентификации по протоколу Basic через двоеточие. Также может быть задан через переменную среды K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.
proxy_basic_auth string	Имя пользователя и пароль для аутентификации по протоколу Basic через прокси, разделенные двоеточием. Также может быть задан через переменную среды K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent string	Строковое представление пользовательского агента, например, foo/1.0. Также может быть задан через переменную среды K8S_AUTH_PROXY_HEADERS_USER_AGENT.
username string	Укажите имя пользователя для аутентификации с API. Также может быть задан через переменную среды K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если ваш кластер использует другой метод аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом. В этом случае обратитесь к модулю community.okd.k8s_auth, который может подойти для ваших задач.
validate_certs aliases: verify_ssl boolean	Верифицировать ли SSL-сертификаты сервера API. Также может быть задан через переменную среды K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`
wait boolean	Ожидать ли, пока определенные типы ресурсов окажутся в нужном состоянии. По умолчанию модуль завершается, как только Kubernetes получит запрос. Реализовано для `state=present` для `Deployment`, `DaemonSet` и `Pod`, и для `state=absent` для всех типов ресурсов. Для типов ресурсов без реализации `wait` возвращается немедленно, если `wait_condition` не задано. Варианты: `false` ← (по умолчанию) `true`
wait_condition dictionary	Указывает пользовательское условие для ожидания в статусе. Игнорируется, если `wait` не установлено или установлено в значение False.
reason string	Значение поля reason в желаемом условии. Например, если `Deployment` приостановлен, в поле `Progressing` `type` будет установлено значение `DeploymentPaused`. Возможные значения reason зависят от типа ресурса в Kubernetes. См. документацию API поля status для данного ресурса, чтобы увидеть возможные варианты.
status string	Значение поля status в желаемом условии. Например, если `Deployment` приостановлен, в поле `Progressing` `type` будет установлено значение `Unknown`. Варианты: `"True"` ← (по умолчанию) `"False"` `"Unknown"`
type string	Тип условия, для которого нужно дождаться. Например, для ресурса `Pod` будет установлено условие `Ready` (и другие). Необходимо, если вы задаете `wait_condition`. Если оставлено пустым, поле `wait_condition` будет проигнорировано. Возможные типы условий зависят от типа ресурса в Kubernetes. См. документацию API поля status для данного ресурса, чтобы увидеть возможные варианты.

wait_sleep integer	Количество секунд ожидания между проверками. По умолчанию: `5`
wait_timeout integer	Время ожидания в секундах, пока ресурс не перейдет в нужное состояние. Игнорируется, если `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 boolean	Указывает, были ли успешно сопоставлены указанные api_version и kind с существующим API на целевом кластере. Версия добавлена 1.2.0. Возвращается: всегда
resources complex	Объект(ы), который(е) существует(ют). Возвращается: успех
api_version string	Версионированный шаблон представления объекта. Возвращается: успех
kind string	Представляет REST-ресурс, который представляет этот объект. Возвращается: успех
metadata dictionary	Стандартные метаданные объекта. Включает имя, пространство имён, аннотации, метки и т.д. Возвращается: успех
spec dictionary	Специфические атрибуты объекта. Будут различаться в зависимости от api_version и kind. Возвращается: успех
status dictionary	Текущие сведения о состоянии объекта. Возвращается: успех

Авторы

Will Thames (@willthames)

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

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