You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "bugraoz93 (via GitHub)" <gi...@apache.org> on 2025/08/25 23:09:12 UTC
[PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
bugraoz93 opened a new pull request, #54928:
URL: https://github.com/apache/airflow/pull/54928
<!--
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.
-->
<!--
Thank you for contributing! Please make sure that your code changes
are covered with tests. And in case of new features or big changes
remember to adjust the documentation.
Feel free to ping committers for the review!
In case of an existing issue, reference it using one of the following:
closes: #ISSUE
related: #ISSUE
How to write a good git commit message:
http://chris.beams.io/posts/git-commit/
-->
<!-- Please keep an empty line above the dashes. -->
---
**^ Add meaningful description above**
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/contributing-docs/05_pull_requests.rst#pull-request-guidelines)** for more information.
In case of fundamental code changes, an Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvement+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in a newsfragment file, named `{pr_number}.significant.rst` or `{issue_number}.significant.rst`, in [airflow-core/newsfragments](https://github.com/apache/airflow/tree/main/airflow-core/newsfragments).
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on PR #54928:
URL: https://github.com/apache/airflow/pull/54928#issuecomment-3225397560
Thanks both for the reviews! :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2299553356
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
Review Comment:
```suggestion
One-go creation of permissions
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2299553356
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
Review Comment:
```suggestion
One-go creation of permissions
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2301806624
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
Review Comment:
I forgot to add permissions there, and also included what is created underneath in parentheses.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on PR #54928:
URL: https://github.com/apache/airflow/pull/54928#issuecomment-3225207205
Okay, I will update the rest in a batch commit :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2300850362
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
Review Comment:
```suggestion
You can set-up and manage user permissions with Keycloak auth manager in different ways:
1. Using Airflow CLI
2. Using Keycloak console
With Airflow CLI
----------------
Setting up the permissions can easily done using CLI commands.
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on PR #54928:
URL: https://github.com/apache/airflow/pull/54928#issuecomment-3222009697
@vincbeck Welcome back! :beer: Sorry for delaying this! I will follow up with more updates in the following days.
I focused on making `airflowctl` ready, and we are ready after some amount of PRs :)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2301804552
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create scopes for the permissions. These scopes later will be used in Keycloak authorization [1].
+
+.. code-block:: bash
+
+ airflow keycloak create-scopes
+
+This will create scopes for certain types of permissions.
Review Comment:
Updated and moved them before the command. Agree, nice one
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2301803358
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create scopes for the permissions. These scopes later will be used in Keycloak authorization [1].
Review Comment:
Updated with the RestructuredText’s footnote syntax.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI usage and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 merged PR #54928:
URL: https://github.com/apache/airflow/pull/54928
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "bugraoz93 (via GitHub)" <gi...@apache.org>.
bugraoz93 commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2301761464
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create scopes for the permissions. These scopes later will be used in Keycloak authorization [1].
+
+.. code-block:: bash
+
+ airflow keycloak create-scopes
+
+This will create scopes for certain types of permissions.
+
+.. code-block:: bash
+
+ airflow keycloak create-resources
+
+This will create resources for certain types of permissions.
+
+.. code-block:: bash
+
+ airflow keycloak create-permissions
+
+Finally we create the permissions using the previously created scopes and resources.
+
+This will create
+
+* read-only permissions
+* admin permissions
+* user permissions
+* operations permissions
+
+More resources about permissions can be found in the official documentation of Keycloak:
+
+1- `Keylcloak Authorization Process <https://www.keycloak.org/docs/latest/authorization_services/index.html#the-authorization-process>`_
+
+2- `Keycloak Permission Overview <https://www.keycloak.org/docs/latest/authorization_services/index.html#_permission_overview>`_
+
+3- `Keycloak Creating scope-based Permissions <https://www.keycloak.org/docs/latest/authorization_services/index.html#_policy_overview>`_
Review Comment:
Yes, I found them from the code base :) https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#hyperlinks
<img width="1918" height="943" alt="Screenshot from 2025-08-26 20-00-41" src="https://github.com/user-attachments/assets/0686bdef-4514-40cf-bb0f-69c79fe844cb" />
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2299552966
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create scopes for the permissions. These scopes later will be used in Keycloak authorization [1].
+
+.. code-block:: bash
+
+ airflow keycloak create-scopes
+
+This will create scopes for certain types of permissions.
+
+.. code-block:: bash
+
+ airflow keycloak create-resources
+
+This will create resources for certain types of permissions.
+
+.. code-block:: bash
+
+ airflow keycloak create-permissions
+
+Finally we create the permissions using the previously created scopes and resources.
+
+This will create
+
+* read-only permissions
+* admin permissions
+* user permissions
+* operations permissions
+
+More resources about permissions can be found in the official documentation of Keycloak:
+
+1- `Keylcloak Authorization Process <https://www.keycloak.org/docs/latest/authorization_services/index.html#the-authorization-process>`_
+
+2- `Keycloak Permission Overview <https://www.keycloak.org/docs/latest/authorization_services/index.html#_permission_overview>`_
+
+3- `Keycloak Creating scope-based Permissions <https://www.keycloak.org/docs/latest/authorization_services/index.html#_policy_overview>`_
Review Comment:
Would these handle correctly in rst?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
Re: [PR] docs(keycloak): Update documentation for Keycloak auth manager CLI age and permission management [airflow]
Posted by "uranusjr (via GitHub)" <gi...@apache.org>.
uranusjr commented on code in PR #54928:
URL: https://github.com/apache/airflow/pull/54928#discussion_r2299553866
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
Review Comment:
```suggestion
There are two options to create the permissions:
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
Review Comment:
```suggestion
* Create all permissions in one go using one single CLI command
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
Review Comment:
```suggestion
Please check the `Keycloak auth manager CLI </cli-refs.html>`_ documentation for more information about accepted parameters.
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
Review Comment:
```suggestion
* Create step-by-step using the CLI commands
```
What is this line supposed to mean? It creates a step-by-step (of what?) for the user??
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
Review Comment:
```suggestion
Setting up the permissions can be done using CLI commands.
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
Review Comment:
```suggestion
They can create the permissions and needed resources easily.
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
Review Comment:
```suggestion
One-go creation of permissions
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
Review Comment:
```suggestion
CLI commands take the following parameters:
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create scopes for the permissions. These scopes later will be used in Keycloak authorization [1].
Review Comment:
This should use RestructuredText’s footnote syntax. https://www.sphinx-doc.org/en/master/usage/restructuredtext/basics.html#footnotes
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
Review Comment:
```suggestion
Step-by-step creation of permissions
```
##########
providers/keycloak/docs/auth-manager/manage/permissions.rst:
##########
@@ -19,4 +19,72 @@
Manage user permissions with Keycloak auth manager
==================================================
-To be completed
+Please setup your Keycloak instance and required parameters for the Keycloak auth manager.
+
+Setting up the permissions can easily done using CLI commands.
+It can create the permissions and needed resources easily.
+
+There is two options to create the permissions:
+
+* Create all permissions in one go using single CLI command
+* Create step by step using the CLI commands
+
+CLI commands taking following parameters:
+
+* ``--username``: Keycloak admin username
+* ``--password``: Keycloak admin password
+* ``--user-realm``: Keycloak user realm (default: master)
+* ``--client-id``: Keycloak client id (default: admin-cli)
+
+Please check the documentation for more information about the parameters.
+
+`Keycloak auth manager CLI </cli-refs.html>`_
+
+One go creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+There is a single command do all the magic for you.
+
+.. code-block:: bash
+
+ airflow keycloak create-all
+
+This will create scopes, resources and permissions in one go.
+
+Step by step creation of permissions
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+First we need to create scopes for the permissions. These scopes later will be used in Keycloak authorization [1].
+
+.. code-block:: bash
+
+ airflow keycloak create-scopes
+
+This will create scopes for certain types of permissions.
Review Comment:
It would be more idiomatic to put the description _before_ the command instead so the user knows what’s going to happen before typing in the command. (Especially since the descriptions use future tense.)
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org