potiuk commented on code in PR #25888: URL: https://github.com/apache/airflow/pull/25888#discussion_r952625705
########## docs/apache-airflow/howto/docker-compose/index.rst: ########## @@ -20,68 +20,35 @@ Running Airflow in Docker ######################### -This quick-start guide will allow you to quickly get Airflow up and running with :doc:`CeleryExecutor </executor/celery>` in Docker. For running airflow in production, we recommend running on kubernetes with the official helm chart. - -Customizing the quick-start Docker Compose -========================================== - -DO NOT attempt to customize images and the Docker Compose if you do not know exactly what you are doing, -do not know Docker Compose, or are not prepared to debug and resolve problems on your own. If you do not -know Docker Compose and expect Airflow to **just work** beyond following precisely the quick-start, -then please use other ways of running Airflow - for example :doc:`/start/local` for testing and trying -and :doc:`Official Airflow Community Helm Chart<helm-chart:index>` for production purposes. - -Even if many users think of Docker Compose as "ready to use", it is really a developer tool, that requires -the user to know very well how docker images, containers, docker compose networking, volumes, naming, image -building works. It is extremely easy to make mistakes that lead to difficult to diagnose problems and if -you are not ready to spend your own time on learning and diagnosing and resolving those problems on your own -do not follow this path. You have been warned. - -If you customize, or modify images, the compose file and see problem do not expect you will get a lot of -help with solving those problems in the Airflow support channels. Most of the problems you will experience -are Docker Compose related problems and if you need help in solving them, there are dedicated channels in -`Docker Compose <https://github.com/docker/compose>`_ that you can use. - -Production readiness -==================== +This quick-start guide will allow you to quickly get Airflow up and running with :doc:`CeleryExecutor </executor/celery>` in Docker. .. warning:: - DO NOT expect the Docker Compose below will be enough to run production-ready Docker Compose Airflow installation using it. - This is truly ``quick-start`` docker-compose for you to get Airflow up and running locally and get your hands dirty with - Airflow. Configuring a Docker-Compose installation that is ready for production requires an intrinsic knowledge of - Docker Compose, a lot of customization and possibly even writing the Docker Compose file that will suit your needs - from the scratch. It's probably OK if you want to run Docker Compose-based deployment, but short of becoming a - Docker Compose expert, it's highly unlikely you will get robust deployment with it. - - If you want to get an easy to configure Docker-based deployment that Airflow Community develops, supports and - can provide support with deployment, you should consider using Kubernetes and deploying Airflow using - :doc:`Official Airflow Community Helm Chart<helm-chart:index>`. + Setting up Airflow using Docker compose can be useful for learning and exploration, but has several operational shortcomings. For running Airflow in production, we recommend Kubernetes with the :doc:`Official Airflow Community Helm Chart<helm-chart:index>`. Review Comment: I do not know how to do it in a way that willl be short and smart, but I really think we need to to have a link where we send people to when they claim "this your official compose - we expect it to work, help us". -- 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: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
