.. Document meta



.. |antsibull-internal-nbsp| unicode:: 0xA0
    :trim:

.. meta::
  :antsibull-docs: 2.14.0

.. Anchors

.. _ansible_collections.osp.edpm.container_systemd_module:

.. Anchors: short name for ansible.builtin

.. Title

osp.edpm.container_systemd module -- Create systemd files and manage services to run containers
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. version_added

.. rst-class:: ansible-version-added

New in osp.edpm 2.9

.. contents::
   :local:
   :depth: 1

.. Deprecated


Synopsis
--------

.. Description

- Manage the systemd unit files for containers with a restart policy and then make sure the services are started so the containers are running. It takes the container config data in entry to figure out how the unit files will be configured. It returns a list of services that were restarted.

.. note::
    This module has a corresponding :ref:`action plugin <action_plugins>`.

.. Aliases


.. Requirements

.. _ansible_collections.osp.edpm.container_systemd_module_requirements:

Requirements
------------
The below requirements are needed on the host that executes this module.

- None






.. Options

Parameters
----------

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Parameter
    - Comments

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-container_config"></div>

      .. _ansible_collections.osp.edpm.container_systemd_module__parameter-container_config:

      .. rst-class:: ansible-option-title

      **container_config**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-container_config" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      List of container configurations


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-debug"></div>

      .. _ansible_collections.osp.edpm.container_systemd_module__parameter-debug:

      .. rst-class:: ansible-option-title

      **debug**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-debug" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Whether or not debug is enabled.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)`
      - :ansible-option-choices-entry:`true`


      .. raw:: html

        </div>

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="parameter-systemd_healthchecks"></div>

      .. _ansible_collections.osp.edpm.container_systemd_module__parameter-systemd_healthchecks:

      .. rst-class:: ansible-option-title

      **systemd_healthchecks**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-systemd_healthchecks" title="Permalink to this option"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`boolean`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      Whether or not we cleanup the old healthchecks with SystemD.


      .. rst-class:: ansible-option-line

      :ansible-option-choices:`Choices:`

      - :ansible-option-choices-entry:`false`
      - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)`


      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    - name: Manage container systemd services
      container_systemd:
        container_config:
          - keystone:
              image: quay.io/edpm/keystone
              restart: always
          - mysql:
              image: quay.io/edpm/mysql
              stop_grace_period: 25
              restart: always



.. Facts


.. Return values

Return Values
-------------
Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

.. tabularcolumns:: \X{1}{3}\X{2}{3}

.. list-table::
  :width: 100%
  :widths: auto
  :header-rows: 1
  :class: longtable ansible-option-table

  * - Key
    - Description

  * - .. raw:: html

        <div class="ansible-option-cell">
        <div class="ansibleOptionAnchor" id="return-restarted"></div>

      .. _ansible_collections.osp.edpm.container_systemd_module__return-restarted:

      .. rst-class:: ansible-option-title

      **restarted**

      .. raw:: html

        <a class="ansibleOptionLink" href="#return-restarted" title="Permalink to this return value"></a>

      .. ansible-option-type-line::

        :ansible-option-type:`list` / :ansible-option-elements:`elements=string`

      .. raw:: html

        </div>

    - .. raw:: html

        <div class="ansible-option-cell">

      List of services that were restarted


      .. rst-class:: ansible-option-line

      :ansible-option-returned-bold:`Returned:` always

      .. rst-class:: ansible-option-line
      .. rst-class:: ansible-option-sample

      :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`["edpm\_keystone.service", "edpm\_mysql.service"]`


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- EDPM team



.. Extra links

Collection links
~~~~~~~~~~~~~~~~

.. ansible-links::

  - title: "Issue Tracker"
    url: "https://github.com/openstack-k8s-operators/edpm-ansible/issues"
    external: true
  - title: "Repository (Sources)"
    url: "https://github.com/openstack-k8s-operators/edpm-ansible"
    external: true


.. Parsing errors