Модуль containers.podman.podman_image — Скачать образы для использования в podman

Примечание

Этот модуль входит в состав коллекции containers.podman (версия 1.16.1).

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

Для установки используйте: ansible-galaxy collection install containers.podman.

Для использования в книге задач укажите: containers.podman.podman_image.

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

Обзор

Сборка, скачивание или отправка образов с помощью Podman.

Параметры

Параметр	Комментарии
arch строка	Архитектура процессора для контейнерного образа
auth_file алиасы: authfile путь	Путь к файлу с учетными данными авторизации для удаленного реестра.
build алиасы: build_args, buildargs словарь	Аргументы, управляющие сборкой образа. По умолчанию: `{}`
annotation словарь	Словарь пар ключ=значение для добавления в образ. Действует только с OCI-образами. Игнорируется для контейнеров Docker.
cache булево	Использовать кэшированные слои при сборке образа Варианты: `false` `true` ← (по умолчанию)
container_file строка	Содержимое Containerfile для сборки образа. Взаимоисключающее с параметром `file`, который представляет путь к существующему Containerfile.
extra_args строка	Дополнительные аргументы для передачи при сборке. Не проверяет новые аргументы сборки идемпотентно.
file путь	Путь к Containerfile, если он не находится в каталоге контекста сборки. Взаимоисключающее с параметром `container_file`.
force_rm булево	Всегда удалять промежуточные контейнеры после сборки, даже если сборка неуспешна. Варианты: `false` ← (по умолчанию) `true`
format строка	Формат собранного образа. Варианты: `"docker"` `"oci"` ← (по умолчанию)
rm булево	Удалить промежуточные контейнеры после успешной сборки Варианты: `false` `true` ← (по умолчанию)
target строка	Укажите целевой этап сборки для построения.
volume список / элементы=строка	Укажите несколько параметров объема/монтирования для монтирования одного или нескольких монтирований в контейнер.
ca_cert_dir путь	Путь к каталогу, содержащему сертификаты TLS и ключи для использования.
executable строка	Путь к исполняемому файлу `podman`, если он не находится в `$PATH` на машине, на которой выполняется `podman`. По умолчанию: `"podman"`
force булево	Принудительно выполнить push или pull образа. При сборке — принудительно выполнить сборку, даже если образ уже существует. Варианты: `false` ← (по умолчанию) `true`
name строка / обязательно	Имя образа для pull, push или удаления. Может содержать тэг в формате `image:tag`.
password строка	Пароль для аутентификации в удаленных реестрах.
path строка	Путь к каталогу контекста сборки.

pull boolean	Выполнить ли подтягивание образа. Варианты: `false` `true` ← (по умолчанию)
pull_extra_args string	Дополнительные аргументы для команды pull.
push boolean	Выполнить ли отправку образа. Варианты: `false` ← (по умолчанию) `true`
push_args dictionary	Аргументы, управляющие отправкой образов. По умолчанию: `{}`
compress boolean	Сжать слои образа tarball при отправке в каталог с помощью транспорта ‘dir’. Варианты: `false` `true`
dest aliases: destination string	Путь или URL, куда будет отправлен образ.
extra_args string	Дополнительные аргументы для отправки, если выполняется. Не проверяет на идемпотентность новые аргументы отправки.
format string	Тип манифеста, используемый при отправке образа с помощью транспорта ‘dir’ (по умолчанию используется тип манифеста источника) Варианты: `"oci"` `"v2s1"` `"v2s2"`
remove_signatures boolean	Отбросить все существующие подписи в образе Варианты: `false` `true`
sign_by string	Путь к файлу ключа, используемому для подписи образа.
transport string	Транспорт, используемый при отправке образа. Если транспорт не задан, будет попытка отправки в удаленный реестр Варианты: `"dir"` `"docker"` `"docker-archive"` `"docker-daemon"` `"oci-archive"` `"ostree"`
quadlet_dir path	Путь к каталогу для записи файла quadlet. По умолчанию для root-пользователя будет `/etc/containers/systemd/`, для пользователей, не являющихся root-пользователями, `~/.config/containers/systemd/`.
quadlet_filename string	Имя файла quadlet для записи. По умолчанию используется имя образа без префиксов и тегов.
quadlet_options list / elements=string	Параметры для файла quadlet. Укажите отсутствующие параметры в обычных параметрах сети как список строк для добавления.
state string	Должен ли образ присутствовать, отсутствовать или быть построен. Варианты: `"present"` ← (по умолчанию) `"absent"` `"build"` `"quadlet"`
tag string	Тег образа для подтягивания, отправки или удаления. По умолчанию: `"latest"`
username string	Имя пользователя для аутентификации с удаленными реестрами.
validate_certs aliases: tlsverify, tls_verify boolean	Требовать HTTPS и проверять сертификаты при подтягивании или отправке. Также используется во время сборки, если необходимо подтягивание или отправка. Варианты: `false` `true`

