Resource Type: keycloak_conn_validator

Defined in:
lib/puppet/type/keycloak_conn_validator.rb
Providers:
puppet_https

Overview

Verify that a connection can be successfully established between a node and the keycloak server. Its primary use is as a precondition to prevent configuration changes from being applied if the keycloak server cannot be reached, but it could potentially be used for other purposes such as monitoring.

Properties

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent

Parameters

  • keycloak_port (defaults to: 8080)

    The port that the keycloak server should be listening on.

  • keycloak_server (defaults to: localhost)

    The DNS name or IP address of the server where keycloak should be running.

  • name (namevar)

    An arbitrary name used as the identity of the resource.

  • provider

    The specific backend to use for this keycloak_conn_validator resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • relative_path (defaults to: /)

    URL relative path that is used by Keycloak

  • test_url (defaults to: /realms/master/.well-known/openid-configuration)

    URL to use for testing if the Keycloak database is up

  • timeout (defaults to: 30)

    The max number of seconds that the validator should wait before giving up and deciding that keycloak is not running; defaults to 15 seconds.

  • use_ssl (defaults to: false)

    Whether the connection will be attemped using https