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

api_key

строка

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

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.

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.

invalidate_cache

булево

Очистить кэш перед получением информации о кластере.

Варианты:

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

kubeconfig

любой

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

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

Конфигурация Kubernetes может быть предоставлена в виде словаря. Эта функция требует версии python kubernetes client >= 17.17.0. Добавлено в версии 2.2.0.

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 python находится здесь: 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

строка

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

Также можно указать через переменную окружения K8S_AUTH_PROXY_HEADERS_BASIC_AUTH.

proxy_basic_auth

string

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

Также может быть указано через переменную окружения 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