Files
ansible-podman/roles/container/meta/argument_specs.yaml
2024-11-08 03:50:06 +02:00

102 lines
3.3 KiB
YAML

---
argument_specs:
main:
description: Sets up podman container with systemd units (quadlet)
options:
container_name:
description: Name of the container. Must be unique within a host.
type: str
required: true
container_image:
description: "The image to run in the container, in FQIN format (registry/imagename:tag)"
type: str
required: true
container_command:
description: Command to start the container with.
type: list
required: false
default: []
elements: str
container_user:
description: The UID to run as inside the container
type: str
required: false
default: ""
container_mounts:
description: List of bind mounts or volumes to be mounted inside the container.
type: list
required: false
default: []
elements: dict
options:
type:
description: Type of volume
type: str
required: true
choices:
- volume
- bind
source:
description:
- Mount source.
- If mount type is volume, name of the volume.
- If mount type is bind, host path to bind mount inside the container.
type: str
required: true
destination:
description: Path inside the container to mount at
type: str
required: true
readonly:
description: If true, volume will be mounted as read only inside the container
type: bool
required: false
default: false
container_publish_ports:
description: "A list of published ports in docker format (<host listen address>:<host port>:<container port>)"
type: list
required: false
default: []
elements: str
container_networks:
description: A list of podman networks for the container.
type: list
required: false
default: []
elements: str
container_env:
description: A dict of environment variables for the container
type: dict
required: false
default: {}
container_requires:
description: >
List of systemd units (like other containers) this one depends on.
You should ensure they are created before this one, or at least within
the same play, before handlers are flushed.
type: list
required: false
default: []
elements: str
container_wants:
description: >
List of systemd units (like other containers) this one wants.
You should ensure they are created within the same play, before handlers are flushed.
type: list
required: false
default: []
elements: str
container_auto_start:
description: Set to false to not start the container automatically on boot or restart on failure.
type: bool
required: false
default: true
container_auto_update:
description: Whether to let podman automatically update the container whenever the specified image gets updated
type: bool
required: false
default: true