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

api_key

string

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

api_version

псевдонимы: api, version

string

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

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

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

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

По умолчанию: "v1"

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.

field_selectors

list / elements=string

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

По умолчанию: []

host

string

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

impersonate_groups

list / elements=string

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

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

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

impersonate_user

string

добавлено в 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 можно указать в виде словаря. Для этой возможности требуется версия клиента Kubernetes для Python >= 17.17.0. Добавлено в версии 2.2.0.

label_selectors

list / elements=string

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

По умолчанию: []

name

string

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

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

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

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

namespace

string

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

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

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

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

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

Сохранять ли токены обновления kubeconfig. Также можно указать с помощью переменной окружения K8S_AUTH_PERSIST_CONFIG.

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

По умолчанию — 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 Basic Auth. Если в кластере используется другой способ аутентификации (например, OAuth2 в OpenShift), этот параметр не будет работать должным образом. В этом случае обратитесь к модулю community.okd.k8s_auth — возможно, он подойдёт для вашей задачи.

validate_certs

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

boolean

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

Варианты:

• false
• true

rollback_info

complex

Объект, для которого выполнен откат.

Возвращается: success

api_version

string

Версионированная схема представления этого объекта.

Возвращается: success

code

string

Код HTTP-ответа

Возвращается: success

kind

string

Статус

Возвращается: success

metadata

dictionary

Стандартные метаданные объекта.

Включает имя, пространство имён, аннотации, метки и т. д.

Возвращается: success

status

dictionary

Сведения о текущем статусе объекта.

Возвращается: success