You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "potiuk (via GitHub)" <gi...@apache.org> on 2024/03/01 15:39:48 UTC
[PR] Add section about local settings configuration. [airflow]
potiuk opened a new pull request, #37829:
URL: https://github.com/apache/airflow/pull/37829
Often people see in our docs or issues/discussions that they should configure local settings, but - surprisingly - there is not a single section that explains it. Some specific configuration capabilities mention it and some even explain a bit more, but generally speaking there was not a single place where you could check what local settings are and how to configure them.
This PR changes it:
* adds a section about it in configuration docs
* points to this section from every place in our docs where it is mentioned you can use local settings
* the section also links back to the places that can be configured as a set of example ways local settings can be useful.
<!--
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 [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] Add section about local settings configuration. [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on code in PR #37829:
URL: https://github.com/apache/airflow/pull/37829#discussion_r1509292335
##########
docs/apache-airflow/howto/set-config.rst:
##########
@@ -167,6 +167,34 @@ the example below.
that you run airflow components on is synchronized (for example using ntpd) otherwise you might get
"forbidden" errors when the logs are accessed.
+.. _set-config:configuring-local-settings:
+
+Configuring local settings
+==========================
+
+Some Airflow configuration is configured via local setting, because they require changes in the
+code that is executed when Airflow is initialized. Usually It is mentioned in the detailed documentation
Review Comment:
```suggestion
code that is executed when Airflow is initialized. Usually it is mentioned in the detailed documentation
```
--
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 section about local settings configuration. [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on code in PR #37829:
URL: https://github.com/apache/airflow/pull/37829#discussion_r1509273244
##########
docs/apache-airflow/howto/set-config.rst:
##########
@@ -167,6 +167,34 @@ the example below.
that you run airflow components on is synchronized (for example using ntpd) otherwise you might get
"forbidden" errors when the logs are accessed.
+.. _set-config:configuring-local-settings:
+
+Configuring local settings
+==========================
+
+Some of Airflow configuration can be configured via local setting, because they require changes in the
+code that is executed when airflow is initialized. Usually It is mentioned in the detailed documentation
+where you can configure such local settings - This is usually done in the ``airflow_local_settings.py`` file.
+
+You should create ``airflow_local_settings.py`` file and put in on ``$PYTHONPATH`` or
+to ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config`` on ``PYTHONPATH`` when
Review Comment:
If we want a section to explain sys.path vs PYTHONPATH, we can, but I don't think we need it.
--
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 section about local settings configuration. [airflow]
Posted by "potiuk (via GitHub)" <gi...@apache.org>.
potiuk commented on code in PR #37829:
URL: https://github.com/apache/airflow/pull/37829#discussion_r1509287031
##########
docs/apache-airflow/howto/set-config.rst:
##########
@@ -167,6 +167,34 @@ the example below.
that you run airflow components on is synchronized (for example using ntpd) otherwise you might get
"forbidden" errors when the logs are accessed.
+.. _set-config:configuring-local-settings:
+
+Configuring local settings
+==========================
+
+Some of Airflow configuration can be configured via local setting, because they require changes in the
+code that is executed when airflow is initialized. Usually It is mentioned in the detailed documentation
+where you can configure such local settings - This is usually done in the ``airflow_local_settings.py`` file.
+
+You should create ``airflow_local_settings.py`` file and put in on ``$PYTHONPATH`` or
+to ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config`` on ``PYTHONPATH`` when
Review Comment:
Yep. I just copied it from an existing explanation elsewhere - but this is cleaner.
--
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 section about local settings configuration. [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham merged PR #37829:
URL: https://github.com/apache/airflow/pull/37829
--
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 section about local settings configuration. [airflow]
Posted by "jedcunningham (via GitHub)" <gi...@apache.org>.
jedcunningham commented on code in PR #37829:
URL: https://github.com/apache/airflow/pull/37829#discussion_r1509269574
##########
docs/apache-airflow/howto/set-config.rst:
##########
@@ -167,6 +167,34 @@ the example below.
that you run airflow components on is synchronized (for example using ntpd) otherwise you might get
"forbidden" errors when the logs are accessed.
+.. _set-config:configuring-local-settings:
+
+Configuring local settings
+==========================
+
+Some of Airflow configuration can be configured via local setting, because they require changes in the
Review Comment:
```suggestion
Some Airflow configuration is configured via local setting, because they require changes in the
```
##########
docs/apache-airflow/howto/set-config.rst:
##########
@@ -167,6 +167,34 @@ the example below.
that you run airflow components on is synchronized (for example using ntpd) otherwise you might get
"forbidden" errors when the logs are accessed.
+.. _set-config:configuring-local-settings:
+
+Configuring local settings
+==========================
+
+Some of Airflow configuration can be configured via local setting, because they require changes in the
+code that is executed when airflow is initialized. Usually It is mentioned in the detailed documentation
Review Comment:
```suggestion
code that is executed when Airflow is initialized. Usually It is mentioned in the detailed documentation
```
##########
docs/apache-airflow/howto/set-config.rst:
##########
@@ -167,6 +167,34 @@ the example below.
that you run airflow components on is synchronized (for example using ntpd) otherwise you might get
"forbidden" errors when the logs are accessed.
+.. _set-config:configuring-local-settings:
+
+Configuring local settings
+==========================
+
+Some of Airflow configuration can be configured via local setting, because they require changes in the
+code that is executed when airflow is initialized. Usually It is mentioned in the detailed documentation
+where you can configure such local settings - This is usually done in the ``airflow_local_settings.py`` file.
+
+You should create ``airflow_local_settings.py`` file and put in on ``$PYTHONPATH`` or
+to ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config`` on ``PYTHONPATH`` when
Review Comment:
```suggestion
You should create a ``airflow_local_settings.py`` file and put it in a directory in ``sys.path`` or
in the ``$AIRFLOW_HOME/config`` folder. (Airflow adds ``$AIRFLOW_HOME/config`` to ``sys.path`` when
```
--
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