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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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

Параметры

Параметр	Комментарии
all boolean	Если задано значение true, при создании или при указании `source` импортируются все теги из указанного источника. Допустимые значения: `false` ← (по умолчанию) `true`
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 / элементы=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.
name any / обязательный	Поток образов, в который нужно импортировать тег. Можно указать список потоков образов или одно значение.
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), токен обновляется клиентской библиотекой Python для k8s, но по умолчанию не сохраняется. Из-за этого старый токен обновления может истечь, и следующая аутентификация завершится ошибкой. Если установить этому параметру значение true, клиентская библиотека Python для k8s сохранит новый токен обновления в файл конфигурации kube. По умолчанию — false. Обратите внимание: текущая версия клиентской библиотеки Python для k8s пока не поддерживает установку этого параметра в значение 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.
reference_policy string	Разрешить запрос на сквозную загрузку внешнего образа, если задано значение local. Допустимые значения: `"source"` ← (по умолчанию) `"local"`
scheduled boolean	Настроить периодический импорт каждого импортированного образа Docker из удалённого репозитория. Допустимые значения: `false` ← (по умолчанию) `true`
source string	Репозиторий образов Docker, из которого импортируются образы. Значение должно иметь вид «registry.io/repo/image».
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`
validate_registry_certs boolean	Если задано значение 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 list / элементы=dictionary	Список всех созданных ImageStreamImport. Возвращается: success
api_version string	Версия схемы этого представления объекта. Возвращается: success
kind string	Представляет ресурс REST, соответствующий этому объекту. Возвращается: success
metadata dictionary	Стандартные метаданные объекта. Включают имя, пространство имён, аннотации, метки и т. д. Возвращается: success
spec dictionary	Специфические атрибуты объекта. Зависит от значений api_version и kind. Возвращается: success
status dictionary	Сведения о текущем состоянии объекта. Возвращается: success

Авторы

Aubin Bikouo (@abikouo)

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

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