Модуль community.okd.openshift_adm_migrate_template_instances — обновление TemplateInstances для указания на последние group-version-kinds

api_key

string

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

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.

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.

kubeconfig

any

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

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

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

namespace

string

Пространство имён, в котором находится шаблон.

Если пространство имён не указано, объекты будут перенесены во всех пространствах имён.

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

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

Если контекст k8s использует учётные данные пользователя с токенами обновления (например, oidc или авторизацию gke/gcloud), токен обновляется библиотекой клиента 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

Строка, задающая 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

Задаёт пользовательское условие в status, которого нужно дождаться.

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

reason

string

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

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

Допустимые значения reason в условии зависят от типа ресурса в 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

result

list / elements=dictionary

Список всех перенесённых TemplateInstances.

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

Пример: [{"apiVersion": "template.openshift.io/v1", "kind": "TemplateInstance", "metadata": {"creationTimestamp": "2021-11-10T11:12:09Z", "finalizers": ["template.openshift.io/finalizer"], "managedFields": [{"apiVersion": "template.openshift.io/v1", "fieldsType": "FieldsV1", "fieldsV1": {"f:spec": {"f:template": {"f:metadata": {"f:name": {}}, "f:objects": {}, "f:parameters": {}}}}, "manager": "kubectl-create", "operation": "Update", "time": "2021-11-10T11:12:09Z"}, {"apiVersion": "template.openshift.io/v1", "fieldsType": "FieldsV1", "fieldsV1": {"f:metadata": {"f:finalizers": {".": {}, "v:\"template.openshift.io/finalizer\"": {}}}, "f:status": {"f:conditions": {}}}, "manager": "openshift-controller-manager", "operation": "Update", "time": "2021-11-10T11:12:09Z"}, {"apiVersion": "template.openshift.io/v1", "fieldsType": "FieldsV1", "fieldsV1": {"f:status": {"f:objects": {}}}, "manager": "OpenAPI-Generator", "operation": "Update", "time": "2021-11-10T11:12:33Z"}], "name": "demo", "namespace": "test", "resourceVersion": "545370", "uid": "09b795d7-7f07-4d94-bf0f-2150ee66f88d"}, "spec": {"requester": {"groups": ["system:masters", "system:authenticated"], "username": "system:admin"}, "template": {"metadata": {"creationTimestamp": null, "name": "template"}, "objects": [{"apiVersion": "v1", "kind": "Secret", "metadata": {"labels": {"foo": "bar"}, "name": "secret"}}, {"apiVersion": "apps/v1", "kind": "Deployment", "metadata": {"name": "deployment"}, "spec": {"replicas": 0, "selector": {"matchLabels": {"key": "value"}}, "template": {"metadata": {"labels": {"key": "value"}}, "spec": {"containers": [{"image": "k8s.gcr.io/e2e-test-images/agnhost:2.32", "name": "hello-openshift"}]}}}}, {"apiVersion": "v1", "kind": "Route", "metadata": {"name": "route"}, "spec": {"to": {"name": "foo"}}}], "parameters": [{"name": "NAME", "value": "${NAME}"}]}}, "status": {"conditions": [{"lastTransitionTime": "2021-11-10T11:12:09Z", "message": "", "reason": "Created", "status": "True", "type": "Ready"}], "objects": [{"ref": {"apiVersion": "v1", "kind": "Secret", "name": "secret", "namespace": "test", "uid": "33fad364-6d47-4f9c-9e51-92cba5602a57"}}, {"ref": {"apiVersion": "apps/v1", "kind": "Deployment", "name": "deployment", "namespace": "test", "uid": "3b527f88-42a1-4811-9e2f-baad4e4d8807"}}, {"ref": {"apiVersion": "route.openshift.io/v1.Route", "kind": "Route", "name": "route", "namespace": "test", "uid": "5b5411de-8769-4e27-ba52-6781630e4008"}}]}}, "..."]