Примеры

- name: Pull an image
  containers.podman.podman_image:
    name: quay.io/bitnami/wildfly

- name: Remove an image
  containers.podman.podman_image:
    name: quay.io/bitnami/wildfly
    state: absent

- name: Remove an image with image id
  containers.podman.podman_image:
    name: 0e901e68141f
    state: absent

- name: Pull a specific version of an image
  containers.podman.podman_image:
    name: redis
    tag: 4

- name: Build a basic OCI image
  containers.podman.podman_image:
    name: nginx
    path: /path/to/build/dir

- name: Build a basic OCI image with advanced parameters
  containers.podman.podman_image:
    name: nginx
    path: /path/to/build/dir
    build:
      cache: no
      force_rm: true
      format: oci
      annotation:
        app: nginx
        function: proxy
        info: Load balancer for my cool app
      extra_args: "--build-arg KEY=value"

- name: Build a Docker formatted image
  containers.podman.podman_image:
    name: nginx
    path: /path/to/build/dir
    build:
      format: docker

- name: Build and push an image using existing credentials
  containers.podman.podman_image:
    name: nginx
    path: /path/to/build/dir
    push: true
    push_args:
      dest: quay.io/acme

- name: Build and push an image using an auth file
  containers.podman.podman_image:
    name: nginx
    push: true
    auth_file: /etc/containers/auth.json
    push_args:
      dest: quay.io/acme

- name: Build and push an image using username and password
  containers.podman.podman_image:
    name: nginx
    push: true
    username: bugs
    password: "{{ vault_registry_password }}"
    push_args:
      dest: quay.io/acme

- name: Build and push an image to multiple registries
  containers.podman.podman_image:
    name: "{{ item }}"
    path: /path/to/build/dir
    push: true
    auth_file: /etc/containers/auth.json
    loop:
    - quay.io/acme/nginx
    - docker.io/acme/nginx

- name: Build and push an image to multiple registries with separate parameters
  containers.podman.podman_image:
    name: "{{ item.name }}"
    tag: "{{ item.tag }}"
    path: /path/to/build/dir
    push: true
    auth_file: /etc/containers/auth.json
    push_args:
      dest: "{{ item.dest }}"
    loop:
    - name: nginx
      tag: 4
      dest: docker.io/acme

    - name: nginx
      tag: 3
      dest: docker.io/acme

- name: Pull an image for a specific CPU architecture
  containers.podman.podman_image:
    name: nginx
    arch: amd64

- name: Build a container from file inline
  containers.podman.podman_image:
    name: mycustom_image
    state: build
    build:
      container_file: |-
        FROM alpine:latest
        CMD echo "Hello, World!"

- name: Create a quadlet file for an image
  containers.podman.podman_image:
    name: docker.io/library/alpine:latest
    state: quadlet
    quadlet_dir: /etc/containers/systemd
    quadlet_filename: alpine-latest
    quadlet_options:
      - Variant=arm/v7
      - |
        [Install]
        WantedBy=default.target

