Модуль containers.podman.podman_volume – Управление томами Podman

Примечание

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

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

Для установки используйте: ansible-galaxy collection install containers.podman. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: containers.podman.podman_volume.

Новое в containers.podman 1.1.0

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

Краткое описание

Управление томами Podman

Требования

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

podman

Параметры

Параметр	Комментарии
debug boolean	Возвращает дополнительную информацию, которая может быть полезна для расследований. Варианты: `false` ← (по умолчанию) `true`
driver string	Укажите имя драйвера тома (по умолчанию local).
executable string	Путь к исполняемому файлу `podman`, если он не находится в `$PATH` на машине, на которой выполняется `podman` По умолчанию: `"podman"`
label dictionary	Добавить метаданные в том pod (например, label com.example.key=value).
name string / обязательно	Имя тома.
options list / elements=string	Установить параметры, специфичные для драйвера. Например, ‘device=tpmfs’, ‘type=tmpfs’. Идемпотентность UID и GID не поддерживается из-за изменений в podman.
quadlet_dir path	Путь к каталогу для записи файла quadlet. По умолчанию он будет установлен как `/etc/containers/systemd/` для пользователя root, `~/.config/containers/systemd/` для пользователей без прав root.
quadlet_filename string	Имя файла quadlet для записи. По умолчанию он принимает значение name.
quadlet_options list / elements=string	Параметры для файла quadlet. Предоставьте отсутствующие параметры обычных сетевых аргументов в виде списка строк для добавления.
recreate boolean	Пересоздать том, даже если он существует. Варианты: `false` ← (по умолчанию) `true`
state string	Состояние тома, по умолчанию ‘present’ Варианты: `"present"` ← (по умолчанию) `"absent"` `"mounted"` `"unmounted"` `"quadlet"`

Примеры

# What modules does for example
- name: Create a volume
  containers.podman.podman_volume:
    state: present
    name: volume1
    label:
      key: value
      key2: value2
    options:
      - "device=/dev/loop1"
      - "type=ext4"

- name: Create a Quadlet file for a volume
  containers.podman.podman_volume:
    state: quadlet
    name: quadlet_volume
    quadlet_filename: custom-name
    quadlet_options:
      - Group=192
      - Copy=true
      - Image=quay.io/centos/centos:latest

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

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

Ключ	Описание
volume dictionary	Результаты проверки тома, если он существует. Возвращается: всегда Пример: `{"CreatedAt": "2023-11-30T16:41:31.310865559+02:00", "Driver": "local", "Labels": {}, "LockNumber": 18, "MountCount": 0, "Mountpoint": "/home/user/.local/share/containers/storage/volumes/volname/_data", "Name": "volname", "NeedsChown": true, "NeedsCopyUp": true, "Options": {}, "Scope": "local"}`

Ключ

Описание

volume

dictionary

Результаты проверки тома, если он существует.

Возвращается: всегда

Пример: {"CreatedAt": "2023-11-30T16:41:31.310865559+02:00", "Driver": "local", "Labels": {}, "LockNumber": 18, "MountCount": 0, "Mountpoint": "/home/user/.local/share/containers/storage/volumes/volname/_data", "Name": "volname", "NeedsChown": true, "NeedsCopyUp": true, "Options": {}, "Scope": "local"}

Авторы

Sagi Shnaidman (@sshnaidm)

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

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