Spec-Zone.ru › Ansible

Модуль containers.podman.podman_play — запуск файла Kubernetes YAML с помощью podman

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: containers.podman.podman_play.

  • Краткое описание
  • Требования
  • Параметры
  • Примеры

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

  • Модуль считывает структурированный файл Kubernetes YAML, а затем повторно создает описанные в YAML под и контейнеры.

Требования

Следующие компоненты необходимы на хосте, где выполняется этот модуль.

  • Podman, установленный на хосте

Параметры

Параметр

Комментарии

annotation

псевдонимы: annotations

dictionary

Добавить аннотацию к контейнеру или поду.

authfile

path

Путь к файлу аутентификации. По умолчанию используется ${XDG_RUNTIME_DIR}/containers/auth.json, путь к которому задается с помощью podman login. Если сведения об авторизации там не найдены, проверяется $HOME/.docker/config.json, путь к которому задается с помощью docker login. Примечание: путь к файлу аутентификации по умолчанию также можно переопределить, задав переменную среды REGISTRY_AUTH_FILE. export REGISTRY_AUTH_FILE=path

build

boolean

Собирать образы, даже если они уже найдены в локальном хранилище.

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

Варианты:

  • false
  • true

cert_dir

path

Использовать сертификаты по указанному пути (*.crt, *.cert, *.key) для подключения к реестру. Каталог сертификатов по умолчанию — /etc/containers/certs.d. (Этот параметр недоступен при использовании удаленного клиента Podman.)

configmap

list / elements=path

Использовать Kubernetes configmap YAML по указанному пути, чтобы задать источник значений переменных среды в контейнерах пода. Примечание: параметр configmap можно использовать несколько раз для передачи нескольких файлов Kubernetes configmap YAML.

context_dir

path

Использовать указанный путь в качестве каталога контекста сборки для каждого образа. Требуется, чтобы параметр build имел значение true.

debug

boolean

Включить режим отладки для модуля.

Варианты:

  • false
  • true

executable

string

Имя исполняемого файла; по умолчанию — ‘podman’

По умолчанию: "podman"

kube_file

path

Путь к файлу с конфигурацией Pod в формате YAML.

kube_file_content

string

Содержимое файла kube.

log_driver

string

Задать драйвер журналирования для всех создаваемых контейнеров.

log_level

string

Задать уровень журналирования для вызовов podman. Записывать сообщения журнала выше указанного уровня (“debug”|”info”|”warn”|”error”|”fatal”|”panic”) (по умолчанию “error”)

Варианты:

  • "debug"
  • "info"
  • "warn"
  • "error"
  • "fatal"
  • "panic"

log_opt

псевдонимы: log_options

dictionary

Параметры, специфичные для драйвера журналирования. Задать пользовательскую конфигурацию журналирования.

max_size

string

Указать максимальный размер файла журнала (например, 10mb).

path

string

Указать путь к файлу журнала (например, /var/log/container/mycontainer.json).

tag

string

Указать пользовательскую метку журнала для контейнера. В настоящее время этот параметр поддерживается только драйвером журналирования journald в Podman.

network

list / elements=string

Список имен сетей CNI, к которым должен подключиться под.

password

string

Имя пользователя и пароль для аутентификации в реестре, если она требуется.

quadlet_dir

path

Путь к каталогу, в котором будет создан файл quadlet. По умолчанию для пользователя root используется /etc/containers/systemd/, а для обычных пользователей — ~/.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. Необходимо указать, если state имеет значение quadlet.

quadlet_options

list / elements=string

Параметры файла quadlet. Укажите отсутствующие параметры обычных аргументов сети в виде списка строк для добавления.

quiet

boolean

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

Варианты:

  • false
  • true

recreate

boolean

Если под уже существует, удалить его и запустить новый.

Варианты:

  • false
  • true

seccomp_profile_root

path

Путь к каталогу профилей seccomp (по умолчанию — “/var/lib/kubelet/seccomp”). Этот параметр недоступен при использовании удаленного клиента Podman.

state

string / обязательный

Запустить под после его создания или оставить его только созданным.

Варианты:

  • "created"
  • "started"
  • "absent"
  • "quadlet"

tls_verify

boolean

Требовать HTTPS и проверять сертификаты при обращении к реестрам (по умолчанию — true). Если явно указано true, будет выполняться проверка TLS. Если указано false, проверка TLS выполняться не будет. Если параметр не указан, проверка TLS будет выполняться, если целевой реестр не указан в registries.conf как небезопасный.

Варианты:

  • false
  • true

username

string

Имя пользователя и пароль для аутентификации в реестре, если она требуется.

userns

string

Задать режим пространства имен пользователей для всех контейнеров в поде. По умолчанию используется переменная среды PODMAN_USERNS. Пустое значение (“”) означает, что пространства имен пользователей отключены.

Примеры

- name: Play kube file
  containers.podman.podman_play:
    kube_file: ~/kube.yaml
    state: started

- name: Recreate pod from a kube file with options
  containers.podman.podman_play:
    kube_file: ~/kube.yaml
    state: started
    recreate: true
    annotations:
      greeting: hello
      greet_to: world
    userns: host
    log_opt:
      path: /tmp/my-container.log
      max_size: 10mb

- name: Create a Quadlet file
  containers.podman.podman_play:
    kube_file: ~/kube.yaml
    state: quadlet
    annotations:
      greeting: hello
      greet_to: world
    userns: host
    quadlet_filename: kube-pod
    quadlet_file_mode: '0640'
    quadlet_options:
      - "SetWorkingDirectory=yaml"
      - "ExitCodePropagation=any"

Авторы

  • 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_play_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API