Значения возврата

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

Ключ	Описание
image словарь	Результаты проверки изображения для изображения, которое было загружено, отправлено или построено. Возвращаемое значение: успех Пример: [{"Annotations": {}, "Architecture": "amd64", "Author": "", "Comment": "", "Config": {"ArgsEscaped": true, "Cmd": ["/bin/sh"], "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"]}, "Created": "2019-03-07T22:19:53.447205048Z", "Digest": "sha256:8421d9a84432575381bfabd248f1eb56f3aa21d9d7cd2511583c68c9b7511d10", "GraphDriver": {"Data": {"UpperDir": "/home/user/.local/share/containers/storage/overlay/3fc6.../diff", "WorkDir": "/home/user/.local/share/containers/storage/overlay/3fc6.../work"}, "Name": "overlay"}, "History": [{"created": "2019-03-07T22:19:53.313789681Z", "created_by": "/bin/sh -c #(nop) ADD file:aa17928... in / "}, {"created": "2019-03-07T22:19:53.447205048Z", "created_by": "/bin/sh -c #(nop) CMD [\"/bin/sh\"]", "empty_layer": true}], "Id": "6d1ef012b5674ad8a127ecfa9b5e6f5178d171b90ee462846974177fd9bdd39f", "Labels": null, "ManifestType": "application/vnd.docker.distribution.manifest.v2+json", "NamesHistory": ["docker.io/library/alpine:3.7"], "Os": "linux", "Parent": "", "RepoDigests": ["docker.io/library/alpine@sha256:8421...", "docker.io/library/alpine@sha256:9225..."], "RepoTags": ["docker.io/library/alpine:3.7"], "RootFS": {"Layers": ["sha256:3fc6..."], "Type": "layers"}, "Size": 4467084, "User": "", "Version": "18.06.1-ce", "VirtualSize": 4467084}]

Ключ

Описание

image

словарь

Результаты проверки изображения для изображения, которое было загружено, отправлено или построено.

Возвращаемое значение: успех

Пример: [{"Annotations": {}, "Architecture": "amd64", "Author": "", "Comment": "", "Config": {"ArgsEscaped": true, "Cmd": ["/bin/sh"], "Env": ["PATH=/usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin"]}, "Created": "2019-03-07T22:19:53.447205048Z", "Digest": "sha256:8421d9a84432575381bfabd248f1eb56f3aa21d9d7cd2511583c68c9b7511d10", "GraphDriver": {"Data": {"UpperDir": "/home/user/.local/share/containers/storage/overlay/3fc6.../diff", "WorkDir": "/home/user/.local/share/containers/storage/overlay/3fc6.../work"}, "Name": "overlay"}, "History": [{"created": "2019-03-07T22:19:53.313789681Z", "created_by": "/bin/sh -c #(nop) ADD file:aa17928... in / "}, {"created": "2019-03-07T22:19:53.447205048Z", "created_by": "/bin/sh -c #(nop) CMD [\"/bin/sh\"]", "empty_layer": true}], "Id": "6d1ef012b5674ad8a127ecfa9b5e6f5178d171b90ee462846974177fd9bdd39f", "Labels": null, "ManifestType": "application/vnd.docker.distribution.manifest.v2+json", "NamesHistory": ["docker.io/library/alpine:3.7"], "Os": "linux", "Parent": "", "RepoDigests": ["docker.io/library/alpine@sha256:8421...", "docker.io/library/alpine@sha256:9225..."], "RepoTags": ["docker.io/library/alpine:3.7"], "RootFS": {"Layers": ["sha256:3fc6..."], "Type": "layers"}, "Size": 4467084, "User": "", "Version": "18.06.1-ce", "VirtualSize": 4467084}]

Авторы

Sam Doran (@samdoran)

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

© 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/containers/podman/podman_image_module.html