You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "rqi14 (via GitHub)" <gi...@apache.org> on 2023/10/28 14:58:59 UTC
[PR] Update webserver.rst to include information of supported OAuth2 providers [airflow]
rqi14 opened a new pull request, #35237:
URL: https://github.com/apache/airflow/pull/35237
To include information of supported OAuth2 providers
Related to issue #35131
<!--
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.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 [newsfragments](https://github.com/apache/airflow/tree/main/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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1789834017
Awesome work, congrats on your first merged pull request! You are invited to check our [Issue Tracker](https://github.com/apache/airflow/issues) for additional contributions.
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "rqi14 (via GitHub)" <gi...@apache.org>.
rqi14 commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1785569348
> > > Static checks are failing. You can fix them by running pre-commits. Please see [documentation](https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst)
> >
> >
> > It believes `keycloak` has spelling error. Is there a way to fix?
>
> Regardless of whether it is going to fix it, we probably should capitalize them
I guess it is not a very good idea to capitalize them. I left them as it is in the code. If the capitalized name is put into the setting as one reads the document, the code will not recognize the provider and return an error.
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #35237:
URL: https://github.com/apache/airflow/pull/35237#discussion_r1376499268
##########
docs/apache-airflow/security/webserver.rst:
##########
@@ -95,7 +95,9 @@ Other Methods
Since Airflow 2.0, the default UI is the Flask App Builder RBAC. A ``webserver_config.py`` configuration file
is automatically generated and can be used to configure the Airflow to support authentication
-methods like OAuth, OpenID, LDAP, REMOTE_USER.
+methods like OAuth, OpenID, LDAP, REMOTE_USER. It should be noted that due to the limitation of Flask AppBuilder
+and Authlib, only a selection of OAuth2 providers is supported. This list includes github, githublocal, twitter,
+linkedin, google, azure, openshift, okta, keycloak and keycloak_before_17.
Review Comment:
```suggestion
and Authlib, only a selection of OAuth2 providers is supported. This list includes ``github``, ``githublocal``, ``twitter``,
``linkedin``, ``google``, ``azure``, ``openshift``, ``okta``, ``keycloak`` and ``keycloak_before_17``.
```
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #35237:
URL: https://github.com/apache/airflow/pull/35237#discussion_r1376486858
##########
docs/apache-airflow/security/webserver.rst:
##########
@@ -95,7 +95,9 @@ Other Methods
Since Airflow 2.0, the default UI is the Flask App Builder RBAC. A ``webserver_config.py`` configuration file
is automatically generated and can be used to configure the Airflow to support authentication
-methods like OAuth, OpenID, LDAP, REMOTE_USER.
+methods like OAuth, OpenID, LDAP, REMOTE_USER. It should be noted that due to the limitation of Flask AppBuilder
+and Authlib, only a selection of OAuth2 providers is supported. This list includes github, githublocal, twitter,
+linkedin, google, azure, openshift, okta, keycloak and keycloak_before_17.
Review Comment:
```suggestion
and Authlib, only a selection of OAuth2 providers is supported. This list includes Github, Githublocal, Twitter,
Linkedin, Google, Azure, Openshift, Okta, Keycloak and Keycloak_before_17.
```
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on code in PR #35237:
URL: https://github.com/apache/airflow/pull/35237#discussion_r1376486858
##########
docs/apache-airflow/security/webserver.rst:
##########
@@ -95,7 +95,9 @@ Other Methods
Since Airflow 2.0, the default UI is the Flask App Builder RBAC. A ``webserver_config.py`` configuration file
is automatically generated and can be used to configure the Airflow to support authentication
-methods like OAuth, OpenID, LDAP, REMOTE_USER.
+methods like OAuth, OpenID, LDAP, REMOTE_USER. It should be noted that due to the limitation of Flask AppBuilder
+and Authlib, only a selection of OAuth2 providers is supported. This list includes github, githublocal, twitter,
+linkedin, google, azure, openshift, okta, keycloak and keycloak_before_17.
Review Comment:
```suggestion
and Authlib, only a selection of OAuth2 providers is supported. This list includes Github, Githublocal, Twitter,
Linkedin, Google, Azure, Openshift, Okta, Keycloak and Keycloak_before_17.
```
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1785581964
> > > > Static checks are failing. You can fix them by running pre-commits. Please see [documentation](https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst)
> > >
> > >
> > > It believes `keycloak` has spelling error. Is there a way to fix?
> >
> >
> > Regardless of whether it is going to fix it, we probably should capitalize them
>
> I guess it is not a very good idea to capitalize them. I left them as it is in the code. If the capitalized name is put into the setting as one reads the document, the code will not recognize the provider and return an error.
Very good point! Then we should wrap these values with "``<value>``". See my suggestion
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1785329469
Static checks are failing. You can fix them by running pre-commits. Please see [documentation](https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk merged PR #35237:
URL: https://github.com/apache/airflow/pull/35237
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "vincbeck (via GitHub)" <gi...@apache.org>.
vincbeck commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1785563183
> > Static checks are failing. You can fix them by running pre-commits. Please see [documentation](https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst)
>
> It believes `keycloak` has spelling error. Is there a way to fix?
Regardless of whether it is going to fix it, we probably should capitalize them
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1783839399
Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [pre-commits]( https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst#prerequisites-for-pre-commit-hooks) will help you with that.
- In case of a new feature add useful documentation (in docstrings or in `docs/` directory). Adding a new operator? Check this short [guide](https://github.com/apache/airflow/blob/main/docs/apache-airflow/howto/custom-operator.rst) Consider adding an example DAG that shows how users should use it.
- Consider using [Breeze environment](https://github.com/apache/airflow/blob/main/BREEZE.rst) for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
- Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
- Please follow [ASF Code of Conduct](https://www.apache.org/foundation/policies/conduct) for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
- Be sure to read the [Airflow Coding style]( https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#coding-style-and-best-practices).
- Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
Apache Airflow is a community-driven project and together we are making it better 🚀.
In case of doubts contact the developers at:
Mailing List: dev@airflow.apache.org
Slack: https://s.apache.org/airflow-slack
--
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] Update webserver.rst to include information of supported OAuth2 providers [airflow]
Posted by "rqi14 (via GitHub)" <gi...@apache.org>.
rqi14 commented on PR #35237:
URL: https://github.com/apache/airflow/pull/35237#issuecomment-1785519146
> Static checks are failing. You can fix them by running pre-commits. Please see [documentation](https://github.com/apache/airflow/blob/main/STATIC_CODE_CHECKS.rst)
It believes `keycloak` has spelling error. Is there a way to fix?
--
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