undercloud_heat_purge_deleted

Warning

This role is not suited for Wallaby and more recent releases. As it expects presence ‘heat_api_cron’.

An Ansible role to check if heat-manage purge_deleted is enabled in the crontab

Requirements

This role requires an installed and working Undercloud.

Role Variables

• cron_check: <’heat-manage purge_deleted’> – String to check in the crontab

Dependencies

No dependencies.

Example Playbook

- hosts: undercloud
  roles:
     - { role: undercloud-heat-purge-deleted }

License

Apache

Author Information

Red Hat TripleO Validations Team

Full Description

Role Documentation

Welcome to the “undercloud_heat_purge_deleted” role documentation.

Role Defaults

This section highlights all of the defaults and variables set within the “undercloud_heat_purge_deleted” role.

cron_check: heat-manage purge_deleted

Role Variables: main.yaml

metadata:
  name: Verify heat-manage purge_deleted is enabled in crontab
  description: >
    Without a purge_deleted crontab enabled, the
    heat database can grow very large.  This validation checks that
    the purge_deleted crontab has been set up.
    This role should only be used on systems using 'heat_api_cron'.
    Starting from Wallaby, the 'heat_api_cron' is no longer installed by
    default, and the role may behave upredictably.
  groups: []

Molecule Scenarios

Molecule is being used to test the “undercloud_heat_purge_deleted” role. The following section highlights the drivers in service and provides an example playbook showing how the role is leveraged.

Scenario: default

Driver: podman:

Molecule Platform(s)

- name: centos
  hostname: centos
  image: centos/centos:stream8
  registry:
    url: quay.io
  dockerfile: ../../../../.config/molecule/Dockerfile
  pkg_extras: python*-setuptools python*-pyyaml
  volumes:
  - /etc/ci/mirror_info.sh:/etc/ci/mirror_info.sh:ro
  privileged: true
  environment:
    http_proxy: "{{ lookup('env', 'http_proxy') }}"
    https_proxy: "{{ lookup('env', 'https_proxy') }}"
  ulimits:
  - host

Molecule Inventory

hosts:
  all:
    hosts:
      centos:
        ansible_python_interpreter: /usr/bin/python3

Example default playbook

- name: Converge
  hosts: all
  gather_facts: false
  tasks:
  - name: working detection
    include_role:
      name: undercloud_heat_purge_deleted

  - name: Validate failure
    block:
    - name: Override container_cli
      copy:
        dest: '{{ ansible_env.HOME }}/undercloud.conf'
        content: |
          [DEFAULT]
          container_cli = docker

    - name: run validation
      include_role:
        name: undercloud_heat_purge_deleted
    rescue:
    - name: Clear host errors
      meta: clear_host_errors

    - name: Test output
      debug:
        msg: The validation works! Ending play.

    - name: End play
      meta: end_play

  - name: Fail the validation at this point
    fail:
      msg: |
        The undercloud_heat_purge_deleted validation failed to detect
        missing cron job.