check_for_dangling_images

Check-for-dangling-images
=========================

Add Ansible role to check for dangling images

Requirements
------------

This role will be executed pre Update.


Role Variables
--------------

* `check_for_dangling_images_debug`: <'false'> -- debugging mode.

Dependencies
------------

No Dependencies

Example Playbook
----------------

    - hosts: servers
      roles:
      - { role: check_for_dangling_images, check_for_dangling_images_debug: true }

License
-------

Apache

Author Information
------------------

Red Hat TripleO DFG:Upgrades

Role Documentation

Welcome to the “check_for_dangling_images” role documentation.

Role Defaults

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

# All variables intended for modification should place placed in this file.

# All variables within this role should have a prefix of "check_for_dangling_images"
check_for_dangling_images_debug: false

Molecule Scenarios

Molecule is being used to test the “check_for_dangling_images” 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: Populate successful podman CLI
    copy:
      dest: /usr/bin/podman
      mode: 0755
      content: |
        #!/bin/bash

  - name: Test good values
    include_role:
      name: check_for_dangling_images

  - name: Populate failing podman CLI
    copy:
      dest: /usr/bin/podman
      mode: 0755
      content: |
        #!/bin/bash
        echo 4199acc83c6a43243392aecbff22764dbb501aef81a26d7c4c8c69064f84ef47

  - name: Test failing
    block:
    - name: Catch when images exist
      include_role:
        name: check_for_dangling_images
    rescue:
    - name: Clear host errors
      meta: clear_host_errors

    - debug:
        msg: The validation works! End the playbook run

    - name: End play
      meta: end_play

  - name: Fail the test
    fail:
      msg: |
        Found dangling podman images