potiuk commented on code in PR #23193: URL: https://github.com/apache/airflow/pull/23193#discussion_r857153525
########## BREEZE.rst: ########## @@ -445,64 +448,81 @@ Airflow Breeze is a bash script serving as a "swiss-army-knife" of Airflow testi hood it uses other scripts that you can also run manually if you have problem with running the Breeze environment. Breeze script allows performing the following tasks: -Airflow developers tasks ------------------------- +Development tasks +----------------- -Regular development tasks: +Those are commands mostly used by contributors: -* Setup autocomplete for Breeze with ``breeze setup-autocomplete`` command +* Execute arbitrary command in the test environment with ``breeze shell`` command * Enter interactive shell in CI container when ``shell`` (or no command) is specified * Start containerised, development-friendly airflow installation with ``breeze start-airflow`` command * Build documentation with ``breeze build-docs`` command * Initialize local virtualenv with ``./scripts/tools/initialize_virtualenv.py`` command -* Cleanup breeze with ``breeze cleanup`` command * Run static checks with autocomplete support ``breeze static-checks`` command * Run test specified with ``./breeze-legacy tests`` command - -CI Image tasks: - -* Build CI docker image with ``breeze build-image`` command -* Pull CI images in parallel ``breeze pull-image`` command -* Verify CI image ``breeze verify-image`` command - -PROD Image tasks: -* Build PROD image with ``breeze build-prod-image`` command -* Pull PROD image in parallel ``breeze pull-prod-image`` command -* Verify CI image ``breeze verify-prod-image`` command - -Additional management tasks: - * Join running interactive shell with ``./breeze-legacy exec`` command * Stop running interactive environment with ``breeze stop`` command -* Execute arbitrary command in the test environment with ``breeze shell`` command * Execute arbitrary docker-compose command with ``./breeze-legacy docker-compose`` command -Docker compose tests: +Tests +----- * Run docker-compose tests with ``breeze docker-compose-tests`` command. -Kubernetes tests related: +Kubernetes tests +---------------- * Manage KinD Kubernetes cluster and deploy Airflow to KinD cluster ``./breeze-legacy kind-cluster`` commands * Run Kubernetes tests specified with ``./breeze-legacy kind-cluster tests`` command * Enter the interactive kubernetes test environment with ``./breeze-legacy kind-cluster shell`` command -Airflow can also be used for managing Production images - this is a development-only feature, -regular users of Airflow should use ``docker build`` commands to manage the images as described -in the user documentation about `building the image <https://airflow.apache.org/docs/docker-stack/build.html>`_ +CI Image tasks +-------------- + +The image building is usually run for users automatically when needed, +but sometimes Breeze users might want to manually build, pull or verify the CI images. + +* Build CI docker image with ``breeze build-image`` command +* Pull CI images in parallel ``breeze pull-image`` command +* Verify CI image ``breeze verify-image`` command -Maintainer tasks +PROD Image tasks ---------------- +Users can also build Production images when they are developing them. However when you want to +use the PROD image, the regular docker build commands are recommended. See +`building the image <https://airflow.apache.org/docs/docker-stack/build.html>`_ + +* Build PROD image with ``breeze build-prod-image`` command +* Pull PROD image in parallel ``breeze pull-prod-image`` command +* Verify CI image ``breeze verify-prod-image`` command + +Configuration and maintenance +----------------------------- + +* Cleanup breeze with ``breeze cleanup`` command +* Self-upgrade breeze with ``breeze self-upgrade`` command +* Setup autocomplete for Breeze with ``breeze setup-autocomplete`` command +* Checking available resources for docker with ``breeze resource-check`` command +* Freeing space needed to run CI tests with ``breeze free-space`` command +* Fixing ownership of files in your repository with ``breeze fix-ownership`` command +* Print Breeze version with ``breeze fix-ownership`` command Review Comment: Ah yeah :) -- 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]
