.. Document meta



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

.. meta::
  :antsibull-docs: 2.14.0

.. Anchors

.. _ansible_collections.osp.edpm.edpm_container_manage_module:

.. Anchors: short name for ansible.builtin

.. Title

osp.edpm.edpm_container_manage module -- Create containers from a set of json configurations
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. version_added

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

New in osp.edpm 2.9

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

.. Deprecated


Synopsis
--------

.. Description

- Create containers from a set of json configurations


.. Aliases


.. Requirements

.. _ansible_collections.osp.edpm.edpm_container_manage_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-concurrency"></div>

      .. _ansible_collections.osp.edpm.edpm_container_manage_module__parameter-concurrency:

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

      **concurrency**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`integer`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Number of podman actions to run at the same time


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`1`

      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_container_manage_module__parameter-config_dir:

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

      **config_dir**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Path to the json container definitions


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_container_manage_module__parameter-config_id:

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

      **config_id**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string` / :ansible-option-required:`required`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Config id for the label


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_container_manage_module__parameter-config_overrides:

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

      **config_overrides**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Allows to override any container configuration which will take precedence over the JSON files.


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`{}`

      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_container_manage_module__parameter-config_patterns:

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

      **config_patterns**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Glob for configuration files


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`"\*.json"`

      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.edpm_container_manage_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">

      Enable debug


      .. 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-log_base_path"></div>

      .. _ansible_collections.osp.edpm.edpm_container_manage_module__parameter-log_base_path:

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

      **log_base_path**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Log base path directory


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

      :ansible-option-default-bold:`Default:` :ansible-option-default:`"/var/log/containers/stdouts"`

      .. raw:: html

        </div>


.. Attributes


.. Notes


.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    - name: Run containers
      edpm_container_manage:
        config_id: edpm_step1
        config_dir: /var/lib/edpm-config/container-startup-config/step_1



.. Facts


.. Return values


..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Alex Schultz (@mwhahaha)



.. 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