Модуль community.okd.openshift_adm_migrate_template_instances – Обновить TemplateInstances, чтобы указывать на самые новые group-version-kinds

Примечание

Этот модуль является частью коллекции community.okd (версия 3.0.1).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install community.okd. Для использования этого модуля потребуются дополнительные требования, см. Требования для подробностей.

Чтобы использовать его в книге задач, укажите: community.okd.openshift_adm_migrate_template_instances.

Новая в community.okd 2.2.0

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

Обновляет TemplateInstances, чтобы указывать на самые новые group-version-kinds.
Аналогично oc adm migrate template-instances.

Требования

Ниже перечислены требования, необходимые на узле, на котором выполняется этот модуль.

python >= 3.6
kubernetes >= 12.0.0

Параметры

Параметр	Комментарии
api_key строка	Токен, используемый для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_API_KEY.
ca_cert псевдонимы: ssl_ca_cert путь	Путь к сертификату CA, используемому для аутентификации с API. Для избежания ошибок валидации сертификата необходимо предоставить цепочку сертификатов. Также можно указать через переменную окружения K8S_AUTH_SSL_CA_CERT.
client_cert псевдонимы: cert_file путь	Путь к сертификату, используемому для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_CERT_FILE.
client_key псевдонимы: key_file путь	Путь к файлу ключа, используемому для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_KEY_FILE.
context строка	Имя контекста, найденного в файле конфигурации. Также можно указать через переменную окружения K8S_AUTH_CONTEXT.
host строка	Укажите URL для доступа к API. Также можно указать через переменную окружения K8S_AUTH_HOST.
impersonate_groups список / элементы=строка добавлен в kubernetes.core 2.3.0	Группа(ы) для имитации при выполнении операции. Также можно указать через переменную окружения K8S_AUTH_IMPERSONATE_GROUPS. Пример: Group1,Group2
impersonate_user строка добавлен в kubernetes.core 2.3.0	Имя пользователя для имитации при выполнении операции. Также можно указать через переменную окружения K8S_AUTH_IMPERSONATE_USER.
kubeconfig любой	Путь к существующему файлу конфигурации Kubernetes. Если не указан и не предоставлены другие параметры подключения, клиент Kubernetes попытается загрузить файл конфигурации по умолчанию из ~/.kube/config. Также можно указать через переменную окружения K8S_AUTH_KUBECONFIG. Для платформ Windows можно использовать разделитель «;», для других платформ — «:». Конфигурацию Kubernetes можно указать как словарь. Эта функция требует версию python kubernetes клиента ≥ 17.17.0. Добавлен в версии 2.2.0.
namespace строка	Пространство имен, в котором можно найти шаблон. Если пространство имен не указано, операции миграции будут выполнены во всех пространствах имен.
no_proxy строка добавлен в 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 строка	Укажите пароль для аутентификации с API. Также можно указать через переменную окружения K8S_AUTH_PASSWORD. Обратите внимание на описание параметра `username`, если это применимо.
persist_config логический	Сохранять ли токен обновления конфигурации 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 строка	URL HTTP-прокси, который нужно использовать для подключения. Также можно указать через переменную окружения K8S_AUTH_PROXY. Обратите внимание, что этот модуль не использует стандартные настройки прокси из окружения (например, HTTP_PROXY).
proxy_headers словарь добавлен в 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 строка	Пользователь:пароль через двоеточие для заголовка аутентификации Basic. Также можно указать через переменную окружения 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`
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`. Возможные значения 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`

Примечания

Примечание

Чтобы избежать ошибок проверки SSL-сертификатов, когда validate_certs имеет значение True, полная цепочка сертификатов сервера API должна быть предоставлена через ca_cert или в файле kubeconfig.

Примеры

- name: Migrate TemplateInstances in namespace=test
  community.okd.openshift_adm_migrate_template_instances:
    namespace: test
  register: _result

- name: Migrate TemplateInstances in all namespaces
  community.okd.openshift_adm_migrate_template_instances:
  register: _result

Возвращаемые значения

Общие возвращаемые значения описаны здесь. Следующие поля уникальны для этого модуля:

Ключ	Описание
result список / элементы=словарь	Список всех TemplateInstances, которые были мигрированы. Возвращаемое значение: success Пример: [{"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"}}]}}, "..."]

Ключ

Описание

result

список / элементы=словарь

Список всех TemplateInstances, которые были мигрированы.

Возвращаемое значение: success

Пример: [{"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"}}]}}, "..."]

Авторы

Alina Buzachis (@alinabuzachis)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/okd/openshift_adm_migrate_template_instances_module.html