You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "humit0 (via GitHub)" <gi...@apache.org> on 2025/05/02 03:54:17 UTC
[PR] Add webserver_config.py file to api-server [airflow]
humit0 opened a new pull request, #50108:
URL: https://github.com/apache/airflow/pull/50108
<!--
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/
-->
Previously, the api-server component did not include webserver_config.py, making it impossible to configure settings such as LDAP or OAuth2 authentication.
This implementation reference the existing method used by the webserver component.
<!-- 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] Add webserver_config.py file to api-server [airflow]
Posted by "GrumpyCat51 (via GitHub)" <gi...@apache.org>.
GrumpyCat51 commented on code in PR #50108:
URL: https://github.com/apache/airflow/pull/50108#discussion_r2156405831
##########
chart/templates/_helpers.yaml:
##########
@@ -582,6 +582,17 @@ server_tls_key_file = /etc/pgbouncer/server.key
readOnly: True
{{- end }}
+{{- define "airflow_api_server_config_configmap_name" -}}
+ {{- default (printf "%s-api-server-config" .Release.Name) .Values.webserver.webserverConfigConfigMapName }}
Review Comment:
This points to the wrong section in the values file. I'll include the fix in a new MR
--
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] Add webserver_config.py file to api-server [airflow]
Posted by "humit0 (via GitHub)" <gi...@apache.org>.
humit0 commented on code in PR #50108:
URL: https://github.com/apache/airflow/pull/50108#discussion_r2106384184
##########
chart/values.schema.json:
##########
@@ -5065,6 +5065,30 @@
],
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
},
+ "apiServerConfig": {
+ "description": "This string (templated) will be mounted into the Airflow API Server as a custom `webserver_config.py`. You can bake a `webserver_config.py` in to your image instead or specify a configmap containing the webserver_config.py.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "x-docsSection": "Common",
+ "default": null,
+ "examples": [
+ "from airflow import configuration as conf\n\n# The SQLAlchemy connection string.\nSQLALCHEMY_DATABASE_URI = conf.get('database', 'SQL_ALCHEMY_CONN')\n\n# Flask-WTF flag for CSRF\nCSRF_ENABLED = True"
+ ]
+ },
+ "apiServerConfigConfigMapName": {
+ "description": "The configmap name containing the webserver_config.py.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "x-docsSection": "Common",
+ "default": null,
+ "examples": [
+ "my-webserver-configmap"
Review Comment:
@romsharon98
I forgot to change it! thx.
--
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] Add webserver_config.py file to api-server [airflow]
Posted by "romsharon98 (via GitHub)" <gi...@apache.org>.
romsharon98 commented on code in PR #50108:
URL: https://github.com/apache/airflow/pull/50108#discussion_r2106151631
##########
chart/values.schema.json:
##########
@@ -5065,6 +5065,30 @@
],
"$ref": "#/definitions/io.k8s.api.core.v1.ResourceRequirements"
},
+ "apiServerConfig": {
+ "description": "This string (templated) will be mounted into the Airflow API Server as a custom `webserver_config.py`. You can bake a `webserver_config.py` in to your image instead or specify a configmap containing the webserver_config.py.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "x-docsSection": "Common",
+ "default": null,
+ "examples": [
+ "from airflow import configuration as conf\n\n# The SQLAlchemy connection string.\nSQLALCHEMY_DATABASE_URI = conf.get('database', 'SQL_ALCHEMY_CONN')\n\n# Flask-WTF flag for CSRF\nCSRF_ENABLED = True"
+ ]
+ },
+ "apiServerConfigConfigMapName": {
+ "description": "The configmap name containing the webserver_config.py.",
+ "type": [
+ "string",
+ "null"
+ ],
+ "x-docsSection": "Common",
+ "default": null,
+ "examples": [
+ "my-webserver-configmap"
Review Comment:
I think it's more correct example
```suggestion
"my-api-server-configmap"
```
--
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] Add webserver_config.py file to api-server [airflow]
Posted by "romsharon98 (via GitHub)" <gi...@apache.org>.
romsharon98 merged PR #50108:
URL: https://github.com/apache/airflow/pull/50108
--
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