undercloud_debug

Role Documentation

Welcome to the “undercloud_debug” role documentation.

Role Defaults

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

debug_check: true
services_conf_files:
- /var/lib/config-data/puppet-generated/nova/etc/nova/nova.conf
- /var/lib/config-data/puppet-generated/neutron/etc/neutron/neutron.conf
- /var/lib/config-data/puppet-generated/ceilometer/etc/ceilometer/ceilometer.conf
- /var/lib/config-data/puppet-generated/heat/etc/heat/heat.conf
- /var/lib/config-data/puppet-generated/ironic/etc/ironic/ironic.conf

Role Variables: main.yaml

metadata:
  description: 'The undercloud''s openstack services should _not_ have debug enabled.
    This will check if debug is enabled on undercloud services. If debug is enabled,
    the root filesystem can fill up quickly, and is not a good thing.

    '
  groups:
  - pre-deployment
  name: Undercloud Services Debug Check

Molecule Scenarios

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

Scenario: default

Example default configuration

driver:
  name: podman
log: true
platforms:
- dockerfile: ../../../../.config/molecule/Dockerfile
  environment:
    http_proxy: '{{ lookup(''env'', ''http_proxy'') }}'
    https_proxy: '{{ lookup(''env'', ''https_proxy'') }}'
  hostname: centos
  image: centos/centos:stream8
  name: centos
  pkg_extras: python*-setuptools python*-pyyaml
  privileged: true
  registry:
    url: quay.io
  ulimits:
  - host
  volumes:
  - /etc/ci/mirror_info.sh:/etc/ci/mirror_info.sh:ro
provisioner:
  env:
    ANSIBLE_LIBRARY: ${ANSIBLE_LIBRARY:-/usr/share/ansible/plugins/modules}
    ANSIBLE_ROLES_PATH: ${ANSIBLE_ROLES_PATH}:${HOME}/zuul-jobs/roles
    ANSIBLE_STDOUT_CALLBACK: yaml
  inventory:
    hosts:
      all:
        hosts:
          centos:
            ansible_python_interpreter: /usr/bin/python3
  log: true
  name: ansible
  options:
    vvv: true
scenario:
  test_sequence:
  - destroy
  - create
  - prepare
  - converge
  - verify
  - destroy
verifier:
  name: ansible

Molecule Inventory

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

Example default playbook

- gather_facts: false
  hosts: all
  name: Converge
  tasks:
  - copy:
      content: '[DEFAULT]

        debug: true

        '
      dest: /tmp/debug_true_1.conf
    name: prepare fake config file
  - include_role:
      name: undercloud_debug
    name: Checking good value
    vars:
      debug_check: false
  - block:
    - include_role:
        name: undercloud_debug
    name: Should fail due to bad value
    rescue:
    - meta: clear_host_errors
      name: Clear host errors
    - debug:
        msg: The validation works! End the playbook run
    - meta: end_play
      name: End play
  - fail:
      msg: 'The undercloud_debug should have detected a configuration issue

        '
    name: Fail the test
  vars:
    services_conf_files:
    - /tmp/debug_true_1.conf