lint - Validate playbook variables¶

- name: validate configuration
  lint:
    rules:
      # inform the user of a change in the configuration so that they can update:
      - state: deprecated
        path: secrets.artifactory.api_token
        hint: 'rename to "artifactory_api_token"'

      # apply to a set of variables:
      - state: deprecated
        path: secrets.jfrog.*
        hint: 'rename to "artifactory_*"'

      # fail unless a variable be set:
      - state: required
        path: artifactory_api_token

      # fail if a variable has an invalid value:
      - state: invalid
        path: services.*.address
        when: item is not match('[\d\.]+')
        hint: 'address must be an IP address (A record) not a hostname'

      # require a value to be one of an enum:
      - state: invalid
        path: some_variable
        when: item not in [ 'foo', 'bar', 'baz' ]

      # warn about unrecognized properties:
      - state: suspicious
        path: services.*.*
        when: captures[1] not in [ 'address', 'port' ]
        banner: 'The following properties are not recognized:'
        hint: 'please check for typos'

- name: load user settings
  include_vars:
    file: user_settings.yml
    name: user_setting_pool
  when: user_settings.yml is file

- name: validate user settings
  lint:
    pool:
      - "{{ user_setting_pool }}"
      - additional_var: 1
    rules:
      - state: deprecated
        path: foo