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

api_key

string

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

api_version

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

string

Задает версию API.

Используйте вместе с kind, name и namespace, чтобы указать конкретный объект.

По умолчанию: "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.

hidden_fields

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

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

Список полей, которые нужно скрыть в выводе различий.

Полезно для полей, не относящихся к операции patch, например `metadata.managedFields`.

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

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.

kind

string / обязательный

Задает модель объекта.

Используйте вместе с 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 / обязательный

Задает имя объекта.

Используйте вместе с api_version, kind и namespace, чтобы указать конкретный объект.

namespace

string

Задает пространство имен объекта.

Используйте вместе с api_version, kind и name, чтобы указать конкретный объект.

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

patch

list / элементы=dictionary / обязательный

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

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

validate_certs

псевдонимы: 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

string

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

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

Варианты:

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

type

string

Тип условия, которого нужно дождаться.

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

Обязательный параметр, если указан wait_condition.

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

Допустимые типы условий зависят от типа ресурса Kubernetes.

Допустимые варианты см. в документации API для поля статуса соответствующего ресурса.

wait_sleep

integer

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

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

wait_timeout

integer

Время ожидания (в секундах) перехода ресурса в требуемое состояние.

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

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

duration

integer

Продолжительность выполнения задачи в секундах.

Возвращается: когда wait равно true

Пример: 48

error

dictionary

Ошибка при применении patch к объекту.

Возвращается: при ошибке

Пример: {"exception": "Traceback (most recent call last): ...", "msg": "Failed to import the required Python library (jsonpatch) ..."}

result

dictionary

Измененный объект.

Возвращается: при успешном выполнении

api_version

string

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

Возвращается: при успешном выполнении

kind

string

Ресурс REST, представленный этим объектом.

Возвращается: при успешном выполнении

metadata

dictionary

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

Возвращается: при успешном выполнении

spec

dictionary

Определенные атрибуты объекта. Зависят от значений api_version и kind.

Возвращается: при успешном выполнении

status

dictionary

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

Возвращается: при успешном выполнении