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

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: 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 / элементы=string	Задайте параметры, специфичные для драйвера. Например, «device=tpmfs», «type=tmpfs». Идемпотентность UID и GID не поддерживается из-за изменений в podman.
quadlet_dir path	Путь к каталогу, в который будет записан файл quadlet. По умолчанию для пользователя root используется `/etc/containers/systemd/`, а для пользователей без root — `~/.config/containers/systemd/`.
quadlet_file_mode any	Права доступа к файлу quadlet. Значение `quadlet_file_mode` можно указать в виде восьмеричного числа или символьного режима (например, `u+rwx` или `u=rw,g=r,o=r`). Для восьмеричного формата необходимо либо добавить ведущий ноль, чтобы парсер YAML Ansible распознал восьмеричное число (например, `0644` или `01777`), либо заключить значение в кавычки (например, `'644'` или `'1777'`), чтобы Ansible получил строку и самостоятельно преобразовал её в число. Если передать Ansible число, не соблюдая одно из этих правил, оно будет интерпретировано как десятичное, что приведёт к неожиданным результатам. Если `quadlet_file_mode` не указано и файл quadlet не существует, при установке режима для создаваемого файла будет применена маска по умолчанию `'0640'`. Если `quadlet_file_mode` не указано и файл quadlet существует, будет использован режим существующего файла. Указание `quadlet_file_mode` — лучший способ гарантировать, что файлы будут созданы с правильными правами доступа.
quadlet_filename string	Имя файла quadlet для записи. По умолчанию используется значение name.
quadlet_options list / элементы=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_file_mode: '0640'
    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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/containers/podman/podman_volume_module.html