You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by "kneckinator (via GitHub)" <gi...@apache.org> on 2025/09/15 05:57:22 UTC
[PR] Add SELinux/AppArmor note for creating airflow.cfg [airflow]
kneckinator opened a new pull request, #55662:
URL: https://github.com/apache/airflow/pull/55662
<!--
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. -->
---
Adding SELinux/AppArmor note for creating the `airflow.cfg`, which makes the process of trying out Apache Airflow easier.
**^ 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 SELinux/AppArmor note for creating airflow.cfg [airflow]
Posted by "ashb (via GitHub)" <gi...@apache.org>.
ashb commented on code in PR #55662:
URL: https://github.com/apache/airflow/pull/55662#discussion_r2348933145
##########
airflow-core/docs/howto/docker-compose/index.rst:
##########
@@ -153,6 +153,23 @@ If you want to initialize ``airflow.cfg`` with default values before launching t
docker compose run airflow-cli airflow config list
This will seed ``airflow.cfg`` with default values in ``config`` folder.
+On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your `docker-compose.yaml` file by added the suffix `:z` to all volumes:
+
+.. code-block:: text
+
+ volumes:
+ - ${AIRFLOW_PROJ_DIR:-.}/dags:/opt/airflow/dags:z
+ - ${AIRFLOW_PROJ_DIR:-.}/logs:/opt/airflow/logs:z
+ - ${AIRFLOW_PROJ_DIR:-.}/config:/opt/airflow/config:z
+ - ${AIRFLOW_PROJ_DIR:-.}/plugins:/opt/airflow/plugins:z
+
+If, after this change, you are still experiencing permission issues when creating the `airflow.cfg` file, you can apply a very permissive setting to the `config` folder:
Review Comment:
```suggestion
If, after this change, you are still experiencing permission issues when creating the ``airflow.cfg`` file, you can apply a very permissive setting to the `config` folder:
```
##########
airflow-core/docs/howto/docker-compose/index.rst:
##########
@@ -153,6 +153,23 @@ If you want to initialize ``airflow.cfg`` with default values before launching t
docker compose run airflow-cli airflow config list
This will seed ``airflow.cfg`` with default values in ``config`` folder.
+On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your `docker-compose.yaml` file by added the suffix `:z` to all volumes:
+
+.. code-block:: text
+
+ volumes:
+ - ${AIRFLOW_PROJ_DIR:-.}/dags:/opt/airflow/dags:z
+ - ${AIRFLOW_PROJ_DIR:-.}/logs:/opt/airflow/logs:z
+ - ${AIRFLOW_PROJ_DIR:-.}/config:/opt/airflow/config:z
+ - ${AIRFLOW_PROJ_DIR:-.}/plugins:/opt/airflow/plugins:z
+
+If, after this change, you are still experiencing permission issues when creating the `airflow.cfg` file, you can apply a very permissive setting to the `config` folder:
+
+.. code-block:: bash
+
+ sudo chmod -R 777 ./config
+
+Note that the above is a _work around_ that should never be used in production.
Review Comment:
`_` is markdown. In rst we use `*` for em and `**` for bold.
```suggestion
Note that the above is a *work around* that should never be used in production.
```
##########
airflow-core/docs/howto/docker-compose/index.rst:
##########
@@ -153,6 +153,23 @@ If you want to initialize ``airflow.cfg`` with default values before launching t
docker compose run airflow-cli airflow config list
This will seed ``airflow.cfg`` with default values in ``config`` folder.
+On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your `docker-compose.yaml` file by added the suffix `:z` to all volumes:
Review Comment:
```suggestion
On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your ``docker-compose.yaml`` file by added the suffix ``:z`` to all volumes:
```
##########
airflow-core/docs/howto/docker-compose/index.rst:
##########
@@ -153,6 +153,23 @@ If you want to initialize ``airflow.cfg`` with default values before launching t
docker compose run airflow-cli airflow config list
This will seed ``airflow.cfg`` with default values in ``config`` folder.
+On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your `docker-compose.yaml` file by added the suffix `:z` to all volumes:
+
+.. code-block:: text
Review Comment:
```suggestion
.. code-block:: yaml
```
--
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 SELinux/AppArmor note for creating airflow.cfg [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #55662:
URL: https://github.com/apache/airflow/pull/55662#issuecomment-3297414937
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] Add SELinux/AppArmor note for creating airflow.cfg [airflow]
Posted by "ashb (via GitHub)" <gi...@apache.org>.
ashb commented on code in PR #55662:
URL: https://github.com/apache/airflow/pull/55662#discussion_r2348948137
##########
airflow-core/docs/howto/docker-compose/index.rst:
##########
@@ -153,6 +153,23 @@ If you want to initialize ``airflow.cfg`` with default values before launching t
docker compose run airflow-cli airflow config list
This will seed ``airflow.cfg`` with default values in ``config`` folder.
+On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your ``docker-compose.yaml`` file by added the suffix ``:z`` to all volumes:
Review Comment:
```suggestion
On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your ``docker-compose.yaml`` file by added the suffix ``:z`` to all volumes:
```
--
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 SELinux/AppArmor note for creating airflow.cfg [airflow]
Posted by "ashb (via GitHub)" <gi...@apache.org>.
ashb merged PR #55662:
URL: https://github.com/apache/airflow/pull/55662
--
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 SELinux/AppArmor note for creating airflow.cfg [airflow]
Posted by "ashb (via GitHub)" <gi...@apache.org>.
ashb commented on code in PR #55662:
URL: https://github.com/apache/airflow/pull/55662#discussion_r2349066450
##########
airflow-core/docs/howto/docker-compose/index.rst:
##########
@@ -154,6 +154,24 @@ If you want to initialize ``airflow.cfg`` with default values before launching t
This will seed ``airflow.cfg`` with default values in ``config`` folder.
+On systems with SELinux/AppArmor, you may run into permission issues. If this happens, edit your ``docker-compose.yaml`` file by added the suffix ``:z`` to all volumes:
+
+.. code-block:: yaml
+
+ volumes:
+ - ${AIRFLOW_PROJ_DIR:-.}/dags:/opt/airflow/dags:z
+ - ${AIRFLOW_PROJ_DIR:-.}/logs:/opt/airflow/logs:z
+ - ${AIRFLOW_PROJ_DIR:-.}/config:/opt/airflow/config:z
+ - ${AIRFLOW_PROJ_DIR:-.}/plugins:/opt/airflow/plugins:z
+
+If, after this change, you are still experiencing permission issues when creating the ``airflow.cfg`` file, you can apply a very permissive setting to the `config` folder:
Review Comment:
```suggestion
If, after this change, you are still experiencing permission issues when creating the ``airflow.cfg`` file, you can apply a very permissive setting to the ``config/`` folder:
```
--
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 SELinux/AppArmor note for creating airflow.cfg [airflow]
Posted by "boring-cyborg[bot] (via GitHub)" <gi...@apache.org>.
boring-cyborg[bot] commented on PR #55662:
URL: https://github.com/apache/airflow/pull/55662#issuecomment-3290597204
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 Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:
- Pay attention to the quality of your code (ruff, mypy and type annotations). Our [prek-hooks]( https://github.com/apache/airflow/blob/main/contributing-docs/08_static_code_checks.rst#prerequisites-for-prek-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/airflow-core/docs/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/dev/breeze/doc/README.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-docs/05_pull_requests.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