Модуль kubernetes.core.k8s_rollback – Откат развертываний и демонов Kubernetes (K8S)

api_key

string

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

api_version

aliases: api, version

string

Используется для указания версии API.

Используется для создания, удаления или обнаружения объекта без предоставления полного определения ресурса.

Используется в сочетании с kind, name и namespace для идентификации конкретного объекта.

Если предоставлено определение ресурса, значение apiVersion из resource_definition переопределит этот параметр.

Default: "v1"

ca_cert

aliases: ssl_ca_cert

path

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

client_cert

aliases: cert_file

path

Путь к сертификату, используемому для аутентификации с API. Может быть также указан через переменную окружения K8S_AUTH_CERT_FILE.

client_key

aliases: key_file

path

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

context

string

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

field_selectors

list / elements=string

Список селекторов полей, используемых для фильтрации результатов.

Default: []

host

string

Предоставьте URL для доступа к API. Может быть также указан через переменную окружения K8S_AUTH_HOST.

impersonate_groups

list / elements=string

added in kubernetes.core 2.3.0

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

Может быть также указана через переменную окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2

impersonate_user

string

added in kubernetes.core 2.3.0

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

Может быть также указана через переменную окружения K8S_AUTH_IMPERSONATE_USER.

kind

string

Используется для указания модели объекта.

Используется для создания, удаления или обнаружения объекта без предоставления полного определения ресурса.

Используется в сочетании с api_version, name и namespace для идентификации конкретного объекта.

Если предоставлено определение ресурса, значение kind из resource_definition переопределит этот параметр.

kubeconfig

any

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

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

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

label_selectors

list / elements=string

Список селекторов меток, используемых для фильтрации результатов.

Default: []

name

string

Используется для указания имени объекта.

Используется для создания, удаления или обнаружения объекта без предоставления полного определения ресурса.

Используется в сочетании с api_version, kind и namespace для идентификации конкретного объекта.

Если предоставлено определение ресурса, значение metadata.name из resource_definition переопределит этот параметр.

namespace

string

Используется для указания пространства имен объекта.

Полезно при создании, удалении или обнаружении объекта без предоставления полного определения ресурса.

Используется в сочетании с 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

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

Строка, представляющая пользователя-агента, например, 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