Table of Contents generated with DocToc
- Airflow Docker images
- Building docker images from current sources
- Building PROD docker images from released PIP packages
- Using docker cache during builds
- Naming conventions
- Customizing the CI image
- Naming conventions for stored images
Airflow has two main images (build from Dockerfiles):
- Production image (Dockerfile) - that can be used to build your own production-ready Airflow installation. You can read more about building and using the production image in the Docker stack documentation. The image is built using Dockerfile.
- CI image (Dockerfile.ci) - used for running tests and local development. The image is built using Dockerfile.ci.
The PROD image is a multi-segment image. The first segment
airflow-build-image
contains all the build essentials and related
dependencies that allow to install airflow locally. By default the image
is built from a released version of Airflow from GitHub, but by
providing some extra arguments you can also build it from local sources.
This is particularly useful in CI environment where we are using the
image to run Kubernetes tests. See below for the list of arguments that
should be provided to build production image from the local sources.
The image is primarily optimised for size of the final image, but also
for speed of rebuilds - the airflow-build-image
segment uses the same
technique as the CI jobs for pre-installing dependencies. It first
pre-installs them from the right GitHub branch and only after that final
airflow installation is done from either local sources or remote
location (PyPI or GitHub repository).
You can read more details about building, extending and customizing the PROD image in the Latest documentation
The CI image is used by Breeze as the shell
image but it is also used during CI tests. The image is single segment
image that contains Airflow installation with "all" dependencies
installed. It is optimised for rebuild speed. It installs PIP
dependencies from the current branch first -so that any changes in
pyproject.toml
do not trigger reinstalling of all dependencies. There
is a second step of installation that re-installs the dependencies from
the latest sources so that we are sure that latest dependencies are
installed.
The easy way to build the CI/PROD images is to use Breeze. It uses a number of optimization and caches to build it efficiently and fast when you are developing Airflow and need to update to latest version.
For CI image: Airflow package is always built from sources. When you
execute the image, you can however use the --use-airflow-version
flag
(or USE_AIRFLOW_VERSION
environment variable) to remove the
preinstalled source version of Airflow and replace it with one of the
possible installation methods:
- "none" - airflow is removed and not installed
- "wheel" - airflow is removed and replaced with "wheel" version available in dist
- "sdist" - airflow is removed and replaced with "sdist" version available in dist
- "<VERSION>" - airflow is removed and installed from PyPI (with the specified version)
For PROD image: By default production image is built from the latest sources when using Breeze, but when you use it via docker build command, it uses the latest installed version of airflow and providers. However, you can choose different installation methods as described in Building PROD docker images from released PIP packages. Detailed reference for building production image from different sources can be found in: Build Args reference
You can build the CI image using current sources this command:
breeze ci-image build
You can build the PROD image using current sources with this command:
breeze prod-image build
By adding --python <PYTHON_MAJOR_MINOR_VERSION>
parameter you can
build the image version for the chosen Python version.
The images are built with default extras - different extras for CI and
production image and you can change the extras via the --airflow-extras
parameters and add new ones with --additional-airflow-extras
.
For example if you want to build Python 3.9 version of production image with "all" extras installed you should run this command:
breeze prod-image build --python 3.9 --airflow-extras "all"
If you just want to add new extras you can add them like that:
breeze prod-image build --python 3.9 --additional-airflow-extras "all"
The command that builds the CI image is optimized to minimize the time needed to rebuild the image when the source code of Airflow evolves. This means that if you already have the image locally downloaded and built, the scripts will determine whether the rebuild is needed in the first place. Then the scripts will make sure that minimal number of steps are executed to rebuild parts of the image (for example, PIP dependencies) and will give you an image consistent with the one used during Continuous Integration.
The command that builds the production image is optimised for size of the image.
You can also build production images from PIP packages via providing
--install-airflow-version
parameter to Breeze:
breeze prod-image build --python 3.9 --additional-airflow-extras=trino --install-airflow-version=2.0.0
This will build the image using command similar to:
pip install \
apache-airflow[async,amazon,celery,cncf.kubernetes,docker,elasticsearch,ftp,grpc,hashicorp,http,ldap,google,microsoft.azure,mysql,postgres,redis,sendgrid,sftp,slack,ssh,statsd,virtualenv]==2.0.0 \
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-2.0.0/constraints-3.9.txt"
Note
Only pip
installation is currently officially supported.
While they are some successes with using other tools like
poetry or
pip-tools, they do not share
the same workflow as pip
- especially when it comes to constraint
vs. requirements management. Installing via Poetry
or pip-tools
is
not currently supported.
There are known issues with bazel
that might lead to circular
dependencies when using it to install Airflow. Please switch to pip
if you encounter such problems. Bazel
community works on fixing the
problem in this
PR so it might
be that newer versions of bazel
will handle it.
If you wish to install airflow using those tools you should use the constraint files and convert them to appropriate format and workflow that your tool requires.
You can also build production images from specific Git version via
providing --install-airflow-reference
parameter to Breeze (this time
constraints are taken from the constraints-main
branch which is the
HEAD of development for constraints):
pip install "https://github.com/apache/airflow/archive/<tag>.tar.gz#egg=apache-airflow" \
--constraint "https://raw.githubusercontent.com/apache/airflow/constraints-main/constraints-3.9.txt"
You can also skip installing airflow and install it from locally
provided files by using --install-packages-from-context
parameter to
Breeze:
breeze prod-image build --python 3.9 --additional-airflow-extras=trino --install-packages-from-context
In this case you airflow and all packages (.whl files) should be placed
in docker-context-files
folder.
Default mechanism used in Breeze for building CI images uses images pulled from GitHub Container Registry. This is done to speed up local builds and building images for CI runs - instead of > 12 minutes for rebuild of CI images, it takes usually about 1 minute when cache is used. For CI images this is usually the best strategy - to use default "pull" cache. This is default strategy when Breeze builds are performed.
For Production Image - which is far smaller and faster to build, it's better to use local build cache (the standard mechanism that docker uses. This is the default strategy for production images when Breeze builds are performed. The first time you run it, it will take considerably longer time than if you use the pull mechanism, but then when you do small, incremental changes to local sources, Dockerfile image and scripts, further rebuilds with local build cache will be considerably faster.
You can also disable build cache altogether. This is the strategy used by the scheduled builds in CI - they will always rebuild all the images from scratch.
You can change the strategy by providing one of the --build-cache
flags: registry
(default), local
, or disabled
flags when you run
Breeze commands. For example:
breeze ci-image build --python 3.9 --docker-cache local
Will build the CI image using local build cache (note that it will take quite a long time the first time you run it).
breeze prod-image build --python 3.9 --docker-cache registry
Will build the production image with cache used from registry.
breeze prod-image build --python 3.9 --docker-cache disabled
Will build the production image from the scratch.
You can also turn local docker caching by setting DOCKER_CACHE
variable to local
, registry
, disabled
and exporting it.
export DOCKER_CACHE="registry"
or
export DOCKER_CACHE="local"
or
export DOCKER_CACHE="disabled"
By default images we are using cache for images in GitHub Container
registry. We are using GitHub Container Registry as development image
cache and CI registry for build images. The images are all in
organization wide "apache/" namespace. We are adding "airflow-" as
prefix for the image names of all Airflow images. The images are linked
to the repository via org.opencontainers.image.source
label in the
image.
See https://docs.github.com/en/packages/learn-github-packages/connecting-a-repository-to-a-package
Naming convention for the GitHub packages.
Images with a commit SHA (built for pull requests and pushes). Those are images that are snapshot of the currently run build. They are built once per each build and pulled by each test job.
ghcr.io/apache/airflow/<BRANCH>/ci/python<X.Y>:<COMMIT_SHA> - for CI images
ghcr.io/apache/airflow/<BRANCH>/prod/python<X.Y>:<COMMIT_SHA> - for production images
Thoe image contain inlined cache.
You can see all the current GitHub images at https://github.com/apache/airflow/packages
Note that you need to be committer and have the right to refresh the images in the GitHub Registry with latest sources from main via (./dev/refresh_images.sh). Only committers can push images directly. You need to login with your Personal Access Token with "packages" write scope to be able to push to those repositories or pull from them in case of GitHub Packages.
GitHub Container Registry
docker login ghcr.io
Since there are different naming conventions used for Airflow images and there are multiple images used, Breeze provides easy to use management interface for the images. The CI is designed in the way that it should automatically refresh caches, rebuild the images periodically and update them whenever new version of base Python is released. However, occasionally, you might need to rebuild images locally and push them directly to the registries to refresh them.
Every developer can also pull and run images being result of a specific
CI run in GitHub Actions. This is a powerful tool that allows to
reproduce CI failures locally, enter the images and fix them much
faster. It is enough to pass --image-tag
and the registry and Breeze
will download and execute commands using the same image that was used
during the CI tests.
For example this command will run the same Python 3.9 image as was used in build identified with 9a621eaa394c0a0a336f8e1b31b35eff4e4ee86e commit SHA with enabled rabbitmq integration.
breeze --image-tag 9a621eaa394c0a0a336f8e1b31b35eff4e4ee86e --python 3.9 --integration rabbitmq
You can see more details and examples inBreeze
Customizing the CI image allows to add your own dependencies to the image.
The easiest way to build the customized image is to use breeze
script,
but you can also build suc customized image by running appropriately
crafted docker build in which you specify all the build-args
that you
need to add to customize it. You can read about all the args and ways
you can build the image in the
#ci-image-build-arguments chapter below.
Here just a few examples are presented which should give you general understanding of what you can customize.
This builds the production image in version 3.9 with additional airflow extras from 2.0.0 PyPI package and additional apt dev and runtime dependencies.
As of Airflow 2.3.0, it is required to build images with
DOCKER_BUILDKIT=1
variable (Breeze sets DOCKER_BUILDKIT=1
variable
automatically) or via docker buildx build
command if you have buildx
plugin installed.
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg ADDITIONAL_AIRFLOW_EXTRAS="jdbc" \
--build-arg ADDITIONAL_PYTHON_DEPS="pandas" \
--build-arg ADDITIONAL_DEV_APT_DEPS="gcc g++" \
--tag my-image:0.0.1
the same image can be built using breeze
(it supports auto-completion
of the options):
breeze ci-image build --python 3.9 --additional-airflow-extras=jdbc --additional-python-deps="pandas" \
--additional-dev-apt-deps="gcc g++"
You can customize more aspects of the image - such as additional commands executed before apt dependencies are installed, or adding extra sources to install your dependencies from. You can see all the arguments described below but here is an example of rather complex command to customize the image based on example in this comment:
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg AIRFLOW_INSTALLATION_METHOD="apache-airflow" \
--build-arg ADDITIONAL_AIRFLOW_EXTRAS="slack" \
--build-arg ADDITIONAL_PYTHON_DEPS="apache-airflow-providers-odbc \
azure-storage-blob \
sshtunnel \
google-api-python-client \
oauth2client \
beautifulsoup4 \
dateparser \
rocketchat_API \
typeform" \
--build-arg ADDITIONAL_DEV_APT_DEPS="msodbcsql17 unixodbc-dev g++" \
--build-arg ADDITIONAL_DEV_APT_COMMAND="curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add --no-tty - && curl https://packages.microsoft.com/config/debian/12/prod.list > /etc/apt/sources.list.d/mssql-release.list" \
--build-arg ADDITIONAL_DEV_ENV_VARS="ACCEPT_EULA=Y"
--tag my-image:0.0.1
The following build arguments (--build-arg
in docker build command)
can be used for CI images:
Build argument | Default value | Description |
---|---|---|
PYTHON_BASE_IMAGE |
python:3.9-slim-bookworm |
Base Python image |
PYTHON_MAJOR_MINOR_VERSION |
3.9 |
major/minor version of Python (should match base image) |
DEPENDENCIES_EPOCH_NUMBER |
2 |
increasing this number will reinstall all apt dependencies |
ADDITIONAL_PIP_INSTALL_FLAGS |
additional pip flags passed to the installation commands (except when reinstalling pip itself) |
|
PIP_NO_CACHE_DIR |
true |
if true, then no pip cache will be stored |
UV_NO_CACHE |
true |
if true, then no uv cache will be stored |
HOME |
/root |
Home directory of the root user (CI image has root user as default) |
AIRFLOW_HOME |
/root/airflow |
Airflow's HOME (that's where logs and sqlite databases are stored) |
AIRFLOW_SOURCES |
/opt/airflow |
Mounted sources of Airflow |
AIRFLOW_REPO |
apache/airflow |
the repository from which PIP dependencies are pre-installed |
AIRFLOW_BRANCH |
main |
the branch from which PIP dependencies are pre-installed |
AIRFLOW_CI_BUILD_EPOCH |
1 |
increasing this value will reinstall PIP dependencies from the repository from scratch |
AIRFLOW_CONSTRAINTS_LOCATION |
If not empty, it will override the source of the constraints with the specified URL or file. | |
AIRFLOW_CONSTRAINTS_REFERENCE |
reference (branch or tag) from GitHub repository from which constraints are used. By default it is set to constraints-main but can be constraints-2-X . |
|
AIRFLOW_EXTRAS |
all |
extras to install |
UPGRADE_INVALIDATION_STRING |
If set to any random value the dependencies are upgraded to newer versions. In CI it is set to build id. | |
AIRFLOW_PRE_CACHED_PIP_PACKAGES |
true |
Allows to pre-cache airflow PIP packages from the GitHub of Apache Airflow This allows to optimize iterations for Image builds and speeds up CI jobs. |
ADDITIONAL_AIRFLOW_EXTRAS |
additional extras to install | |
ADDITIONAL_PYTHON_DEPS |
additional Python dependencies to install | |
DEV_APT_COMMAND |
Dev apt command executed before dev deps are installed in the first part of image | |
ADDITIONAL_DEV_APT_COMMAND |
Additional Dev apt command executed before dev dep are installed in the first part of the image | |
DEV_APT_DEPS |
Dev APT dependencies installed in the first part of the image (default empty means default dependencies are used) | |
ADDITIONAL_DEV_APT_DEPS |
Additional apt dev dependencies installed in the first part of the image | |
ADDITIONAL_DEV_APT_ENV |
Additional env variables defined when installing dev deps | |
AIRFLOW_PIP_VERSION |
24.3.1 |
PIP version used. |
AIRFLOW_UV_VERSION |
0.5.9 |
UV version used. |
AIRFLOW_USE_UV |
true |
Whether to use UV for installation. |
PIP_PROGRESS_BAR |
on |
Progress bar for PIP installation |
Here are some examples of how CI images can built manually. CI is always built from local sources.
This builds the CI image in version 3.9 with default extras ("all").
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" --tag my-image:0.0.1
This builds the CI image in version 3.9 with "gcp" extra only.
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg AIRFLOW_EXTRAS=gcp --tag my-image:0.0.1
This builds the CI image in version 3.9 with "apache-beam" extra added.
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg ADDITIONAL_AIRFLOW_EXTRAS="apache-beam" --tag my-image:0.0.1
This builds the CI image in version 3.9 with "mssql" additional package added.
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg ADDITIONAL_PYTHON_DEPS="mssql" --tag my-image:0.0.1
This builds the CI image in version 3.9 with "gcc" and "g++" additional apt dev dependencies added.
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg ADDITIONAL_DEV_APT_DEPS="gcc g++" --tag my-image:0.0.1
This builds the CI image in version 3.9 with "jdbc" extra and "default-jre-headless" additional apt runtime dependencies added.
DOCKER_BUILDKIT=1 docker build . -f Dockerfile.ci \
--pull \
--build-arg PYTHON_BASE_IMAGE="python:3.9-slim-bookworm" \
--build-arg AIRFLOW_EXTRAS=jdbc \
--tag my-image:0.0.1
The entrypoint in the CI image contains all the initialisation needed
for tests to be immediately executed. It is copied from
scripts/docker/entrypoint_ci.sh
.
The default behaviour is that you are dropped into bash shell. However if RUN_TESTS variable is set to "true", then tests passed as arguments are executed
The entrypoint performs those operations:
- checks if the environment is ready to test (including database and all integrations). It waits until all the components are ready to work
- removes and re-installs another version of Airflow (if another version
of Airflow is requested to be reinstalled via
USE_AIRFLOW_PYPI_VERSION
variable. - Sets up Kerberos if Kerberos integration is enabled (generates and configures Kerberos token)
- Sets up ssh keys for ssh tests and restarts the SSH server
- Sets all variables and configurations needed for unit tests to run
- Reads additional variables set in
files/airflow-breeze-config/variables.env
by sourcing that file - In case of CI run sets parallelism to 2 to avoid excessive number of processes to run
- In case of CI run sets default parameters for pytest
- In case of running integration/long_running/quarantined tests - it sets the right pytest flags
- Sets default "tests" target in case the target is not explicitly set as additional argument
- Runs system tests if TEST_GROUP is "system-core" or "system-providers" otherwise runs regular unit and integration tests
The images produced during the Build Images
workflow of CI jobs are
stored in the GitHub Container
Registry
The images are stored with both "latest" tag (for last main push image that passes all the tests as well with the COMMIT_SHA id for images that were used in particular build.
The image names follow the patterns (except the Python image, all the
images are stored in https://ghcr.io/ in apache
organization.
The packages are available under (CONTAINER_NAME is url-encoded name of
the image). Note that "/" are supported now in the ghcr.io
as a part
of the image name within the apache
organization, but they have to be
percent-encoded when you access them via UI (/ = %2F)
https://github.com/apache/airflow/pkgs/container/<CONTAINER_NAME>
Image | Name:tag (both cases latest version and per-build) | Description |
---|---|---|
Python image (DockerHub) | python:<X.Y>-slim-bookworm | Base Python image used by both production and CI image. |
CI image | airflow/<BRANCH>/ci/python<X.Y>:<TAG> | CI image - this is the image used for most of the tests. |
PROD image | airflow/<BRANCH>/prod/python<X.Y>:<TAG> | faster to build or pull. Production image optimized for size. |
- <BRANCH> might be either "main" or "v2-*-test"
- <X.Y> - Python version (Major + Minor).Should be one of ["3.9", "3.10", "3.11", "3.12" ].
- <COMMIT_SHA> - full-length SHA of commit either from the tip of the branch (for pushes/schedule) or commit from the tip of the branch used for the PR.
- <TAG> - tag of the image. It is either "latest" or <COMMIT_SHA> (full-length SHA of commit either from the tip of the branch (for pushes/schedule) or commit from the tip of the branch used for the PR).
Read next about Github Variables