Hard-to-find documentation for a Docker image
See original GitHub issueHello,
Currently, documentation for the Docker image is available in the middle of the “Production Deployment” page. This makes it difficult for the user to find this documentation. Also, this section is called “Production deployment”, but this image is also used in the development environment. I think we should extract the image sections, but I’m not sure where. I am thinking of a few solutions:
a) create a new page/section in apache-airflow
package. Then the documentation will available as a new menu item in the current documentation package. See “Content” section on http://airflow.apache.org/docs/apache-airflow/stable/index.html
b) create a new documentation package. Then the documentation will be available as a new item on docuemtation index
I prefer the second solution, but I am open to discussions.
It is worth considering that I am working on creating a new package for the Helm Chart. See:https://github.com/apache/airflow/pull/14643
Probably related: https://github.com/apache/airflow/issues/11740
Issue Analytics
- State:
- Created 3 years ago
- Reactions:2
- Comments:7 (7 by maintainers)
Top GitHub Comments
@potiuk Terraform has a drop down menu in the section under the link with the documentation.
They also have links to other documentation packages in the side menu.
I would like to add a few comments. I am working on more docker-composer example files so that users can test more easily. See: https://github.com/apache/airflow/issues/8605#issuecomment-759469443 When we create a new package of documentation for all things related to Docker, it will be easier to put it together.
Another thing that I am still missing is the description of how to use
DockerOperator
together with Docker-compose. Many users try to use this together but have problems with it because/var/docker.socks
cannot be read by theairflow
user. The simplest solution is: to usetecnativa/docker-socket-proxy:0.1.1
. See: https://github.com/apache/airflow/issues/8605So this documentation will increasingly describe how to deploy Airflow in a Docker/docker-compose environment much like the documentation for Helm Chart describes how to deploy Airflow in a Kubernetes environment.
Also, note that the documentation that describes how to build a Docker image describes building an image for multiple versions of Airflow. You can use the same instruction to build the image for Airflow 1.10 and for Airflow 2.0. The only difference is the additional flag.