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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
