Модуль kubernetes.core.k8s_cluster_info — описание кластера Kubernetes (K8s), доступных API и их версий

api_key

string

Токен, используемый для аутентификации в API. Также можно указать с помощью переменной среды K8S_AUTH_API_KEY.

ca_cert

псевдонимы: ssl_ca_cert

path

Путь к сертификату CA, используемому для аутентификации в API. Чтобы избежать ошибок проверки сертификата, необходимо указать полную цепочку сертификатов. Также можно указать с помощью переменной среды K8S_AUTH_SSL_CA_CERT.

client_cert

псевдонимы: cert_file

path

Путь к сертификату, используемому для аутентификации в API. Также можно указать с помощью переменной среды K8S_AUTH_CERT_FILE.

client_key

псевдонимы: key_file

path

Путь к файлу ключа, используемого для аутентификации в API. Также можно указать с помощью переменной среды K8S_AUTH_KEY_FILE.

context

string

Имя контекста, указанного в файле конфигурации. Также можно указать с помощью переменной среды K8S_AUTH_CONTEXT.

host

string

URL для доступа к API. Также можно указать с помощью переменной среды K8S_AUTH_HOST.

impersonate_groups

list / элементы=string

добавлено в kubernetes.core 2.3.0

Группа или группы, от имени которых выполняется операция.

Также можно указать с помощью переменной среды K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2

impersonate_user

string

добавлено в kubernetes.core 2.3.0

Имя пользователя, от имени которого выполняется операция.

Также можно указать с помощью переменной среды K8S_AUTH_IMPERSONATE_USER.

invalidate_cache

boolean

Инвалидировать кэш перед получением сведений о кластере.

Варианты:

• false
• true ← (по умолчанию)

kubeconfig

any

Путь к существующему файлу конфигурации Kubernetes. Если путь не указан и не заданы другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно указать с помощью переменной среды K8S_AUTH_KUBECONFIG.

Можно указать несколько файлов конфигурации Kubernetes, используя разделитель «;» в Windows или «:» на других платформах.

Конфигурацию Kubernetes можно указать в виде словаря. Для этой возможности требуется версия клиента kubernetes для Python >= 17.17.0. Добавлено в версии 2.2.0.

no_proxy

string

добавлено в 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 config. Также можно указать с помощью переменной среды K8S_AUTH_PERSIST_CONFIG.

Если в контексте k8s используются учетные данные пользователя с токенами обновления (например, oidc или gke/gcloud auth), библиотека клиента k8s для Python обновляет токен, но по умолчанию не сохраняет его. Поэтому срок действия старого токена обновления может истечь, и следующая аутентификация завершится ошибкой. Если установить этот флаг в true, клиент k8s для Python сохранит новый токен обновления в файл kube config.

По умолчанию — false.

Обратите внимание: текущая версия библиотеки клиента k8s для Python пока не поддерживает установку этого флага в True.

Исправление для этой библиотеки k8s доступно здесь: https://github.com/kubernetes-client/python-base/pull/169

Варианты:

• false
• true

proxy

string

URL HTTP-прокси, используемого для подключения. Также можно указать с помощью переменной среды K8S_AUTH_PROXY.

Обратите внимание: модуль не использует стандартные настройки прокси из среды (например, HTTP_PROXY).

proxy_headers

dictionary

добавлено в 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

Имя пользователя и пароль через двоеточие для заголовка базовой аутентификации.

Также можно указать с помощью переменной среды K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.

proxy_basic_auth

string

Имя пользователя и пароль через двоеточие для заголовка базовой аутентификации прокси.

Также можно указать с помощью переменной среды K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.

user_agent

string

Строка, представляющая нужный user-agent, например foo/1.0.

Также можно указать с помощью переменной среды K8S_AUTH_PROXY_HEADERS_USER_AGENT.

username

string

Имя пользователя для аутентификации в API. Также можно указать с помощью переменной среды K8S_AUTH_USERNAME.

Обратите внимание: этот параметр работает только с кластерами, настроенными на использование базовой HTTP-аутентификации. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать ожидаемым образом. В таком случае изучите модуль community.okd.k8s_auth: возможно, он подойдет для вашей задачи.

validate_certs

псевдонимы: verify_ssl

boolean

Проверять ли SSL-сертификаты API-сервера. Также можно указать с помощью переменной среды K8S_AUTH_VERIFY_SSL.

Варианты:

• false
• true

apis

dictionary

Словарь групп и версий ресурсов, найденных в кластере

Возвращается: при успехе

categories

list / элементы=string

Категории API

Возвращается: при успехе

name

string

Краткое имя ресурса

Возвращается: при успехе

namespaced

boolean

Имеет ли ресурс пространство имен

Возвращается: при успехе

preferred

boolean

Является ли версия ресурса предпочтительной

Возвращается: при успехе

short_names

string

Краткие имена ресурса

Возвращается: при успехе

singular_name

string

Имя ресурса в единственном числе

Возвращается: при успехе

connection

dictionary

Сведения о подключении

Возвращается: при успехе

cert_file

string

Путь к сертификату клиента.

Возвращается: при успехе

host

string

URL узла

Возвращается: при успехе

password

string

Пароль пользователя

Возвращается: при успехе

proxy

string

Сведения о прокси

Возвращается: при успехе

ssl_ca_cert

string

Путь к сертификату CA

Возвращается: при успехе

username

string

Имя пользователя

Возвращается: при успехе

verify_ssl

boolean

Статус проверки SSL

Возвращается: при успехе

version

dictionary

Сведения о версиях сервера и клиента

Возвращается: при успехе

client

string

Версия клиента

Возвращается: при успехе

server

dictionary

Версия сервера

Возвращается: при успехе