.. Document meta



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

.. meta::
  :antsibull-docs: 2.14.0

.. Anchors

.. _ansible_collections.osp.edpm.container_config_data_module:

.. Anchors: short name for ansible.builtin

.. Title

osp.edpm.container_config_data module -- Generates a dictionary which contains all container configs
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++


.. version_added

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

New in osp.edpm 2.8

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

.. Deprecated


Synopsis
--------

.. Description

- This module reads container configs in JSON files and generate a dictionary which later will be used to manage the containers.


.. Aliases


.. Requirements






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

      .. _ansible_collections.osp.edpm.container_config_data_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_path"></div>

      .. _ansible_collections.osp.edpm.container_config_data_module__parameter-config_path:

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

      **config_path**

      .. raw:: html

        <a class="ansibleOptionLink" href="#parameter-config_path" 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">

      The path of a directory or a file where the JSON files are. This parameter is required.


      .. raw:: html

        </div>

  * - .. raw:: html

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

      .. _ansible_collections.osp.edpm.container_config_data_module__parameter-config_pattern:

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

      **config_pattern**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`string`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Search pattern to find JSON 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.container_config_data_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>


.. Attributes


.. Notes


.. Seealso


.. Examples

Examples
--------

.. code-block:: yaml+jinja

    - name: Generate containers configs data
      container_config_data:
        config_path: /var/lib/edpm-config/container-startup-config/step_1
    - name: Generate containers configs data for HAproxy and override image
      container_config_data:
        config_path: /var/lib/edpm-config/container-startup-config/step_1
        config_pattern: 'haproxy.json'
        config_overrides:
          haproxy:
            image: my-registry.io/edpm/haproxy:mytag



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

      .. _ansible_collections.osp.edpm.container_config_data_module__return-configs:

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

      **configs**

      .. raw:: html

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

      .. ansible-option-type-line::

        :ansible-option-type:`dictionary`

      .. raw:: html

        </div>

    - .. raw:: html

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

      Dictionary with container configs ready to be consumed by edpm\_container\_manage role.


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

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


      .. raw:: html

        </div>



..  Status (Presently only deprecated)


.. Authors

Authors
~~~~~~~

- Emilien Macchi



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