Модуль kubernetes.core.k8s_json_patch – Применение операций JSON-патча к существующим объектам

api_key

string

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

api_version

aliases: api, version

string

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

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

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.

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 / required

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

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

kubeconfig

any

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

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

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

name

string / required

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

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

namespace

string

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

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

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 для обсуждения того, когда этот параметр применим.

patch

list / elements=dictionary / required

Список операций JSON patch.

persist_config

boolean

Сохранять ли обновленные токены kube config. Может быть также указан через переменную среды K8S_AUTH_PERSIST_CONFIG.

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

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

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

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

Choices:

• 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

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

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

proxy_basic_auth

string

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

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

wait

boolean

Ожидать, пока определенные типы ресурсов окажутся в желаемом состоянии.

По умолчанию, модуль завершается, как только Kubernetes получит запрос.

Реализовано для state=present для Deployment, DaemonSet и Pod, и для state=absent для всех типов ресурсов.

Для типов ресурсов без реализации wait возвращается немедленно, если wait_condition не установлено.

Варианты:

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

wait_condition

dictionary

Указывает пользовательское условие для ожидания в статусе.

Игнорируется, если wait не установлено или установлено в False.

reason

string

Значение поля reason в желаемом условии.

Например, если Deployment приостановлен, то Progressing type будет иметь причину DeploymentPaused.

Возможные причины в условии специфичны для каждого типа ресурса в Kubernetes.

См. документацию API поля status для данного ресурса, чтобы увидеть возможные варианты.

status

string

Значение поля status в желаемом условии.

Например, если Deployment приостановлен, то Progressing type будет иметь статус Unknown.

Варианты:

• "True" ← (по умолчанию)
• "False"
• "Unknown"

type

string

Тип условия, для ожидания.

Например, ресурс Pod установит условие Ready (среди прочих).

Требуется, если вы указываете условие wait_condition.

Если оставлено пустым, то поле wait_condition будет проигнорировано.

Возможные типы условий специфичны для каждого типа ресурса в Kubernetes.

См. документацию API поля status для данного ресурса, чтобы увидеть возможные варианты.

wait_sleep

integer

Количество секунд ожидания между проверками.

По умолчанию: 5

wait_timeout

integer

Сколько секунд ждать, пока ресурс окажется в желаемом состоянии.

Игнорируется, если wait не установлено.

По умолчанию: 120