.. include:: prepare-feature-header.inc.rst



crb
^^^



.. 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 originally used for command line help only, therefore the
    formatting is often suboptimal.

Enable or disable the CodeReady Builder (CRB) repository:

.. code-block:: yaml

    prepare:
        how: feature
        crb: enabled

.. code-block:: shell

    prepare --how feature --crb enabled

.. versionadded:: 1.49





crb
    Whether the CRB repository should be enabled or disabled.

    Default: *not set*

    Environment variable: ``TMT_PLUGIN_PREPARE-FEATURE_CRB_CRB``

    In plan metadata:

    .. code-block:: yaml

       crb: enabled|disabled


    On command-line:

    .. code-block:: shell

       --crb 'enabled|disabled'
       export TMT_PLUGIN_PREPARE-FEATURE_CRB_CRB='enabled|disabled'



----





epel
^^^^



.. 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 originally used for command line help only, therefore the
    formatting is often suboptimal.

Control Extra Packages for Enterprise Linux (EPEL) repository.

`EPEL`__ is an initiative within the Fedora Project to provide high
quality additional packages for CentOS Stream and Red Hat Enterprise
Linux (RHEL).

Enable or disable EPEL repository on the guest:

.. code-block:: yaml

    prepare:
        how: feature
        epel: enabled

.. code-block:: shell

    prepare --how feature --epel enabled

__ https://docs.fedoraproject.org/en-US/epel/

.. note::

    This plugin requires the following Ansible modules be installed
    on the runner:

    * `ansible.builtin.raw`__
    * `ansible.builtin.dnf`__
    * `ansible.builtin.shell`__
    * `ansible.builtin.command`__

    __ https://docs.ansible.com/ansible/latest/collections/ansible/builtin/raw_module.html
    __ https://docs.ansible.com/ansible/latest/collections/ansible/builtin/dnf_module.html
    __ https://docs.ansible.com/ansible/latest/collections/ansible/builtin/shell_module.html
    __ https://docs.ansible.com/ansible/latest/collections/ansible/builtin/command_module.html





epel
    Whether EPEL repository should be installed & enabled or disabled.

    Default: *not set*

    Environment variable: ``TMT_PLUGIN_PREPARE-FEATURE_EPEL_EPEL``

    In plan metadata:

    .. code-block:: yaml

       epel: enabled|disabled


    On command-line:

    .. code-block:: shell

       --epel 'enabled|disabled'
       export TMT_PLUGIN_PREPARE-FEATURE_EPEL_EPEL='enabled|disabled'



----





fips
^^^^



.. 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 originally used for command line help only, therefore the
    formatting is often suboptimal.






fips
    Whether FIPS mode should be enabled

    Default: *not set*

    Environment variable: ``TMT_PLUGIN_PREPARE-FEATURE_FIPS_FIPS``

    In plan metadata:

    .. code-block:: yaml

       fips: enabled


    On command-line:

    .. code-block:: shell

       --fips enabled
       export TMT_PLUGIN_PREPARE-FEATURE_FIPS_FIPS=enabled



----





profile
^^^^^^^



.. 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 originally used for command line help only, therefore the
    formatting is often suboptimal.

Prepare guest setup with a guest profile.

.. note::

    Guest profiles are being developed, once there is an agreed upon
    text we could steal^Wborrow^Wreuse, we shall add it to this
    docstring.

Guest profiles represent a particular setup of guest environment as
defined by a CI system or service. They are implemented as Ansible
roles, and packaged as Ansible collections. The CI systems use
profiles to set up guests before testing, and users may use the same
profiles to establish the same environment locally when developing
tests or reprodcing issues.

Apply a profile to the guest:

.. code-block:: yaml

    prepare:
        how: feature
        profile: testing_farm.fedora_ci

.. code-block:: shell

    prepare --how feature --profile testing_farm.fedora_ci





profile
    Apply guest profile.

    Default: *not set*

    Environment variable: ``TMT_PLUGIN_PREPARE-FEATURE_PROFILE_PROFILE``

    In plan metadata:

    .. code-block:: yaml

       profile: NAME


    On command-line:

    .. code-block:: shell

       --profile NAME
       export TMT_PLUGIN_PREPARE-FEATURE_PROFILE_PROFILE=NAME
