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 булево	Варианты: нет да ←	Очистить кэш перед получением информации о кластере.
kubeconfig путь		Путь к существующему файлу конфигурации Kubernetes. Если не указано и не указаны другие параметры подключения, клиент openshift попытается загрузить файл конфигурации по умолчанию из ~/.kube/config.json. Также может быть указан через переменную окружения K8S_AUTH_KUBECONFIG.
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 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 булево	Варианты: нет да	Проверять или нет 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/kubernetes/k8s_cluster_info_module.html