kaxil commented on a change in pull request #15592:
URL: https://github.com/apache/airflow/pull/15592#discussion_r623158453
##########
File path: docs/apache-airflow/start/docker.rst
##########
@@ -207,3 +211,45 @@ What's Next?
============
From this point, you can head to the :doc:`/tutorial` section for further
examples or the :doc:`/howto/index` section if you're ready to get your hands
dirty.
+
+.. _docker-compose-env-variables:
+
+Environment variables supported by Docker Compose
+=================================================
+
++----------------------------+-----------------------------------------------------+--------------------------+
+| Variable | Description
| Default |
++============================+=====================================================+==========================+
+| AIRFLOW_IMAGE_NAME | Airflow Image to use.
| apache/airflow:|version| |
++----------------------------+-----------------------------------------------------+--------------------------+
+| AIRFLOW_UID | UID of the user to run Airflow containers as.
| 50000 |
+| | Override if you want to use use non-default
Airflow | |
+| | UID (for example when you map folders from
host, | |
+| | it should be set to result of ``id -u`` call.
If | |
+| | you change it from default 50000, you must set
| |
+| | ``AIRFLOW_GID`` to 0. When it is changed,
| |
+| | the user with the UID specified is dynamically
| |
+| | created inside the container and home of the
user | |
+| | is set to /airflow/home. This is in order to
| |
+| | achieve OpenShift compatibility. See more in
the | |
+| | :ref:`Arbitrary Docker User
<arbitrary-docker-user>`| |
++----------------------------+-----------------------------------------------------+--------------------------+
+| AIRFLOW_GID | Group ID in Airflow containers. It overrides
the | 50000 |
+| | GID of the user. It is 50000 by default but if
| |
Review comment:
```suggestion
| | GID of the user. It is ``50000`` by default
but if | |
```
##########
File path: docs/apache-airflow/start/docker.rst
##########
@@ -207,3 +211,45 @@ What's Next?
============
From this point, you can head to the :doc:`/tutorial` section for further
examples or the :doc:`/howto/index` section if you're ready to get your hands
dirty.
+
+.. _docker-compose-env-variables:
+
+Environment variables supported by Docker Compose
+=================================================
+
++----------------------------+-----------------------------------------------------+--------------------------+
+| Variable | Description
| Default |
++============================+=====================================================+==========================+
+| AIRFLOW_IMAGE_NAME | Airflow Image to use.
| apache/airflow:|version| |
++----------------------------+-----------------------------------------------------+--------------------------+
+| AIRFLOW_UID | UID of the user to run Airflow containers as.
| 50000 |
+| | Override if you want to use use non-default
Airflow | |
+| | UID (for example when you map folders from
host, | |
+| | it should be set to result of ``id -u`` call.
If | |
+| | you change it from default 50000, you must set
| |
+| | ``AIRFLOW_GID`` to 0. When it is changed,
| |
+| | the user with the UID specified is dynamically
| |
+| | created inside the container and home of the
user | |
+| | is set to /airflow/home. This is in order to
| |
+| | achieve OpenShift compatibility. See more in
the | |
+| | :ref:`Arbitrary Docker User
<arbitrary-docker-user>`| |
++----------------------------+-----------------------------------------------------+--------------------------+
+| AIRFLOW_GID | Group ID in Airflow containers. It overrides
the | 50000 |
+| | GID of the user. It is 50000 by default but if
| |
+| | you want to use different UID than default it
must | |
+| | be set to 0.
| |
Review comment:
```suggestion
| | be set to ``0``.
| |
```
--
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.
For queries about this service, please contact Infrastructure at:
[email protected]
