Airflow Breeze is an easy-to-use development and test environment using Docker Compose. The environment is available for local use and is also used in Airflow's CI tests.
We call it Airflow Breeze as It's a Breeze to contribute to Airflow.
The advantages and disadvantages of using the Breeze environment vs. other ways of testing Airflow are described in Integration test development environments.
You can use the Breeze environment to run Airflow's tests locally and reproduce CI failures.
The following documents describe how to use the Breeze environment:
- Installation - describes how to install the Breeze environment on your machine.
- Customizing - describes how to customize the Breeze environment.
- Developer tasks - describes how to use Breeze for regular developer tasks.
- Troubleshooting - describes how to troubleshoot the Breeze environment.
- Test commands - describes how to run Airflow's tests (and reproduce CI failures) using the Breeze environment.
- Managing Docker images - describes how to manage the Breeze images.
- Breeze maintenance tasks - describes how to perform maintenance tasks when you develop Breeze itself.
- CI tasks - describes how Breeze commands are used in our CI.
- Release management tasks - describes how to use Breeze for release management tasks.
- Advanced Breeze topics - describes advanced Breeze topics/internals of Breeze.
You can also learn more context and Architecture Decisions taken when developing Breeze in the Architecture Decision Records.
Next step: Follow the Installation instructions to install the Breeze environment.