[airflow] 09/09: Improved instructions for custom image build with docker compose (#21052)

[je...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

jedcunningham pushed a commit to branch v2-2-test
in repository https://gitbox.apache.org/repos/asf/airflow.git

commit e898e0eeabf428afaf835992c9e1450c726f006e
Author: Omer Ginosar <94...@users.noreply.github.com>
AuthorDate: Tue Jan 25 23:51:16 2022 +0200

    Improved instructions for custom image build with docker compose (#21052)
    
    * Create build.rst
    
    * Update docs/docker-stack/build.rst
    
    Co-authored-by: Jarek Potiuk <ja...@potiuk.com>
    
    * fix doc build
    
    Co-authored-by: Jarek Potiuk <ja...@potiuk.com>
    Co-authored-by: eladkal <45...@users.noreply.github.com>
    (cherry picked from commit 17b48e5baf09a86ea6e2036c864a882bb0c328e2)
---
 docs/docker-stack/build.rst | 19 +++++++++++++++++--
 docs/spelling_wordlist.txt  |  1 +
 2 files changed, 18 insertions(+), 2 deletions(-)

diff --git a/docs/docker-stack/build.rst b/docs/docker-stack/build.rst
index b85bf1c..6b5dc47 100644
--- a/docs/docker-stack/build.rst
+++ b/docs/docker-stack/build.rst
@@ -81,8 +81,23 @@ In the simplest case building your image consists of those steps:
 
 4) Once you build the image locally you have usually several options to make them available for your deployment:
 
-* For ``docker-compose`` deployment, that's all you need. The image is stored in docker engine cache
-  and docker compose will use it from there.
+* For ``docker-compose`` deployment, if you've already built your image, and want to continue
+  building the image manually when needed with ``docker build``, you can edit the
+  docker-compose.yaml and replace the "apache/airflow:<version>" image with the
+  image you've just built ``my-image:0.0.1`` - it will be used from your local Docker
+  Engine cache. You can also simply set ``AIRFLOW_IMAGE_NAME`` variable to
+  point to your image and ``docker-compose`` will use it automatically without having
+  to modify the file.
+
+* Also for ``docker-compose`` deployment, you can delegate image building to the docker-compose.
+  To do that - open your ``docker-compose.yaml`` file and search for the phrase "In order to add custom dependencies".
+  Follow these instructions of commenting the "image" line and uncommenting the "build" line.
+  This is a standard docker-compose feature and you can read about it in
+  `Docker Compose build reference <https://docs.docker.com/compose/reference/build/>`_.
+  Run ``docker-compose build`` to build the images. Similarly as in the previous case, the
+  image is stored in Docker engine cache and Docker Compose will use it from there.
+  The ``docker-compose build`` command uses the same ``docker build`` command that
+  you can run manually under-the-hood.
 
 * For some - development targeted - Kubernetes deployments you can load the images directly to
   Kubernetes clusters. Clusters such as ``kind`` or ``minikube`` have dedicated ``load`` method to load the
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 64d839f..5d77e29 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -1384,6 +1384,7 @@ uid
 umask
 un
 unarchived
+uncommenting
 undead
 ungenerated
 unicode