contributing-docs/21_keycloak_client_settings.rst
.. Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to you under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
.. http://www.apache.org/licenses/LICENSE-2.0
.. Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Setting up Keycloak Client for Breeze
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
To fully integrate Keycloak into local Airflow development with Breeze, you need to configure a Keycloak client.
You can start by using the breeze start-airflow --integration keycloak command,
which launches Airflow with Keycloak support and starts a Keycloak instance with default settings.
Next, create a Keycloak client for Airflow in the Keycloak admin console, accessible at http://localhost:48080/.
During client creation, the relevant configuration section is called Login Settings;
after the client is created, this section appears as Access Settings.
.. list-table:: :header-rows: 1 :widths: 25 75 75
After you configure the client, the settings will persist as long as the Docker volumes are not removed.
To obtain the client credentials, open the Credentials tab of the client you created.