question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Hard-to-find documentation for a Docker image

See original GitHub issue

Hello,

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

CC: @potiuk @kaxil @ashb @vikramkoka @ryw

Issue Analytics

  • State:closed
  • Created 3 years ago
  • Reactions:2
  • Comments:7 (7 by maintainers)

github_iconTop GitHub Comments

1reaction
mik-lajcommented, Mar 9, 2021

@potiuk Terraform has a drop down menu in the section under the link with the documentation. Screenshot 2021-03-10 at 00 38 29

They also have links to other documentation packages in the side menu. Screenshot 2021-03-10 at 00 38 43

0reactions
mik-lajcommented, Mar 10, 2021

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 the airflow user. The simplest solution is: to usetecnativa/docker-socket-proxy:0.1.1. See: https://github.com/apache/airflow/issues/8605

So 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.

Read more comments on GitHub >

github_iconTop Results From Across the Web

docker images - Docker Documentation
docker images : The default `docker images` will show all top level images, their repository and tags, and their size. Docker images have...
Read more >
docker image inspect
docker image inspect: Display detailed information on one or more images.
Read more >
Docker Hub Quickstart
Docker Hub is a service provided by Docker for finding and sharing container images with your team. It is the world's largest repository...
Read more >
docker pull - Docker Documentation
Pull an image from Docker Hub . To download a particular image, or set of images (i.e., a repository), use docker pull ....
Read more >
Overview | Docker Documentation
Build and run an image as a container; Share images using Docker Hub; Deploy Docker applications using multiple containers with a database; Run...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found