community.kubernetes.k8s_cluster_info – Описание кластера Kubernetes (K8s), доступные API и их версии

Примечание

Этот плагин входит в сборку community.kubernetes (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install community.kubernetes

Для использования в книге задач укажите: community.kubernetes.k8s_cluster_info

Новое в версии 0.11.1: сборки community.kubernetes

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

Обзор

Используйте клиент OpenShift Python для выполнения операций чтения над объектами K8s.
Авторизуйтесь, используя файл конфигурации, сертификаты, пароль или токен.
Поддерживает режим проверки.

Требования

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

python >= 2.7
openshift >= 0.6
PyYAML >= 3.11

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
api_key строка		Токен, используемый для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_API_KEY.
ca_cert путь		Путь к сертификату CA, используемому для аутентификации с API. Необходимо предоставить весь цепочку сертификатов, чтобы избежать ошибок валидации сертификата. Также может быть указан через переменную окружения K8S_AUTH_SSL_CA_CERT. алиасы: ssl_ca_cert
client_cert путь		Путь к сертификату, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_CERT_FILE. алиасы: cert_file
client_key путь		Путь к файлу ключа, используемому для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_KEY_FILE. алиасы: key_file
context строка		Имя контекста, найденного в файле конфигурации. Также может быть указан через переменную окружения K8S_AUTH_CONTEXT.
host строка		Укажите URL для доступа к API. Также может быть указан через переменную окружения K8S_AUTH_HOST.
invalidate_cache булево	Варианты: no да ←	Очистить кэш перед получением информации о кластере.
kubeconfig путь		Путь к существующему файлу конфигурации Kubernetes. Если не указано и другие параметры подключения не предоставлены, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG.
password строка		Укажите пароль для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_PASSWORD. Пожалуйста, прочитайте описание параметра `username` для обсуждения, когда этот параметр применим.
persist_config булево	Варианты: no yes	Сохранять ли токены обновления конфигурации 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
proxy строка		URL HTTP-прокси, который необходимо использовать для подключения. Также может быть указан через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не собирает типичные настройки прокси из среды (например, HTTP_PROXY).
username строка		Укажите имя пользователя для аутентификации с API. Также может быть указан через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными на использование HTTP Basic Auth. Если ваш кластер имеет другой тип аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом, и вам следует изучить модуль `k8s_auth`, так как он может выполнить то, что вам нужно.
validate_certs булево	Варианты: no yes	Проверять ли SSL-сертификаты сервера API. Также может быть указан через переменную окружения K8S_AUTH_VERIFY_SSL. алиасы: verify_ssl

Примечания

Примечание

Клиент OpenShift Python оборачивает клиент K8s Python, предоставляя полный доступ ко всем API и моделям, доступным на обеих платформах. Подробную информацию о версиях API и дополнительную информацию можно найти по адресу https://github.com/openshift/openshift-restclient-python
Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, полная цепочка сертификатов сервера API должна быть предоставлена через ca_cert или в файле kubeconfig.

Примеры

- name: Get Cluster information
  community.kubernetes.k8s_cluster_info:
  register: api_status

- name: Do not invalidate cache before getting information
  community.kubernetes.k8s_cluster_info:
    invalidate_cache: False
  register: api_status

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

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

Ключ		Возвращаемое значение	Описание
apis словарь		успех	API(и), которые существуют в словаре
	api_version строка	успех	Версия API
	available_api_version список / элементы=строка	успех	Все доступные версии данного API
	categories список / элементы=строка	успех	Категории API
	group_version строка	успех	Версия группы ресурсов
	kind строка	успех	Тип ресурса
	name строка	успех	Короткое имя ресурса
	namespaced логическое значение	успех	Если ресурс имеет имя пространства имён
	preferred логическое значение	успех	Если версия ресурса предпочтительна
	preferred_api_version строка	успех	Предпочтительная версия данного API
	short_names строка	успех	Короткие имена ресурсов
	singular_name строка	успех	Единственное имя ресурса
connection словарь		успех	Информация о подключении
	cert_file строка	успех	Путь к клиенту сертификата.
	host строка	успех	URL хоста
	password строка	успех	Пароль пользователя
	proxy строка	успех	Детали прокси
	ssl_ca_cert строка	успех	Путь к сертификату CA
	username строка	успех	Имя пользователя
	verify_ssl логическое значение	успех	Статус проверки SSL
version словарь		успех	Информация о версии сервера и клиента
	client строка	успех	Версия клиента
	server словарь	успех	Версия сервера

Авторы

Abhijeet Kasurde (@Akasurde)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/kubernetes/k8s_cluster_info_module.html