You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@airflow.apache.org by GitBox <gi...@apache.org> on 2022/01/24 10:17:50 UTC
[GitHub] [airflow] eladkal commented on a change in pull request #21044: Refresh Breeze documentation
eladkal commented on a change in pull request #21044:
URL: https://github.com/apache/airflow/pull/21044#discussion_r790592680
##########
File path: BREEZE.rst
##########
@@ -366,73 +370,61 @@ Then run the failed command, copy-and-paste the output from your terminal to the
`Airflow Slack <https://s.apache.org/airflow-slack>`_ #airflow-breeze channel and
describe your problem.
-Other uses of the Airflow Breeze environment
-============================================
+Uses of the Airflow Breeze environment
+======================================
Airflow Breeze is a bash script serving as a "swiss-army-knife" of Airflow testing. Under the
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:
-
-Managing CI environment:
-
- * Build CI docker image with ``breeze build-image`` command
- * Enter interactive shell in CI container when ``shell`` (or no command) is specified
- * Join running interactive shell with ``breeze exec`` command
- * Stop running interactive environment with ``breeze stop`` command
- * Restart running interactive environment with ``breeze restart`` command
- * Run test specified with ``breeze tests`` command
- * Generate constraints with ``breeze generate-constraints``
- * Execute arbitrary command in the test environment with ``breeze shell`` command
- * Execute arbitrary docker-compose command with ``breeze docker-compose`` command
- * Push docker images with ``breeze push-image`` command (require committers rights to push images)
-
-You can optionally reset the Airflow metadata database if specified as extra ``--db-reset`` flag and for CI image
-you can also start integrations (separate Docker images) if specified as extra ``--integration`` flags. You can also
-chose which backend database should be used with ``--backend`` flag and python version with ``--python`` flag.
+environment. Breeze script allows performing the following tasks:
-You can also have breeze launch Airflow automatically ``breeze start-airflow``, this will drop you in a
-tmux session with three panes:
-
- - one to monitor the scheduler,
- - one for the webserver,
- - one with a shell for additional commands.
-
-Managing Prod environment (with ``--production-image`` flag):
+Airflow developers tasks
+------------------------
- * Build CI docker image with ``breeze build-image`` command
- * Enter interactive shell in PROD container when ``shell`` (or no command) is specified
- * Join running interactive shell with ``breeze exec`` command
- * Stop running interactive environment with ``breeze stop`` command
- * Restart running interactive environment with ``breeze restart`` command
- * Execute arbitrary command in the test environment with ``breeze shell`` command
- * Execute arbitrary docker-compose command with ``breeze docker-compose`` command
- * Push docker images with ``breeze push-image`` command (require committers rights to push images)
+Regular development tasks:
-You can optionally reset database if specified as extra ``--db-reset`` flag. You can also
-chose which backend database should be used with ``--backend`` flag and python version with ``--python`` flag.
+* Setup autocomplete for Breeze with ``breeze setup-autocomplete`` 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 ``breeze initialize-local-virtualenv`` command
+* Build CI docker image with ``breeze build-image`` command
+* Cleanup CI docker image with ``breeze cleanup-image`` command
+* Run static checks with autocomplete support ``breeze static-check`` command
+* Run test specified with ``breeze tests`` command
+Additional management tasks:
-Manage and Interact with Kubernetes tests environment:
+* Join running interactive shell with ``breeze exec`` command
+* Stop running interactive environment with ``breeze stop`` command
+* Restart running interactive environment with ``breeze restart`` command
+* Execute arbitrary command in the test environment with ``breeze shell`` command
+* Execute arbitrary docker-compose command with ``breeze docker-compose`` command
- * Manage KinD Kubernetes cluster and deploy Airflow to KinD cluster ``breeze kind-cluster`` commands
- * Run Kubernetes tests specified with ``breeze kind-cluster tests`` command
- * Enter the interactive kubernetes test environment with ``breeze kind-cluster shell`` command
+Kubernetes tests related.
-Run static checks:
+* Manage KinD Kubernetes cluster and deploy Airflow to KinD cluster ``breeze kind-cluster`` commands
+* Run Kubernetes tests specified with ``breeze kind-cluster tests`` command
+* Enter the interactive kubernetes test environment with ``breeze kind-cluster shell`` command
- * Run static checks - either for currently staged change or for all files with
- ``breeze static-check`` command
+Airflow can also be used for managing Production images (with ``--production-image`` flag added for image
+related command) - 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>`_
-Build documentation:
+Maintainer tasks
+----------------
- * Build documentation with ``breeze build-docs`` command
+Maintainers also can use Breeze for other purposes (those are commands that regular contributors likely
+do not need:
Review comment:
```suggestion
Maintainers also can use Breeze for other purposes (those are commands that regular contributors likely
do not need):
```
##########
File path: BREEZE.rst
##########
@@ -366,73 +370,61 @@ Then run the failed command, copy-and-paste the output from your terminal to the
`Airflow Slack <https://s.apache.org/airflow-slack>`_ #airflow-breeze channel and
describe your problem.
-Other uses of the Airflow Breeze environment
-============================================
+Uses of the Airflow Breeze environment
+======================================
Airflow Breeze is a bash script serving as a "swiss-army-knife" of Airflow testing. Under the
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:
-
-Managing CI environment:
-
- * Build CI docker image with ``breeze build-image`` command
- * Enter interactive shell in CI container when ``shell`` (or no command) is specified
- * Join running interactive shell with ``breeze exec`` command
- * Stop running interactive environment with ``breeze stop`` command
- * Restart running interactive environment with ``breeze restart`` command
- * Run test specified with ``breeze tests`` command
- * Generate constraints with ``breeze generate-constraints``
- * Execute arbitrary command in the test environment with ``breeze shell`` command
- * Execute arbitrary docker-compose command with ``breeze docker-compose`` command
- * Push docker images with ``breeze push-image`` command (require committers rights to push images)
-
-You can optionally reset the Airflow metadata database if specified as extra ``--db-reset`` flag and for CI image
-you can also start integrations (separate Docker images) if specified as extra ``--integration`` flags. You can also
-chose which backend database should be used with ``--backend`` flag and python version with ``--python`` flag.
+environment. Breeze script allows performing the following tasks:
-You can also have breeze launch Airflow automatically ``breeze start-airflow``, this will drop you in a
-tmux session with three panes:
-
- - one to monitor the scheduler,
- - one for the webserver,
- - one with a shell for additional commands.
-
-Managing Prod environment (with ``--production-image`` flag):
+Airflow developers tasks
+------------------------
- * Build CI docker image with ``breeze build-image`` command
- * Enter interactive shell in PROD container when ``shell`` (or no command) is specified
- * Join running interactive shell with ``breeze exec`` command
- * Stop running interactive environment with ``breeze stop`` command
- * Restart running interactive environment with ``breeze restart`` command
- * Execute arbitrary command in the test environment with ``breeze shell`` command
- * Execute arbitrary docker-compose command with ``breeze docker-compose`` command
- * Push docker images with ``breeze push-image`` command (require committers rights to push images)
+Regular development tasks:
-You can optionally reset database if specified as extra ``--db-reset`` flag. You can also
-chose which backend database should be used with ``--backend`` flag and python version with ``--python`` flag.
+* Setup autocomplete for Breeze with ``breeze setup-autocomplete`` 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 ``breeze initialize-local-virtualenv`` command
+* Build CI docker image with ``breeze build-image`` command
+* Cleanup CI docker image with ``breeze cleanup-image`` command
+* Run static checks with autocomplete support ``breeze static-check`` command
+* Run test specified with ``breeze tests`` command
+Additional management tasks:
-Manage and Interact with Kubernetes tests environment:
+* Join running interactive shell with ``breeze exec`` command
+* Stop running interactive environment with ``breeze stop`` command
+* Restart running interactive environment with ``breeze restart`` command
+* Execute arbitrary command in the test environment with ``breeze shell`` command
+* Execute arbitrary docker-compose command with ``breeze docker-compose`` command
- * Manage KinD Kubernetes cluster and deploy Airflow to KinD cluster ``breeze kind-cluster`` commands
- * Run Kubernetes tests specified with ``breeze kind-cluster tests`` command
- * Enter the interactive kubernetes test environment with ``breeze kind-cluster shell`` command
+Kubernetes tests related.
Review comment:
```suggestion
Kubernetes tests related:
```
--
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: commits-unsubscribe@airflow.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org