Модуль community.okd.openshift_import_image — Импорт новейшей информации об изображении из тега в реестре контейнерных образов.

Примечание

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

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

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

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

Добавлен в community.okd 2.2.0

Описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Описание

Потоки изображений позволяют управлять тем, какие изображения развертываются в ваших сборках и приложениях.
Этот модуль извлекает последнюю версию изображения из удалённого репозитория и обновляет тег потока изображения, если он не совпадает с предыдущим значением.
Многократное выполнение модуля не создаст дубликатов записей.
При импорте изображения копируется только метаданные изображения, а не содержимое изображения.
Аналогично oc import-image.

Требования

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

python >= 3.6
kubernetes >= 12.0.0
docker-image-py

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
all boolean	Если установлено значение true, импортировать все теги из указанного источника при создании или если указано `source`. Выбор: `false` ← (по умолчанию) `true`
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. Несколько конфигурационных файлов Kubernetes можно указать, используя разделитель ‘;’ для платформы Windows или ‘:’ для других платформ. Конфигурация Kubernetes может быть предоставлена в виде словаря. Эта функция требует версию клиента python kubernetes >= 17.17.0. Добавлен в версии 2.2.0.
name любой / обязательно	Поток изображений для импорта тега. Это может быть предоставлено как список потоков изображений или одно значение.
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 boolean	Сохранять или нет токены обновления конфигурации 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).

END_OF_DOCUMENT_MARKER

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 строка	Пользователь и пароль, разделенные двоеточием, для заголовка аутентификации прокси по протоколу Basic. Также может быть задан через переменную окружения K8S_AUTH_PROXY_HEADERS_PROXY_BASIC_AUTH.
user_agent строка	Строка, представляющая пользователя-агента, например foo/1.0. Также может быть задан через переменную окружения K8S_AUTH_PROXY_HEADERS_USER_AGENT.
reference_policy строка	Разрешает запрос pullthrough для внешнего изображения, если установлено значение local. Варианты: `"source"` ← (по умолчанию) `"local"`
scheduled логическое значение	Устанавливает каждое импортированное изображение Docker для периодического импорта из удаленного репозитория. Варианты: `false` ← (по умолчанию) `true`
source строка	Репозиторий изображений Docker для импорта изображений. Должен быть предоставлен в виде ‘registry.io/repo/image’
username строка	Укажите имя пользователя для аутентификации с API. Также может быть задано через переменную окружения K8S_AUTH_USERNAME. Обратите внимание, что это работает только с кластерами, настроенными для использования HTTP Basic Auth. Если в вашем кластере используется другой метод аутентификации (например, OAuth2 в OpenShift), это значение не сработает должным образом, и вам следует обратиться к модулю community.okd.k8s_auth, так как он может быть полезен в этой ситуации.
validate_certs псевдонимы: verify_ssl логическое значение	Проверять или нет сертификаты SSL API-сервера. Также может быть задан через переменную окружения K8S_AUTH_VERIFY_SSL. Варианты: `false` `true`
validate_registry_certs логическое значение	Если установлено значение true, разрешить импорт из репозиториев с недействительными сертификатами HTTPS или размещённых через HTTP. Этот параметр имеет приоритет над аннотацией insecure. Варианты: `false` `true`

Примечания

Примечание

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

Примеры

# Import tag latest into a new image stream.
- name: Import tag latest into new image stream
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream
    source: registry.io/repo/image:latest

# Update imported data for tag latest in an already existing image stream.
- name: Update imported data for tag latest
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream

# Update imported data for tag 'stable' in an already existing image stream.
- name: Update imported data for tag latest
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream:stable

# Update imported data for all tags in an existing image stream.
- name: Update imported data for all tags
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream
    all: true

# Import all tags into a new image stream.
- name: Import all tags into a new image stream.
  community.okd.openshift_import_image:
    namespace: testing
    name: mystream
    source: registry.io/repo/image:latest
    all: true

# Import all tags into a new image stream for a list of image streams
- name: Import all tags into a new image stream.
  community.okd.openshift_import_image:
    namespace: testing
    name:
      - mystream1
      - mystream2
      - mystream3
    source: registry.io/repo/image:latest
    all: true

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

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

Ключ	Описание
result список / элементы=словарь	Список всех ImageStreamImport, которые были созданы. Возвращено: успешно
api_version строка	Версионированная схема этого представления объекта. Возвращено: успешно
kind строка	Представляет REST-ресурс, который представляет этот объект. Возвращено: успешно
metadata словарь	Стандартные метаданные объекта. Включает имя, пространство имён, аннотации, метки и т. д. Возвращено: успешно
spec словарь	Уникальные атрибуты объекта. Будут изменяться в зависимости от api_version и kind. Возвращено: успешно
status словарь	Текущие детали статуса объекта. Возвращено: успешно

Авторы

Aubin Bikouo (@abikouo)

Ссылки на сборку

© 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_import_image_module.html