Configuration Reference¶

This page contains the list of all available Airflow configurations for the apache-airflow-providers-keycloak provider that can be set in the airflow.cfg file or using environment variables.

Note

For more information see Setting Configuration Options.

[keycloak_auth_manager]¶

This section contains settings for Keycloak auth manager integration.

client_id¶

Added in version 0.0.1.

Client ID configured in Keycloak to integrate with Airflow. This client must follow the standard OpenID Connect authentication flow.

Type:: string
Default:: None
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__CLIENT_ID

client_secret¶

Added in version 0.0.1.

Secret associated to the client configured in Keycloak to integrate with Airflow.

Type:

string

Default:

None

Environment Variables:

AIRFLOW__KEYCLOAK_AUTH_MANAGER__CLIENT_SECRET

AIRFLOW__KEYCLOAK_AUTH_MANAGER__CLIENT_SECRET_CMD

AIRFLOW__KEYCLOAK_AUTH_MANAGER__CLIENT_SECRET_SECRET

realm¶

Added in version 0.0.1.

Realm configured in Keycloak associated to Airflow. This realm define all users, roles and groups used in Airflow.

Type:: string
Default:: None
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__REALM

requests_pool_size¶

Added in version 0.4.0.

Size of the connection pool used by the Keycloak auth manager. This setting improves performance when multiple requests are made to Keycloak server.

Type:: integer
Default:: 10
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__REQUESTS_POOL_SIZE
Example:: 10

requests_retries¶

Added in version 0.4.0.

Number of retries for failed requests made by the Keycloak auth manager. This setting helps to handle transient network issues.

Type:: integer
Default:: 3
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__REQUESTS_RETRIES
Example:: 3

server_url¶

Added in version 0.0.1.

Keycloak server URL. This server URL is used by the Airflow API server to communicate with Keycloak. If the Airflow API server and Keycloak are running in Docker, set “http://host.docker.internal:<PORT>” (default value).

Type:: string
Default:: http://host.docker.internal:48080
Environment Variable:: AIRFLOW__KEYCLOAK_AUTH_MANAGER__SERVER_URL