prep
====

.. _prep_check-undercloud-conf:

check-undercloud-conf
---------------------

Verify undercloud.conf correctness.

This validation verifies that no deprecated, invalid or
incompatible parameters are being passed in the Undercloud's
undercloud.conf configuration file.


- **hosts**: undercloud
- **groups**: prep, pre-undercloud-upgrade
- **parameters**:

  - **check_undercloud_conf_debug**: False
- **roles**: check_undercloud_conf

Role documentation

.. toctree::

   roles/role-check_undercloud_conf

.. _prep_fips-enabled:

fips-enabled
------------

Confirm that undercloud has fips enabled.

Check if the undercloud is ready to deploy an environment
using fips.


- **hosts**: all
- **groups**: prep, post-deployment
- **parameters**:
- **roles**: fips_enabled

Role documentation

.. toctree::

   roles/role-fips_enabled

.. _prep_package-version:

package-version
---------------

package-version.

Ensures we can access the wanted package version. Especially useful
when you are switching repositories, for instance during an upgrade.


- **hosts**: all
- **groups**: prep, pre-deployment, pre-upgrade, pre-update, pre-system-upgrade, pre-undercloud-upgrade, pre-overcloud-prepare, pre-overcloud-upgrade, pre-overcloud-converge, pre-ceph
- **parameters**:

  - **package_version_debug**: False
- **roles**: package_version

Role documentation

.. toctree::

   roles/role-package_version

.. _prep_tls-everywhere-prep:

tls-everywhere-prep
-------------------

Confirm that undercloud is setup to register to IdM.

Checks that the undercloud is ready to set up novajoin and
to register to IdM as a client as part of undercloud-install.


- **hosts**: undercloud
- **groups**: prep
- **parameters**:
- **roles**: tls_everywhere

Role documentation

.. toctree::

   roles/role-tls_everywhere

.. _prep_undercloud-disk-space:

undercloud-disk-space
---------------------

Verify undercloud fits the disk space requirements.

Make sure that the root partition on the undercloud node has enough
free space.

http://tripleo.org/install/environments/baremetal.html#minimum-system-requirements


- **hosts**: undercloud
- **groups**: prep, pre-introspection
- **parameters**:

  - **volumes**: [{'mount': '/var/lib/docker', 'min_size': 10}, {'mount': '/var/lib/config-data', 'min_size': 3}, {'mount': '/var/log', 'min_size': 3}, {'mount': '/usr', 'min_size': 5}, {'mount': '/var', 'min_size': 20}, {'mount': '/', 'min_size': 25}]
- **roles**: undercloud_disk_space

Role documentation

.. toctree::

   roles/role-undercloud_disk_space

.. _prep_undercloud-sysctl:

undercloud-sysctl
-----------------

Verify undercloud sysctl option availability.

The undercloud will not install properly if some of the expected sysctl
values are not available to be set.


- **hosts**: undercloud
- **groups**: prep, pre-upgrade, pre-update
- **parameters**:
- **roles**: undercloud_sysctl

Role documentation

.. toctree::

   roles/role-undercloud_sysctl

.. _prep_validate-passwords-file:

validate-passwords-file
-----------------------

Check Undercloud passwords file.

Disallow updates if the passwords file is missing.
If the undercloud was already deployed, the passwords file needs to be
present so passwords that can't be changed are persisted.  If the file
is missing it will break the undercloud, so we should fail-fast and let
the user know about the problem.  Both the old and new path to the file
is checked.  If either is found, the validation will pass as the old
path will be migrated to the new during and update/upgrade.


- **hosts**: undercloud
- **groups**: prep, pre-upgrade, pre-update
- **parameters**:
- **roles**: validate_passwords_file

Role documentation

.. toctree::

   roles/role-validate_passwords_file