znerol.podluck.podluck_container (2.0.1) — module

Configure podman containers managed by systemd

| "added in version" 1.0.0 of znerol.podluck"

Authors: Lorenz Schori

Install collection

Install with ansible-galaxy collection install znerol.podluck:==2.0.1


Add to requirements.yml

  collections:
    - name: znerol.podluck
      version: 2.0.1

Description

Install and remove configuration for Podman containers managed by systemd


Requirements

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Container config for wildfly in demo.example.com pod present
  znerol.podpourri.podman_container:
    name: wildfly
    pod: demo.example.com
    image: quay.io/bitnami/wildfly:latest
    state: present
    publish:
      - '8080:8080'
      - '9990:9990'
    volumes:
      - wildfly.demo.example.com:/bitnami/wildfly
    mode: 0600
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Container config for wildfly in demo.example.com pod absent
  znerol.podpourri.podman_container:
    name: wildfly
    pod: demo.example.com
    state: absent

Inputs

    
pod:
    description:
    - Name of a pod created using M(znerol.podluck.podluck_pod).
    required: true
    type: str

mode:
    description:
    - The permissions the resulting filesystem object should have.
    - For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
      You must give Ansible enough information to parse them correctly. For consistent
      results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
      a string and can do its own conversion from string into number. Adding a leading
      zero (for example, V(0755)) works sometimes, but can fail in loops and some other
      circumstances.
    - Giving Ansible a number without following either of these rules will end up with
      a decimal number which will have unexpected results.
    - As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, V(u+rwx)
      or V(u=rw,g=r,o=r)).
    - If O(mode) is not specified and the destination filesystem object B(does not) exist,
      the default C(umask) on the system will be used when setting the mode for the newly
      created filesystem object.
    - If O(mode) is not specified and the destination filesystem object B(does) exist,
      the mode of the existing filesystem object will be used.
    - Specifying O(mode) is the best way to ensure filesystem objects are created with
      the correct permissions. See CVE-2020-1736 for further details.
    type: raw

name:
    description:
    - Name of the container
    required: true
    type: str

path:
    description:
    - Path to the container configuration file. Use the defaults, since this is what the
      `podluck-service@.service` systemd unit expects.
    - Defaults to `/etc/podluck/pod/{{ pod }}/systemd-container-{{ name }}-env` when module
      is executed as I(root).
    - Defaults to `~/.config/podluck/pod/{{ pod }}/systemd-container-{{ name }}-env` when
      module is executed as an unprivileged user.
    type: str

group:
    description:
    - Name of the group that should own the filesystem object, as would be fed to I(chown).
    - When left unspecified, it uses the current group of the current user unless you
      are root, in which case it can preserve the previous ownership.
    type: str

owner:
    description:
    - Name of the user that should own the filesystem object, as would be fed to I(chown).
    - When left unspecified, it uses the current user unless you are root, in which case
      it can preserve the previous ownership.
    - Specifying a numeric username will be assumed to be a user ID and not a username.
      Avoid numeric usernames to avoid this confusion.
    type: str

state:
    choices:
    - absent
    - present
    default: present
    description:
    - I(absent) - A podluck configuration file for the container in the specified pod
      is unlinked if it exists.
    - 'I(present) - A podluck configuration file for the container in the specified pod
      is created and populated with cli arguments matching the desired configuration.
      Returns `changed: True` if existing configuration does not match the current config.
      The calling playbook / role is responsible for restarting the container / pod if
      necessary.'
    type: str

serole:
    description:
    - The role part of the SELinux filesystem object context.
    - When set to V(_default), it will use the C(role) portion of the policy if available.
    type: str

setype:
    description:
    - The type part of the SELinux filesystem object context.
    - When set to V(_default), it will use the C(type) portion of the policy if available.
    type: str

seuser:
    description:
    - The user part of the SELinux filesystem object context.
    - By default it uses the V(system) policy, where applicable.
    - When set to V(_default), it will use the C(user) portion of the policy if available.
    type: str

selevel:
    description:
    - The level part of the SELinux filesystem object context.
    - This is the MLS/MCS attribute, sometimes known as the C(range).
    - When set to V(_default), it will use the C(level) portion of the policy if available.
    type: str

attributes:
    aliases:
    - attr
    description:
    - The attributes the resulting filesystem object should have.
    - To get supported flags look at the man page for I(chattr) on the target system.
    - This string should contain the attributes in the same order as the one displayed
      by I(lsattr).
    - The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
      be included in the string.
    type: str
    version_added: '2.3'
    version_added_collection: ansible.builtin

unsafe_writes:
    default: false
    description:
    - Influence when to use atomic operation to prevent data corruption or inconsistent
      reads from the target filesystem object.
    - By default this module uses atomic operations to prevent data corruption or inconsistent
      reads from the target filesystem objects, but sometimes systems are configured or
      just broken in ways that prevent this. One example is docker mounted filesystem
      objects, which cannot be updated atomically from inside the container and can only
      be written in an unsafe manner.
    - This option allows Ansible to fall back to unsafe methods of updating filesystem
      objects when atomic operations fail (however, it doesn't force Ansible to perform
      unsafe writes).
    - IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption.
    type: bool
    version_added: '2.2'
    version_added_collection: ansible.builtin