:tocdepth: 0

.. _/plugins/finish:

Finish Plugins
~~~~~~~~~~~~~~


.. _plugins/finish/ansible:

ansible
-------

.. warning::

    Please, be aware that the documentation below is a work in progress. We are
    working on fixing it, adding missing bits and generally making it better.
    Also, it was originaly used for command line help only, therefore the
    formatting is often suboptional.

Perform finishing tasks using ansible

Single playbook config:

.. code-block:: yaml

    finish:
        how: ansible
        playbook: ansible/packages.yml

Multiple playbooks config:

.. code-block:: yaml

    finish:
        how: ansible
        playbook:
          - playbook/one.yml
          - playbook/two.yml
          - playbook/three.yml

The playbook path should be relative to the metadata tree root.
Use 'order' attribute to select in which order finishing tasks
should happen if there are multiple configs. Default order is '50'.

Configuration
^^^^^^^^^^^^^




extra-args: ``EXTRA-ARGS``
    Optional arguments for ``ansible-playbook``.

    Default: *not set*


playbook: ``PATH|URL``
    Path or URL of an ansible playbook to run. The playbook path must
    be relative to the metadata tree root.

    Default: *not set*


Common Keys
"""""""""""


name:
    The name of the step phase.


order:
    Order in which the phase should be handled.

    Default: ``50``


summary:
    Concise summary describing purpose of the phase.

    Default: *not set*


where: ``GUEST|ROLE``
    Run this phase on given guest or guests with the given role only.

    Default: *not set*


----

.. _plugins/finish/shell:

shell
-----

.. warning::

    Please, be aware that the documentation below is a work in progress. We are
    working on fixing it, adding missing bits and generally making it better.
    Also, it was originaly used for command line help only, therefore the
    formatting is often suboptional.

Perform finishing tasks using shell (bash) scripts

Example config:

.. code-block:: yaml

    finish:
        how: shell
        script:
          - upload-logs.sh || true
          - rm -rf /tmp/temporary-files

Use the 'order' attribute to select in which order finishing tasks
should happen if there are multiple configs. Default order is '50'.

Configuration
^^^^^^^^^^^^^




script: ``SCRIPT``
    Shell script to be executed. Can be used multiple times.

    Default: *not set*


Common Keys
"""""""""""


name:
    The name of the step phase.


order:
    Order in which the phase should be handled.

    Default: ``50``


summary:
    Concise summary describing purpose of the phase.

    Default: *not set*


where: ``GUEST|ROLE``
    Run this phase on given guest or guests with the given role only.

    Default: *not set*