From 13c62b52cbe0bdcf3319a403ce061268661245b3 Mon Sep 17 00:00:00 2001 From: Jarek Potiuk Date: Sat, 4 Jun 2022 20:43:44 +0200 Subject: [PATCH] Update 'rich' to latest version across the board. (#24186) That Also includes regenerating the breeze output images. --- .pre-commit-config.yaml | 42 +- dev/breeze/README.md | 2 +- dev/breeze/setup.cfg | 2 +- images/breeze/output-build-docs.svg | 300 +++++++++--- images/breeze/output-build-image.svg | 315 ++++++++++--- images/breeze/output-build-prod-image.svg | 400 ++++++++++++---- images/breeze/output-cleanup.svg | 100 +++- images/breeze/output-command-hash-export.svg | 70 ++- images/breeze/output-commands.svg | 435 ++++++++++++++---- images/breeze/output-config.svg | 130 ++++-- images/breeze/output-docker-compose-tests.svg | 110 +++-- images/breeze/output-exec.svg | 75 ++- .../breeze/output-find-newer-dependencies.svg | 115 +++-- images/breeze/output-fix-ownership.svg | 80 +++- images/breeze/output-free-space.svg | 80 +++- images/breeze/output-generate-constraints.svg | 170 +++++-- .../breeze/output-prepare-airflow-package.svg | 105 ++++- .../output-prepare-provider-documentation.svg | 155 +++++-- .../output-prepare-provider-packages.svg | 165 +++++-- images/breeze/output-pull-image.svg | 165 +++++-- images/breeze/output-pull-prod-image.svg | 165 +++++-- images/breeze/output-release-prod-images.svg | 145 ++++-- images/breeze/output-resource-check.svg | 75 ++- images/breeze/output-self-upgrade.svg | 85 +++- images/breeze/output-setup-autocomplete.svg | 95 +++- images/breeze/output-shell.svg | 245 +++++++--- images/breeze/output-start-airflow.svg | 255 +++++++--- images/breeze/output-static-checks.svg | 270 ++++++++--- images/breeze/output-stop.svg | 90 +++- images/breeze/output-tests.svg | 115 +++-- images/breeze/output-verify-image.svg | 110 +++-- images/breeze/output-verify-prod-image.svg | 110 +++-- .../output-verify-provider-packages.svg | 160 +++++-- images/breeze/output-version.svg | 70 ++- setup.cfg | 2 +- 35 files changed, 3868 insertions(+), 1140 deletions(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 7de8e753565ea1..041eca2891c97f 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -324,7 +324,7 @@ repos: files: ^setup\.cfg$|^setup\.py$ pass_filenames: false entry: ./scripts/ci/pre_commit/pre_commit_check_order_setup.py - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: check-extra-packages-references name: Checks setup extra packages description: Checks if all the libraries in setup.py are listed in extra-packages-ref.rst file @@ -332,7 +332,7 @@ repos: files: ^setup\.py$|^docs/apache-airflow/extra-packages-ref\.rst$ pass_filenames: false entry: ./scripts/ci/pre_commit/pre_commit_check_setup_extra_packages_ref.py - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] # This check might be removed when min-airflow-version in providers is 2.2 - id: check-airflow-2-1-compatibility name: Check that providers are 2.1 compatible. @@ -340,21 +340,21 @@ repos: language: python pass_filenames: true files: ^airflow/providers/.*\.py$ - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: update-breeze-file name: Update output of breeze commands in BREEZE.rst entry: ./scripts/ci/pre_commit/pre_commit_breeze_cmd_line.py language: python files: ^BREEZE\.rst$|^dev/breeze/.*$ pass_filenames: false - additional_dependencies: ['rich>=12.4.1', 'rich-click'] + additional_dependencies: ['rich>=12.4.4', 'rich-click'] - id: update-local-yml-file name: Update mounts in the local yml file entry: ./scripts/ci/pre_commit/pre_commit_local_yml_mounts.py language: python files: ^dev/breeze/src/airflow_breeze/utils/docker_command_utils\.py$|^scripts/ci/docker_compose/local\.yml$ pass_filenames: false - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: update-setup-cfg-file name: Update setup.cfg file with all licenses entry: ./scripts/ci/pre_commit/pre_commit_setup_cfg_file.sh @@ -380,7 +380,7 @@ repos: language: python files: ^Dockerfile$ pass_filenames: false - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: update-supported-versions name: Updates supported versions in documentation entry: ./scripts/ci/pre_commit/pre_commit_supported_versions.py @@ -608,7 +608,7 @@ repos: - 'jsonschema>=3.2.0,<5.0.0' - 'tabulate==0.8.8' - 'jsonpath-ng==1.5.3' - - 'rich>=12.4.1' + - 'rich>=12.4.4' - id: check-pre-commit-information-consistent name: Update information re pre-commit hooks and verify ids and names entry: ./scripts/ci/pre_commit/pre_commit_check_pre_commit_hooks.py @@ -616,7 +616,7 @@ repos: - --max-length=64 language: python files: ^\.pre-commit-config\.yaml$|^scripts/ci/pre_commit/pre_commit_check_pre_commit_hook_names\.py$ - additional_dependencies: ['pyyaml', 'jinja2', 'black==22.3.0', 'tabulate', 'rich>=12.4.1'] + additional_dependencies: ['pyyaml', 'jinja2', 'black==22.3.0', 'tabulate', 'rich>=12.4.4'] require_serial: true pass_filenames: false - id: check-airflow-providers-have-extras @@ -626,7 +626,7 @@ repos: files: ^setup\.py$|^airflow/providers/.*\.py$ pass_filenames: false require_serial: true - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: update-breeze-readme-config-hash name: Update Breeze README.md with config files hash language: python @@ -641,7 +641,7 @@ repos: files: ^dev/breeze/.*$ pass_filenames: false require_serial: true - additional_dependencies: ['click', 'rich>=12.4.1'] + additional_dependencies: ['click', 'rich>=12.4.4'] - id: check-system-tests-present name: Check if system tests have required segments of code entry: ./scripts/ci/pre_commit/pre_commit_check_system_tests.py @@ -649,7 +649,7 @@ repos: files: ^tests/system/.*/example_[^/]*.py$ exclude: ^tests/system/providers/google/bigquery/example_bigquery_queries\.py$ pass_filenames: true - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: lint-markdown name: Run markdownlint description: Checks the style of Markdown files. @@ -740,7 +740,7 @@ repos: language: python pass_filenames: true files: ^\.github/workflows/.*\.yml$ - additional_dependencies: ['PyYAML', 'rich>=12.4.1'] + additional_dependencies: ['PyYAML', 'rich>=12.4.4'] - id: check-docstring-param-types name: Check that docstrings do not specify param types entry: ./scripts/ci/pre_commit/pre_commit_docstring_param_type.py @@ -748,7 +748,7 @@ repos: pass_filenames: true files: \.py$ exclude: ^airflow/_vendor/ - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: lint-chart-schema name: Lint chart/values.schema.json file entry: ./scripts/ci/pre_commit/pre_commit_chart_schema.py @@ -786,7 +786,7 @@ repos: entry: ./scripts/ci/pre_commit/pre_commit_mypy.py files: ^dev/.*\.py$ require_serial: true - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: run-mypy name: Run mypy for core language: python @@ -794,14 +794,14 @@ repos: files: \.py$ exclude: ^provider_packages|^docs|^airflow/_vendor/|^airflow/providers|^airflow/migrations|^dev require_serial: true - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: run-mypy name: Run mypy for providers language: python entry: ./scripts/ci/pre_commit/pre_commit_mypy.py --namespace-packages files: ^airflow/providers/.*\.py$ require_serial: true - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: run-mypy name: Run mypy for /docs/ folder language: python @@ -809,7 +809,7 @@ repos: files: ^docs/.*\.py$ exclude: ^docs/rtd-deprecation require_serial: true - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: run-flake8 name: Run flake8 language: python @@ -817,7 +817,7 @@ repos: files: \.py$ pass_filenames: true exclude: ^airflow/_vendor/ - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: lint-javascript name: ESLint against airflow/ui language: python @@ -825,7 +825,7 @@ repos: files: ^airflow/ui/ entry: ./scripts/ci/pre_commit/pre_commit_ui_lint.py pass_filenames: false - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: lint-javascript name: ESLint against current UI JavaScript files language: python @@ -833,12 +833,12 @@ repos: files: ^airflow/www/static/js/ entry: ./scripts/ci/pre_commit/pre_commit_www_lint.py pass_filenames: false - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] - id: update-migration-references name: Update migration ref doc language: python entry: ./scripts/ci/pre_commit/pre_commit_migration_reference.py pass_filenames: false files: ^airflow/migrations/versions/.*\.py$|^docs/apache-airflow/migrations-ref\.rst$ - additional_dependencies: ['rich>=12.4.1'] + additional_dependencies: ['rich>=12.4.4'] ## ONLY ADD PRE-COMMITS HERE THAT REQUIRE CI IMAGE diff --git a/dev/breeze/README.md b/dev/breeze/README.md index 78d69b43816588..7794f25e4e8eb3 100644 --- a/dev/breeze/README.md +++ b/dev/breeze/README.md @@ -52,6 +52,6 @@ PLEASE DO NOT MODIFY THE HASH BELOW! IT IS AUTOMATICALLY UPDATED BY PRE-COMMIT. --------------------------------------------------------------------------------------------------------- -Package config hash: 480e3d6ae41e7d82216d1d4196b5b44f65e0ff06a6e58f2a5b0c79c70c5912e8e4a42e99429cf3220718491f0ebde35a1a1d2663fd36cbd8d902a4d51f7ebeb1 +Package config hash: 40b9b6908905e94c93809cca70c68c632731242798dba9cbe62473e965cb4e5d44eaaa817c5ce9334397f3794a350bc00e3cf319631a25c461a935a389191e7b --------------------------------------------------------------------------------------------------------- diff --git a/dev/breeze/setup.cfg b/dev/breeze/setup.cfg index 14362ea4925943..9c7154ce52f2af 100644 --- a/dev/breeze/setup.cfg +++ b/dev/breeze/setup.cfg @@ -63,7 +63,7 @@ install_requires = pytest-xdist pyyaml requests - rich>=12.4.1 + rich>=12.4.4 rich_click [options.packages.find] diff --git a/images/breeze/output-build-docs.svg b/images/breeze/output-build-docs.svg index 86d7969351ad50..928f8f898ba5dd 100644 --- a/images/breeze/output-build-docs.svg +++ b/images/breeze/output-build-docs.svg @@ -1,4 +1,4 @@ - + - Command: build-docs - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: build-docs + + + + + - + -                                                                                                                          - Usage: breeze build-docs [OPTIONS]                                                                                      -                                                                                                                         - Build documentation in the container.                                                                                   -                                                                                                                         -╭─ Doc flags ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --docs-only        -d  Only build documentation.                                                                     │ -│ --spellcheck-only  -s  Only run spell checking.                                                                      │ -│ --for-production   -p  Builds documentation for official release i.e. all links point to stable version.             │ -│ --package-filter   -p  List of packages to consider.                                                                 │ -│                        (apache-airflow | apache-airflow-providers | apache-airflow-providers-airbyte |               │ -│                        apache-airflow-providers-alibaba | apache-airflow-providers-amazon |                          │ -│                        apache-airflow-providers-apache-beam | apache-airflow-providers-apache-cassandra |            │ -│                        apache-airflow-providers-apache-drill | apache-airflow-providers-apache-druid |               │ -│                        apache-airflow-providers-apache-hdfs | apache-airflow-providers-apache-hive |                 │ -│                        apache-airflow-providers-apache-kylin | apache-airflow-providers-apache-livy |                │ -│                        apache-airflow-providers-apache-pig | apache-airflow-providers-apache-pinot |                 │ -│                        apache-airflow-providers-apache-spark | apache-airflow-providers-apache-sqoop |               │ -│                        apache-airflow-providers-arangodb | apache-airflow-providers-asana |                          │ -│                        apache-airflow-providers-celery | apache-airflow-providers-cloudant |                         │ -│                        apache-airflow-providers-cncf-kubernetes | apache-airflow-providers-databricks |              │ -│                        apache-airflow-providers-datadog | apache-airflow-providers-dbt-cloud |                       │ -│                        apache-airflow-providers-dingding | apache-airflow-providers-discord |                        │ -│                        apache-airflow-providers-docker | apache-airflow-providers-elasticsearch |                    │ -│                        apache-airflow-providers-exasol | apache-airflow-providers-facebook |                         │ -│                        apache-airflow-providers-ftp | apache-airflow-providers-github |                              │ -│                        apache-airflow-providers-google | apache-airflow-providers-grpc |                             │ -│                        apache-airflow-providers-hashicorp | apache-airflow-providers-http |                          │ -│                        apache-airflow-providers-imap | apache-airflow-providers-influxdb |                           │ -│                        apache-airflow-providers-jdbc | apache-airflow-providers-jenkins |                            │ -│                        apache-airflow-providers-jira | apache-airflow-providers-microsoft-azure |                    │ -│                        apache-airflow-providers-microsoft-mssql | apache-airflow-providers-microsoft-psrp |          │ -│                        apache-airflow-providers-microsoft-winrm | apache-airflow-providers-mongo |                   │ -│                        apache-airflow-providers-mysql | apache-airflow-providers-neo4j |                             │ -│                        apache-airflow-providers-odbc | apache-airflow-providers-openfaas |                           │ -│                        apache-airflow-providers-opsgenie | apache-airflow-providers-oracle |                         │ -│                        apache-airflow-providers-pagerduty | apache-airflow-providers-papermill |                     │ -│                        apache-airflow-providers-plexus | apache-airflow-providers-postgres |                         │ -│                        apache-airflow-providers-presto | apache-airflow-providers-qubole |                           │ -│                        apache-airflow-providers-redis | apache-airflow-providers-salesforce |                        │ -│                        apache-airflow-providers-samba | apache-airflow-providers-segment |                           │ -│                        apache-airflow-providers-sendgrid | apache-airflow-providers-sftp |                           │ -│                        apache-airflow-providers-singularity | apache-airflow-providers-slack |                       │ -│                        apache-airflow-providers-snowflake | apache-airflow-providers-sqlite |                        │ -│                        apache-airflow-providers-ssh | apache-airflow-providers-tableau |                             │ -│                        apache-airflow-providers-telegram | apache-airflow-providers-trino |                          │ -│                        apache-airflow-providers-vertica | apache-airflow-providers-yandex |                          │ -│                        apache-airflow-providers-zendesk | docker-stack | helm-chart)                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze build-docs [OPTIONS] + +Build documentation in the container. + +╭─ Doc flags ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--docs-only-dOnly build documentation.│ +│--spellcheck-only-sOnly run spell checking.│ +│--for-production-pBuilds documentation for official release i.e. all links point to stable version.│ +│--package-filter-pList of packages to consider.                                                                │ +│(apache-airflow | apache-airflow-providers | apache-airflow-providers-airbyte |              │ +│apache-airflow-providers-alibaba | apache-airflow-providers-amazon |                         │ +│apache-airflow-providers-apache-beam | apache-airflow-providers-apache-cassandra |           │ +│apache-airflow-providers-apache-drill | apache-airflow-providers-apache-druid |              │ +│apache-airflow-providers-apache-hdfs | apache-airflow-providers-apache-hive |                │ +│apache-airflow-providers-apache-kylin | apache-airflow-providers-apache-livy |               │ +│apache-airflow-providers-apache-pig | apache-airflow-providers-apache-pinot |                │ +│apache-airflow-providers-apache-spark | apache-airflow-providers-apache-sqoop |              │ +│apache-airflow-providers-arangodb | apache-airflow-providers-asana |                         │ +│apache-airflow-providers-celery | apache-airflow-providers-cloudant |                        │ +│apache-airflow-providers-cncf-kubernetes | apache-airflow-providers-databricks |             │ +│apache-airflow-providers-datadog | apache-airflow-providers-dbt-cloud |                      │ +│apache-airflow-providers-dingding | apache-airflow-providers-discord |                       │ +│apache-airflow-providers-docker | apache-airflow-providers-elasticsearch |                   │ +│apache-airflow-providers-exasol | apache-airflow-providers-facebook |                        │ +│apache-airflow-providers-ftp | apache-airflow-providers-github |                             │ +│apache-airflow-providers-google | apache-airflow-providers-grpc |                            │ +│apache-airflow-providers-hashicorp | apache-airflow-providers-http |                         │ +│apache-airflow-providers-imap | apache-airflow-providers-influxdb |                          │ +│apache-airflow-providers-jdbc | apache-airflow-providers-jenkins |                           │ +│apache-airflow-providers-jira | apache-airflow-providers-microsoft-azure |                   │ +│apache-airflow-providers-microsoft-mssql | apache-airflow-providers-microsoft-psrp |         │ +│apache-airflow-providers-microsoft-winrm | apache-airflow-providers-mongo |                  │ +│apache-airflow-providers-mysql | apache-airflow-providers-neo4j |                            │ +│apache-airflow-providers-odbc | apache-airflow-providers-openfaas |                          │ +│apache-airflow-providers-opsgenie | apache-airflow-providers-oracle |                        │ +│apache-airflow-providers-pagerduty | apache-airflow-providers-papermill |                    │ +│apache-airflow-providers-plexus | apache-airflow-providers-postgres |                        │ +│apache-airflow-providers-presto | apache-airflow-providers-qubole |                          │ +│apache-airflow-providers-redis | apache-airflow-providers-salesforce |                       │ +│apache-airflow-providers-samba | apache-airflow-providers-segment |                          │ +│apache-airflow-providers-sendgrid | apache-airflow-providers-sftp |                          │ +│apache-airflow-providers-singularity | apache-airflow-providers-slack |                      │ +│apache-airflow-providers-snowflake | apache-airflow-providers-sqlite |                       │ +│apache-airflow-providers-ssh | apache-airflow-providers-tableau |                            │ +│apache-airflow-providers-telegram | apache-airflow-providers-trino |                         │ +│apache-airflow-providers-vertica | apache-airflow-providers-yandex |                         │ +│apache-airflow-providers-zendesk | docker-stack | helm-chart)                                │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-build-image.svg b/images/breeze/output-build-image.svg index 371ab8b3b68c04..34c28afd8b91b9 100644 --- a/images/breeze/output-build-image.svg +++ b/images/breeze/output-build-image.svg @@ -1,4 +1,4 @@ - + - Command: build-image - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: build-image + + + + + - + -                                                                                                                          - Usage: breeze build-image [OPTIONS]                                                                                     -                                                                                                                         - Build CI image. Include building multiple images for all python versions (sequentially).                                -                                                                                                                         -╭─ Basic usage ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --python                         -p  Python major/minor version used in Airflow image for images.                    │ -│                                      (>3.7< | 3.8 | 3.9 | 3.10)                                                      │ -│                                      [default: 3.7]                                                                  │ -│ --upgrade-to-newer-dependencies  -u  When set, upgrade all PIP packages to latest.                                   │ -│ --debian-version                     Debian version used for the image. (bullseye | buster) [default: bullseye]      │ -│ --image-tag                      -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)   │ -│ --tag-as-latest                      Tags the image as latest and update checksum of all files after pulling. Useful │ -│                                      when you build or pull image with --image-tag.                                  │ -│ --docker-cache                   -c  Cache option for image used during the build. (registry | local | disabled)     │ -│                                      [default: registry]                                                             │ -│ --force-build                        Force image build no matter if it is determined as needed.                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Building multiple images ───────────────────────────────────────────────────────────────────────────────────────────╮ -│ --build-multiple-images    Run the operation sequentially on all or selected subset of Python versions.              │ -│ --python-versions          Space separated list of python versions used for build with multiple versions. (TEXT)     │ -│                            [default: 3.7 3.8 3.9 3.10]                                                               │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Advanced options (for power users) ─────────────────────────────────────────────────────────────────────────────────╮ -│ --install-providers-from-sources    Install providers from sources when installing.                                  │ -│ --airflow-constraints-mode          Mode of constraints for CI image building                                        │ -│                                     (constraints-source-providers | constraints | constraints-no-providers)          │ -│                                     [default: constraints-source-providers]                                          │ -│ --airflow-constraints-reference     Constraint reference to use when building the image. (TEXT)                      │ -│ --additional-python-deps            Additional python dependencies to use when building the images. (TEXT)           │ -│ --runtime-apt-deps                  Apt runtime dependencies to use when building the images. (TEXT)                 │ -│ --runtime-apt-command               Command executed before runtime apt deps are installed. (TEXT)                   │ -│ --additional-extras                 Additional extra package while installing Airflow in the image. (TEXT)           │ -│ --additional-runtime-apt-deps       Additional apt runtime dependencies to use when building the images. (TEXT)      │ -│ --additional-runtime-apt-env        Additional environment variables set when adding runtime dependencies. (TEXT)    │ -│ --additional-runtime-apt-command    Additional command executed before runtime apt deps are installed. (TEXT)        │ -│ --additional-dev-apt-deps           Additional apt dev dependencies to use when building the images. (TEXT)          │ -│ --additional-dev-apt-env            Additional environment variables set when adding dev dependencies. (TEXT)        │ -│ --additional-dev-apt-command        Additional command executed before dev apt deps are installed. (TEXT)            │ -│ --dev-apt-deps                      Apt dev dependencies to use when building the images. (TEXT)                     │ -│ --dev-apt-command                   Command executed before dev apt deps are installed. (TEXT)                       │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Preparing cache and push (for maintainers and CI) ──────────────────────────────────────────────────────────────────╮ -│ --github-token            The token used to authenticate to GitHub. (TEXT)                                           │ -│ --github-username         The user name used to authenticate to GitHub. (TEXT)                                       │ -│ --platform                Platform for Airflow image. (linux/amd64 | linux/arm64 | linux/amd64,linux/arm64)          │ -│ --push-image              Push image after building it.                                                              │ -│ --empty-image             Prepare empty image tagged with the same name as the Airflow image.                        │ -│ --prepare-buildx-cache    Prepares build cache (this is done as separate per-platform steps instead of building the  │ -│                           image).                                                                                    │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --answer             -a  Force answer to questions. (y | n | q | yes | no | quit)                                    │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze build-image [OPTIONS] + +Build CI image. Include building multiple images for all python versions (sequentially). + +╭─ Basic usage ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.│ +│(>3.7< | 3.8 | 3.9 | 3.10)                                  │ +│[default: 3.7]                                              │ +│--upgrade-to-newer-dependencies-uWhen set, upgrade all PIP packages to latest.│ +│--debian-versionDebian version used for the image.(bullseye | buster)[default: bullseye]│ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +│--tag-as-latestTags the image as latest and update checksum of all files after pulling. Useful│ +│when you build or pull image with --image-tag.                                 │ +│--docker-cache-cCache option for image used during the build.(registry | local | disabled)│ +│[default: registry]                          │ +│--force-buildForce image build no matter if it is determined as needed.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Building multiple images ───────────────────────────────────────────────────────────────────────────────────────────╮ +│--build-multiple-imagesRun the operation sequentially on all or selected subset of Python versions.│ +│--python-versionsSpace separated list of python versions used for build with multiple versions.(TEXT)│ +│[default: 3.7 3.8 3.9 3.10]                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Advanced options (for power users) ─────────────────────────────────────────────────────────────────────────────────╮ +│--install-providers-from-sourcesInstall providers from sources when installing.│ +│--airflow-constraints-modeMode of constraints for CI image building                              │ +│(constraints-source-providers | constraints | constraints-no-providers)│ +│[default: constraints-source-providers]                                │ +│--airflow-constraints-referenceConstraint reference to use when building the image.(TEXT)│ +│--additional-python-depsAdditional python dependencies to use when building the images.(TEXT)│ +│--runtime-apt-depsApt runtime dependencies to use when building the images.(TEXT)│ +│--runtime-apt-commandCommand executed before runtime apt deps are installed.(TEXT)│ +│--additional-extrasAdditional extra package while installing Airflow in the image.(TEXT)│ +│--additional-runtime-apt-depsAdditional apt runtime dependencies to use when building the images.(TEXT)│ +│--additional-runtime-apt-envAdditional environment variables set when adding runtime dependencies.(TEXT)│ +│--additional-runtime-apt-commandAdditional command executed before runtime apt deps are installed.(TEXT)│ +│--additional-dev-apt-depsAdditional apt dev dependencies to use when building the images.(TEXT)│ +│--additional-dev-apt-envAdditional environment variables set when adding dev dependencies.(TEXT)│ +│--additional-dev-apt-commandAdditional command executed before dev apt deps are installed.(TEXT)│ +│--dev-apt-depsApt dev dependencies to use when building the images.(TEXT)│ +│--dev-apt-commandCommand executed before dev apt deps are installed.(TEXT)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Preparing cache and push (for maintainers and CI) ──────────────────────────────────────────────────────────────────╮ +│--github-tokenThe token used to authenticate to GitHub.(TEXT)│ +│--github-usernameThe user name used to authenticate to GitHub.(TEXT)│ +│--platformPlatform for Airflow image.(linux/amd64 | linux/arm64 | linux/amd64,linux/arm64)│ +│--push-imagePush image after building it.│ +│--empty-imagePrepare empty image tagged with the same name as the Airflow image.│ +│--prepare-buildx-cachePrepares build cache (this is done as separate per-platform steps instead of building the │ +│image).                                                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-build-prod-image.svg b/images/breeze/output-build-prod-image.svg index 83cbbd96c3cc97..494e77574c3e00 100644 --- a/images/breeze/output-build-prod-image.svg +++ b/images/breeze/output-build-prod-image.svg @@ -1,4 +1,4 @@ - + - Command: build-prod-image - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: build-prod-image + + + + + - + -                                                                                                                          - Usage: breeze build-prod-image [OPTIONS]                                                                                -                                                                                                                         - Build Production image. Include building multiple images for all or selected Python versions sequentially.              -                                                                                                                         -╭─ Basic usage ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --python                         -p  Python major/minor version used in Airflow image for images.                    │ -│                                      (>3.7< | 3.8 | 3.9 | 3.10)                                                      │ -│                                      [default: 3.7]                                                                  │ -│ --install-airflow-version        -V  Install version of Airflow from PyPI. (TEXT)                                    │ -│ --upgrade-to-newer-dependencies  -u  When set, upgrade all PIP packages to latest.                                   │ -│ --debian-version                     Debian version used for the image. (bullseye | buster) [default: bullseye]      │ -│ --image-tag                      -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)   │ -│ --tag-as-latest                      Tags the image as latest and update checksum of all files after pulling. Useful │ -│                                      when you build or pull image with --image-tag.                                  │ -│ --docker-cache                   -c  Cache option for image used during the build. (registry | local | disabled)     │ -│                                      [default: registry]                                                             │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Building multiple images ───────────────────────────────────────────────────────────────────────────────────────────╮ -│ --build-multiple-images    Run the operation sequentially on all or selected subset of Python versions.              │ -│ --python-versions          Space separated list of python versions used for build with multiple versions. (TEXT)     │ -│                            [default: 3.7 3.8 3.9 3.10]                                                               │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options for customizing images ─────────────────────────────────────────────────────────────────────────────────────╮ -│ --install-providers-from-sources    Install providers from sources when installing.                                  │ -│ --airflow-extras                    Extras to install by default.                                                    │ -│                                     (TEXT)                                                                           │ -│                                     [default:                                                                        │ -│                                     amazon,async,celery,cncf.kubernetes,dask,docker,elasticsearch,ftp,google,google… │ -│ --airflow-constraints-mode          Mode of constraints for PROD image building                                      │ -│                                     (constraints | constraints-no-providers | constraints-source-providers)          │ -│                                     [default: constraints]                                                           │ -│ --airflow-constraints-reference     Constraint reference to use when building the image. (TEXT)                      │ -│ --additional-python-deps            Additional python dependencies to use when building the images. (TEXT)           │ -│ --additional-extras                 Additional extra package while installing Airflow in the image. (TEXT)           │ -│ --additional-runtime-apt-deps       Additional apt runtime dependencies to use when building the images. (TEXT)      │ -│ --additional-runtime-apt-env        Additional environment variables set when adding runtime dependencies. (TEXT)    │ -│ --additional-runtime-apt-command    Additional command executed before runtime apt deps are installed. (TEXT)        │ -│ --additional-dev-apt-deps           Additional apt dev dependencies to use when building the images. (TEXT)          │ -│ --additional-dev-apt-env            Additional environment variables set when adding dev dependencies. (TEXT)        │ -│ --additional-dev-apt-command        Additional command executed before dev apt deps are installed. (TEXT)            │ -│ --runtime-apt-deps                  Apt runtime dependencies to use when building the images. (TEXT)                 │ -│ --runtime-apt-command               Command executed before runtime apt deps are installed. (TEXT)                   │ -│ --dev-apt-deps                      Apt dev dependencies to use when building the images. (TEXT)                     │ -│ --dev-apt-command                   Command executed before dev apt deps are installed. (TEXT)                       │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Customization options (for specific customization needs) ───────────────────────────────────────────────────────────╮ -│ --install-packages-from-context           Install wheels from local docker-context-files when building image.        │ -│ --airflow-is-in-context                   If set Airflow is installed from docker-context-files only rather than     │ -│                                           from PyPI or sources.                                                      │ -│ --cleanup-context                         Clean up docker context files before running build (cannot be used         │ -│                                           together with --install-packages-from-context).                            │ -│ --disable-mysql-client-installation       Do not install MySQL client.                                               │ -│ --disable-mssql-client-installation       Do not install MsSQl client.                                               │ -│ --disable-postgres-client-installation    Do not install Postgres client.                                            │ -│ --disable-airflow-repo-cache              Disable cache from Airflow repository during building.                     │ -│ --install-airflow-reference               Install Airflow using GitHub tag or branch. (TEXT)                         │ -│ --installation-method                     Install Airflow from: sources or PyPI. (. | apache-airflow)                │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Preparing cache and push (for maintainers and CI) ──────────────────────────────────────────────────────────────────╮ -│ --github-token            The token used to authenticate to GitHub. (TEXT)                                           │ -│ --github-username         The user name used to authenticate to GitHub. (TEXT)                                       │ -│ --platform                Platform for Airflow image. (linux/amd64 | linux/arm64 | linux/amd64,linux/arm64)          │ -│ --push-image              Push image after building it.                                                              │ -│ --empty-image             Prepare empty image tagged with the same name as the Airflow image.                        │ -│ --prepare-buildx-cache    Prepares build cache (this is done as separate per-platform steps instead of building the  │ -│                           image).                                                                                    │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --answer             -a  Force answer to questions. (y | n | q | yes | no | quit)                                    │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze build-prod-image [OPTIONS] + +Build Production image. Include building multiple images for all or selected Python versions sequentially. + +╭─ Basic usage ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.│ +│(>3.7< | 3.8 | 3.9 | 3.10)                                  │ +│[default: 3.7]                                              │ +│--install-airflow-version-VInstall version of Airflow from PyPI.(TEXT)│ +│--upgrade-to-newer-dependencies-uWhen set, upgrade all PIP packages to latest.│ +│--debian-versionDebian version used for the image.(bullseye | buster)[default: bullseye]│ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +│--tag-as-latestTags the image as latest and update checksum of all files after pulling. Useful│ +│when you build or pull image with --image-tag.                                 │ +│--docker-cache-cCache option for image used during the build.(registry | local | disabled)│ +│[default: registry]                          │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Building multiple images ───────────────────────────────────────────────────────────────────────────────────────────╮ +│--build-multiple-imagesRun the operation sequentially on all or selected subset of Python versions.│ +│--python-versionsSpace separated list of python versions used for build with multiple versions.(TEXT)│ +│[default: 3.7 3.8 3.9 3.10]                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options for customizing images ─────────────────────────────────────────────────────────────────────────────────────╮ +│--install-providers-from-sourcesInstall providers from sources when installing.│ +│--airflow-extrasExtras to install by default.                                                   │ +│(TEXT)                                                                          │ +│[default:                                                                       │ +│amazon,async,celery,cncf.kubernetes,dask,docker,elasticsearch,ftp,google,google…│ +│--airflow-constraints-modeMode of constraints for PROD image building                            │ +│(constraints | constraints-no-providers | constraints-source-providers)│ +│[default: constraints]                                                 │ +│--airflow-constraints-referenceConstraint reference to use when building the image.(TEXT)│ +│--additional-python-depsAdditional python dependencies to use when building the images.(TEXT)│ +│--additional-extrasAdditional extra package while installing Airflow in the image.(TEXT)│ +│--additional-runtime-apt-depsAdditional apt runtime dependencies to use when building the images.(TEXT)│ +│--additional-runtime-apt-envAdditional environment variables set when adding runtime dependencies.(TEXT)│ +│--additional-runtime-apt-commandAdditional command executed before runtime apt deps are installed.(TEXT)│ +│--additional-dev-apt-depsAdditional apt dev dependencies to use when building the images.(TEXT)│ +│--additional-dev-apt-envAdditional environment variables set when adding dev dependencies.(TEXT)│ +│--additional-dev-apt-commandAdditional command executed before dev apt deps are installed.(TEXT)│ +│--runtime-apt-depsApt runtime dependencies to use when building the images.(TEXT)│ +│--runtime-apt-commandCommand executed before runtime apt deps are installed.(TEXT)│ +│--dev-apt-depsApt dev dependencies to use when building the images.(TEXT)│ +│--dev-apt-commandCommand executed before dev apt deps are installed.(TEXT)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Customization options (for specific customization needs) ───────────────────────────────────────────────────────────╮ +│--install-packages-from-contextInstall wheels from local docker-context-files when building image.│ +│--airflow-is-in-contextIf set Airflow is installed from docker-context-files only rather than    │ +│from PyPI or sources.                                                     │ +│--cleanup-contextClean up docker context files before running build (cannot be used        │ +│together with --install-packages-from-context).                           │ +│--disable-mysql-client-installationDo not install MySQL client.│ +│--disable-mssql-client-installationDo not install MsSQl client.│ +│--disable-postgres-client-installationDo not install Postgres client.│ +│--disable-airflow-repo-cacheDisable cache from Airflow repository during building.│ +│--install-airflow-referenceInstall Airflow using GitHub tag or branch.(TEXT)│ +│--installation-methodInstall Airflow from: sources or PyPI.(. | apache-airflow)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Preparing cache and push (for maintainers and CI) ──────────────────────────────────────────────────────────────────╮ +│--github-tokenThe token used to authenticate to GitHub.(TEXT)│ +│--github-usernameThe user name used to authenticate to GitHub.(TEXT)│ +│--platformPlatform for Airflow image.(linux/amd64 | linux/arm64 | linux/amd64,linux/arm64)│ +│--push-imagePush image after building it.│ +│--empty-imagePrepare empty image tagged with the same name as the Airflow image.│ +│--prepare-buildx-cachePrepares build cache (this is done as separate per-platform steps instead of building the │ +│image).                                                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--verbose-vPrint verbose information about performed steps.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-cleanup.svg b/images/breeze/output-cleanup.svg index b91de5f1a23a18..9bd373b98be836 100644 --- a/images/breeze/output-cleanup.svg +++ b/images/breeze/output-cleanup.svg @@ -1,4 +1,4 @@ - + - Command: cleanup - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: cleanup + + + + + - + -                                                                                                                          - Usage: breeze cleanup [OPTIONS]                                                                                         -                                                                                                                         - Cleans the cache of parameters, docker cache and optionally - currently downloaded images.                              -                                                                                                                         -╭─ Cleanup flags ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --all    Also remove currently downloaded Breeze images.                                                             │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --answer             -a  Force answer to questions. (y | n | q | yes | no | quit)                                    │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze cleanup [OPTIONS] + +Cleans the cache of parameters, docker cache and optionally - currently downloaded images. + +╭─ Cleanup flags ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--allAlso remove currently downloaded Breeze images.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-command-hash-export.svg b/images/breeze/output-command-hash-export.svg index af2725ad9b109d..789317d72494fc 100644 --- a/images/breeze/output-command-hash-export.svg +++ b/images/breeze/output-command-hash-export.svg @@ -1,4 +1,4 @@ - + - Command: command-hash-export - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: command-hash-export + + + + + - + -                                                                                                                          - Usage: breeze command-hash-export [OPTIONS] OUTPUT                                                                      -                                                                                                                         - Outputs hash of all click commands to file or stdout if `-` is used (useful to see if images should be regenerated).    -                                                                                                                         -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze command-hash-export [OPTIONS] OUTPUT + +Outputs hash of all click commands to file or stdout if `-` is used (useful to see if images should be regenerated). + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-commands.svg b/images/breeze/output-commands.svg index 638d76251a653c..be4ea5a514d12c 100644 --- a/images/breeze/output-commands.svg +++ b/images/breeze/output-commands.svg @@ -1,4 +1,4 @@ - + - Breeze commands - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Breeze commands + + + + + - + -                                                                                                                          - Usage: breeze [OPTIONS] COMMAND [ARGS]...                                                                               -                                                                                                                         -╭─ Basic flags for the default (shell) command ────────────────────────────────────────────────────────────────────────╮ -│ --python               -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)   │ -│                            [default: 3.7]                                                                            │ -│ --backend              -b  Database backend to use. (>sqlite< | mysql | postgres | mssql) [default: sqlite]          │ -│ --postgres-version     -P  Version of Postgres used. (>10< | 11 | 12 | 13 | 14) [default: 10]                        │ -│ --mysql-version        -M  Version of MySQL used. (>5.7< | 8) [default: 5.7]                                         │ -│ --mssql-version        -S  Version of MsSQL used. (>2017-latest< | 2019-latest) [default: 2017-latest]               │ -│ --integration              Integration(s) to enable when running (can be more than one).                             │ -│                            (cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino |    │ -│                            all)                                                                                      │ -│ --forward-credentials  -f  Forward local credentials to container when running.                                      │ -│ --db-reset             -d  Reset DB when entering the container.                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Advanced flags for the default (shell) command ─────────────────────────────────────────────────────────────────────╮ -│ --use-airflow-version       Use (reinstall at entry) Airflow version from PyPI. It can also be `none`, `wheel`, or   │ -│                             `sdist` if Airflow should be removed, installed from wheel packages or sdist packages    │ -│                             available in dist folder respectively. Implies --mount-sources `none`.                   │ -│                             (none | wheel | sdist | <airflow_version>)                                               │ -│ --airflow-extras            Airflow extras to install when --use-airflow-version is used (TEXT)                      │ -│ --use-packages-from-dist    Install all found packages (--package-format determines type) from 'dist' folder when    │ -│                             entering breeze.                                                                         │ -│ --package-format            Format of packages that should be installed from dist. (wheel | sdist) [default: wheel]  │ -│ --force-build               Force image build no matter if it is determined as needed.                               │ -│ --mount-sources             Choose scope of local sources should be mounted (default = selected).                    │ -│                             (selected | all | none)                                                                  │ -│                             [default: selected]                                                                      │ -│ --debian-version            Debian version used for the image. (bullseye | buster) [default: bullseye]               │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --answer             -a  Force answer to questions. (y | n | q | yes | no | quit)                                    │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Developer tools ────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ shell            Enter breeze.py environment. this is the default command use when no other is selected.             │ -│ start-airflow    Enter breeze.py environment and starts all Airflow components in the tmux session.                  │ -│ exec             Joins the interactive shell of running airflow container                                            │ -│ stop             Stop running breeze environment.                                                                    │ -│ build-docs       Build documentation in the container.                                                               │ -│ static-checks    Run static checks.                                                                                  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Testing ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ docker-compose-tests   Run docker-compose tests.                                                                     │ -│ tests                  Run the specified unit test targets. Multiple targets may be specified separated by spaces.   │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Configuration & maintenance ────────────────────────────────────────────────────────────────────────────────────────╮ -│ cleanup              Cleans the cache of parameters, docker cache and optionally - currently downloaded images.      │ -│ self-upgrade         Self upgrade Breeze.                                                                            │ -│ setup-autocomplete   Enables autocompletion of breeze commands.                                                      │ -│ config               Show/update configuration (Python, Backend, Cheatsheet, ASCIIART).                              │ -│ resource-check       Check if available docker resources are enough.                                                 │ -│ free-space           Free space for jobs run in CI.                                                                  │ -│ fix-ownership        Fix ownership of source files to be same as host user.                                          │ -│ command-hash-export  Outputs hash of all click commands to file or stdout if `-` is used (useful to see if images    │ -│                      should be regenerated).                                                                         │ -│ version              Print information about version of apache-airflow-breeze.                                       │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ CI Image tools ─────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ build-image     Build CI image. Include building multiple images for all python versions (sequentially).             │ -│ pull-image      Pull and optionally verify CI images - possibly in parallel for all Python versions.                 │ -│ verify-image    Verify CI image.                                                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Production Image tools ─────────────────────────────────────────────────────────────────────────────────────────────╮ -│ build-prod-image   Build Production image. Include building multiple images for all or selected Python versions      │ -│                    sequentially.                                                                                     │ -│ pull-prod-image    Pull and optionally verify Production images - possibly in parallel for all Python versions.      │ -│ verify-prod-image  Verify Production image.                                                                          │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Release management ─────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ verify-provider-packages           Verifies if all provider code is following expectations for providers.            │ -│ prepare-provider-documentation     Prepare CHANGELOG, README and COMMITS information for providers.                  │ -│ prepare-provider-packages          Prepare sdist/whl packages of Airflow Providers.                                  │ -│ prepare-airflow-package            Prepare sdist/whl package of Airflow.                                             │ -│ release-prod-images                Release production images to DockerHub (needs DockerHub permissions).             │ -│ generate-constraints               Generates pinned constraint files with all extras from setup.py in parallel.      │ -│ find-newer-dependencies            Finds which dependencies are being upgraded.                                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze [OPTIONS] COMMAND [ARGS]... + +╭─ Basic flags for the default (shell) command ────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--backend-bDatabase backend to use.(>sqlite< | mysql | postgres | mssql)[default: sqlite]│ +│--postgres-version-PVersion of Postgres used.(>10< | 11 | 12 | 13 | 14)[default: 10]│ +│--mysql-version-MVersion of MySQL used.(>5.7< | 8)[default: 5.7]│ +│--mssql-version-SVersion of MsSQL used.(>2017-latest< | 2019-latest)[default: 2017-latest]│ +│--integrationIntegration(s) to enable when running (can be more than one).                            │ +│(cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino |   │ +│all)                                                                                     │ +│--forward-credentials-fForward local credentials to container when running.│ +│--db-reset-dReset DB when entering the container.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Advanced flags for the default (shell) command ─────────────────────────────────────────────────────────────────────╮ +│--use-airflow-versionUse (reinstall at entry) Airflow version from PyPI. It can also be `none`, `wheel`, or  │ +│`sdist` if Airflow should be removed, installed from wheel packages or sdist packages   │ +│available in dist folder respectively. Implies --mount-sources `none`.                  │ +│(none | wheel | sdist | <airflow_version>)                                              │ +│--airflow-extrasAirflow extras to install when --use-airflow-version is used(TEXT)│ +│--use-packages-from-distInstall all found packages (--package-format determines type) from 'dist' folder when   │ +│entering breeze.                                                                        │ +│--package-formatFormat of packages that should be installed from dist.(wheel | sdist)[default: wheel]│ +│--force-buildForce image build no matter if it is determined as needed.│ +│--mount-sourcesChoose scope of local sources should be mounted (default = selected).│ +│(selected | all | none)                                              │ +│[default: selected]                                                  │ +│--debian-versionDebian version used for the image.(bullseye | buster)[default: bullseye]│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Developer tools ────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│shell          Enter breeze.py environment. this is the default command use when no other is selected.            │ +│start-airflow  Enter breeze.py environment and starts all Airflow components in the tmux session.                 │ +│exec           Joins the interactive shell of running airflow container                                           │ +│stop           Stop running breeze environment.                                                                   │ +│build-docs     Build documentation in the container.                                                              │ +│static-checks  Run static checks.                                                                                 │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Testing ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│docker-compose-tests Run docker-compose tests.                                                                    │ +│tests                Run the specified unit test targets. Multiple targets may be specified separated by spaces.  │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Configuration & maintenance ────────────────────────────────────────────────────────────────────────────────────────╮ +│cleanup            Cleans the cache of parameters, docker cache and optionally - currently downloaded images.     │ +│self-upgrade       Self upgrade Breeze.                                                                           │ +│setup-autocomplete Enables autocompletion of breeze commands.                                                     │ +│config             Show/update configuration (Python, Backend, Cheatsheet, ASCIIART).                             │ +│resource-check     Check if available docker resources are enough.                                                │ +│free-space         Free space for jobs run in CI.                                                                 │ +│fix-ownership      Fix ownership of source files to be same as host user.                                         │ +│command-hash-exportOutputs hash of all click commands to file or stdout if `-` is used (useful to see if images   │ +│should be regenerated).                                                                        │ +│version            Print information about version of apache-airflow-breeze.                                      │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ CI Image tools ─────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│build-image   Build CI image. Include building multiple images for all python versions (sequentially).            │ +│pull-image    Pull and optionally verify CI images - possibly in parallel for all Python versions.                │ +│verify-image  Verify CI image.                                                                                    │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Production Image tools ─────────────────────────────────────────────────────────────────────────────────────────────╮ +│build-prod-image Build Production image. Include building multiple images for all or selected Python versions     │ +│sequentially.                                                                                    │ +│pull-prod-image  Pull and optionally verify Production images - possibly in parallel for all Python versions.     │ +│verify-prod-imageVerify Production image.                                                                         │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Release management ─────────────────────────────────────────────────────────────────────────────────────────────────╮ +│verify-provider-packages         Verifies if all provider code is following expectations for providers.           │ +│prepare-provider-documentation   Prepare CHANGELOG, README and COMMITS information for providers.                 │ +│prepare-provider-packages        Prepare sdist/whl packages of Airflow Providers.                                 │ +│prepare-airflow-package          Prepare sdist/whl package of Airflow.                                            │ +│release-prod-images              Release production images to DockerHub (needs DockerHub permissions).            │ +│generate-constraints             Generates pinned constraint files with all extras from setup.py in parallel.     │ +│find-newer-dependencies          Finds which dependencies are being upgraded.                                     │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-config.svg b/images/breeze/output-config.svg index fbbaa5fcc6b033..b196ab3306b241 100644 --- a/images/breeze/output-config.svg +++ b/images/breeze/output-config.svg @@ -1,4 +1,4 @@ - + - Command: config - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: config + + + + + - + -                                                                                                                          - Usage: breeze config [OPTIONS]                                                                                          -                                                                                                                         - Show/update configuration (Python, Backend, Cheatsheet, ASCIIART).                                                      -                                                                                                                         -╭─ Config flags ───────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --python                      -p     Python major/minor version used in Airflow image for images.                    │ -│                                      (>3.7< | 3.8 | 3.9 | 3.10)                                                      │ -│                                      [default: 3.7]                                                                  │ -│ --backend                     -b     Database backend to use. (>sqlite< | mysql | postgres | mssql)                  │ -│                                      [default: sqlite]                                                               │ -│ --cheatsheet/--no-cheatsheet  -C/-c  Enable/disable cheatsheet.                                                      │ -│ --asciiart/--no-asciiart      -A/-a  Enable/disable ASCIIart.                                                        │ -│ --colour/--no-colour          -B/-b  Enable/disable Colour mode (useful for colour blind-friendly communication).    │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --postgres-version  -P  Version of Postgres used. (>10< | 11 | 12 | 13 | 14) [default: 10]                           │ -│ --mysql-version     -M  Version of MySQL used. (>5.7< | 8) [default: 5.7]                                            │ -│ --mssql-version     -S  Version of MsSQL used. (>2017-latest< | 2019-latest) [default: 2017-latest]                  │ -│ --help              -h  Show this message and exit.                                                                  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze config [OPTIONS] + +Show/update configuration (Python, Backend, Cheatsheet, ASCIIART). + +╭─ Config flags ───────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.│ +│(>3.7< | 3.8 | 3.9 | 3.10)                                  │ +│[default: 3.7]                                              │ +│--backend-bDatabase backend to use.(>sqlite< | mysql | postgres | mssql)│ +│[default: sqlite]       │ +│--cheatsheet/--no-cheatsheet-C/-cEnable/disable cheatsheet.│ +│--asciiart/--no-asciiart-A/-aEnable/disable ASCIIart.│ +│--colour/--no-colour-B/-bEnable/disable Colour mode (useful for colour blind-friendly communication).│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--postgres-version-PVersion of Postgres used.(>10< | 11 | 12 | 13 | 14)[default: 10]│ +│--mysql-version-MVersion of MySQL used.(>5.7< | 8)[default: 5.7]│ +│--mssql-version-SVersion of MsSQL used.(>2017-latest< | 2019-latest)[default: 2017-latest]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-docker-compose-tests.svg b/images/breeze/output-docker-compose-tests.svg index a3007e838b78b6..4830ca12152896 100644 --- a/images/breeze/output-docker-compose-tests.svg +++ b/images/breeze/output-docker-compose-tests.svg @@ -1,4 +1,4 @@ - + - Command: docker-compose-tests - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: docker-compose-tests + + + + + - + -                                                                                                                          - Usage: breeze docker-compose-tests [OPTIONS] [EXTRA_PYTEST_ARGS]...                                                     -                                                                                                                         - Run docker-compose tests.                                                                                               -                                                                                                                         -╭─ Docker-compose tests flag ──────────────────────────────────────────────────────────────────────────────────────────╮ -│ --image-name  -n  Name of the image to verify (overrides --python and --image-tag). (TEXT)                           │ -│ --python      -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)            │ -│                   [default: 3.7]                                                                                     │ -│ --image-tag   -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze docker-compose-tests [OPTIONS] [EXTRA_PYTEST_ARGS]... + +Run docker-compose tests. + +╭─ Docker-compose tests flag ──────────────────────────────────────────────────────────────────────────────────────────╮ +│--image-name-nName of the image to verify (overrides --python and --image-tag).(TEXT)│ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-exec.svg b/images/breeze/output-exec.svg index 42d917747043e0..b8e69cd3addef3 100644 --- a/images/breeze/output-exec.svg +++ b/images/breeze/output-exec.svg @@ -1,4 +1,4 @@ - + - Command: exec - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: exec + + + + + - + -                                                                                                                          - Usage: breeze exec [OPTIONS] [EXEC_ARGS]...                                                                             -                                                                                                                         - Joins the interactive shell of running airflow container                                                                -                                                                                                                         -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze exec [OPTIONS] [EXEC_ARGS]... + +Joins the interactive shell of running airflow container + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-find-newer-dependencies.svg b/images/breeze/output-find-newer-dependencies.svg index 4f250427c6dc13..43fc632ead7ede 100644 --- a/images/breeze/output-find-newer-dependencies.svg +++ b/images/breeze/output-find-newer-dependencies.svg @@ -1,4 +1,4 @@ - + - Command: find-newer-dependencies - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: find-newer-dependencies + + + + + - + -                                                                                                                          - Usage: breeze find-newer-dependencies [OPTIONS]                                                                         -                                                                                                                         - Finds which dependencies are being upgraded.                                                                            -                                                                                                                         -╭─ Find newer dependencies flags ──────────────────────────────────────────────────────────────────────────────────────╮ -│ --python               -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)   │ -│                            [default: 3.7]                                                                            │ -│ --timezone                 Timezone to use during the check (TEXT)                                                   │ -│ --updated-on-or-after      Date when the release was updated after (TEXT)                                            │ -│ --max-age                  Max age of the last release (used if no updated-on-or-after if specified) (INTEGER)       │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --airflow-constraints-reference      Constraint reference to use. Useful with --use-airflow-version parameter to     │ -│                                      specify constraints for the installed version and to find newer dependencies    │ -│                                      (TEXT)                                                                          │ -│ --help                           -h  Show this message and exit.                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze find-newer-dependencies [OPTIONS] + +Finds which dependencies are being upgraded. + +╭─ Find newer dependencies flags ──────────────────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--timezoneTimezone to use during the check(TEXT)│ +│--updated-on-or-afterDate when the release was updated after(TEXT)│ +│--max-ageMax age of the last release (used if no updated-on-or-after if specified)(INTEGER)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--airflow-constraints-referenceConstraint reference to use. Useful with --use-airflow-version parameter to    │ +│specify constraints for the installed version and to find newer dependencies   │ +│(TEXT)                                                                         │ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-fix-ownership.svg b/images/breeze/output-fix-ownership.svg index 2c160e6575f2fc..d8fe2ea84f4401 100644 --- a/images/breeze/output-fix-ownership.svg +++ b/images/breeze/output-fix-ownership.svg @@ -1,4 +1,4 @@ - + - Command: fix-ownership - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: fix-ownership + + + + + - + -                                                                                                                          - Usage: breeze fix-ownership [OPTIONS]                                                                                   -                                                                                                                         - Fix ownership of source files to be same as host user.                                                                  -                                                                                                                         -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze fix-ownership [OPTIONS] + +Fix ownership of source files to be same as host user. + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-free-space.svg b/images/breeze/output-free-space.svg index 3f07573795c251..e0e4296201385e 100644 --- a/images/breeze/output-free-space.svg +++ b/images/breeze/output-free-space.svg @@ -1,4 +1,4 @@ - + - Command: free-space - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: free-space + + + + + - + -                                                                                                                          - Usage: breeze free-space [OPTIONS]                                                                                      -                                                                                                                         - Free space for jobs run in CI.                                                                                          -                                                                                                                         -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --answer   -a  Force answer to questions. (y | n | q | yes | no | quit)                                              │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze free-space [OPTIONS] + +Free space for jobs run in CI. + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-generate-constraints.svg b/images/breeze/output-generate-constraints.svg index 42dd0ddd0b6992..ca049566070eb0 100644 --- a/images/breeze/output-generate-constraints.svg +++ b/images/breeze/output-generate-constraints.svg @@ -1,4 +1,4 @@ - + - Command: generate-constraints - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: generate-constraints + + + + + - + -                                                                                                                          - Usage: breeze generate-constraints [OPTIONS]                                                                            -                                                                                                                         - Generates pinned constraint files with all extras from setup.py in parallel.                                            -                                                                                                                         -╭─ Generate constraints flags ─────────────────────────────────────────────────────────────────────────────────────────╮ -│ --image-tag                 -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)        │ -│ --python                    -p  Python major/minor version used in Airflow image for images.                         │ -│                                 (>3.7< | 3.8 | 3.9 | 3.10)                                                           │ -│                                 [default: 3.7]                                                                       │ -│ --airflow-constraints-mode      Mode of constraints for CI image building                                            │ -│                                 (constraints-source-providers | constraints | constraints-no-providers)              │ -│                                 [default: constraints-source-providers]                                              │ -│ --debug                         Drop user in shell instead of running the command. Useful for debugging.             │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Parallel running ───────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --run-in-parallel    Run the operation in parallel on all or selected subset of Python versions.                     │ -│ --parallelism        Maximum number of processes to use while running the operation in parallel. (INTEGER RANGE)     │ -│                      [default: 4; 1<=x<=8]                                                                           │ -│ --python-versions    Space separated list of python versions used for build with multiple versions. (TEXT)           │ -│                      [default: 3.7 3.8 3.9 3.10]                                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --answer             -a  Force answer to questions. (y | n | q | yes | no | quit)                                    │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze generate-constraints [OPTIONS] + +Generates pinned constraint files with all extras from setup.py in parallel. + +╭─ Generate constraints flags ─────────────────────────────────────────────────────────────────────────────────────────╮ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +│--python-pPython major/minor version used in Airflow image for images.│ +│(>3.7< | 3.8 | 3.9 | 3.10)                                  │ +│[default: 3.7]                                              │ +│--airflow-constraints-modeMode of constraints for CI image building                              │ +│(constraints-source-providers | constraints | constraints-no-providers)│ +│[default: constraints-source-providers]                                │ +│--debugDrop user in shell instead of running the command. Useful for debugging.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Parallel running ───────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--run-in-parallelRun the operation in parallel on all or selected subset of Python versions.│ +│--parallelismMaximum number of processes to use while running the operation in parallel.(INTEGER RANGE)│ +│[default: 4; 1<=x<=8]                                                      │ +│--python-versionsSpace separated list of python versions used for build with multiple versions.(TEXT)│ +│[default: 3.7 3.8 3.9 3.10]                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-prepare-airflow-package.svg b/images/breeze/output-prepare-airflow-package.svg index 91122a0ec2375e..996151f94cc6dc 100644 --- a/images/breeze/output-prepare-airflow-package.svg +++ b/images/breeze/output-prepare-airflow-package.svg @@ -1,4 +1,4 @@ - + - Command: prepare-airflow-package - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: prepare-airflow-package + + + + + - + -                                                                                                                          - Usage: breeze prepare-airflow-package [OPTIONS]                                                                         -                                                                                                                         - Prepare sdist/whl package of Airflow.                                                                                   -                                                                                                                         -╭─ Package flags ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --package-format             Format of packages. (wheel | sdist | both) [default: wheel]                             │ -│ --version-suffix-for-pypi    Version suffix used for PyPI packages (alpha, beta, rc1, etc.). (TEXT)                  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --debug                  Drop user in shell instead of running the command. Useful for debugging.                    │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze prepare-airflow-package [OPTIONS] + +Prepare sdist/whl package of Airflow. + +╭─ Package flags ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--package-formatFormat of packages.(wheel | sdist | both)[default: wheel]│ +│--version-suffix-for-pypiVersion suffix used for PyPI packages (alpha, beta, rc1, etc.).(TEXT)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--debugDrop user in shell instead of running the command. Useful for debugging.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-prepare-provider-documentation.svg b/images/breeze/output-prepare-provider-documentation.svg index 7682e1753735cc..49e1dd54b67814 100644 --- a/images/breeze/output-prepare-provider-documentation.svg +++ b/images/breeze/output-prepare-provider-documentation.svg @@ -1,4 +1,4 @@ - + - Command: prepare-provider-documentation - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: prepare-provider-documentation + + + + + - + -                                                                                                                          - Usage: breeze prepare-provider-documentation [OPTIONS] [airbyte | alibaba | amazon | apache.beam | apache.cassandra |   -                                              apache.drill | apache.druid | apache.hdfs | apache.hive | apache.kylin |   -                                              apache.livy | apache.pig | apache.pinot | apache.spark | apache.sqoop |    -                                              arangodb | asana | celery | cloudant | cncf.kubernetes | databricks |      -                                              datadog | dbt.cloud | dingding | discord | docker | elasticsearch |        -                                              exasol | facebook | ftp | github | google | grpc | hashicorp | http |      -                                              imap | influxdb | jdbc | jenkins | jira | microsoft.azure |                -                                              microsoft.mssql | microsoft.psrp | microsoft.winrm | mongo | mysql |       -                                              neo4j | odbc | openfaas | opsgenie | oracle | pagerduty | papermill |      -                                              plexus | postgres | presto | qubole | redis | salesforce | samba |         -                                              segment | sendgrid | sftp | singularity | slack | snowflake | sqlite |     -                                              ssh | tableau | telegram | trino | vertica | yandex | zendesk]...          -                                                                                                                         - Prepare CHANGELOG, README and COMMITS information for providers.                                                        -                                                                                                                         -╭─ Provider documentation preparation flags ───────────────────────────────────────────────────────────────────────────╮ -│ --debug    Drop user in shell instead of running the command. Useful for debugging.                                  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --answer             -a  Force answer to questions. (y | n | q | yes | no | quit)                                    │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze prepare-provider-documentation [OPTIONS] [airbyte | alibaba | amazon | apache.beam | apache.cassandra | +                                             apache.drill | apache.druid | apache.hdfs | apache.hive | apache.kylin | +                                             apache.livy | apache.pig | apache.pinot | apache.spark | apache.sqoop | +                                             arangodb | asana | celery | cloudant | cncf.kubernetes | databricks | +                                             datadog | dbt.cloud | dingding | discord | docker | elasticsearch | +                                             exasol | facebook | ftp | github | google | grpc | hashicorp | http | +                                             imap | influxdb | jdbc | jenkins | jira | microsoft.azure | +                                             microsoft.mssql | microsoft.psrp | microsoft.winrm | mongo | mysql | +                                             neo4j | odbc | openfaas | opsgenie | oracle | pagerduty | papermill | +                                             plexus | postgres | presto | qubole | redis | salesforce | samba | +                                             segment | sendgrid | sftp | singularity | slack | snowflake | sqlite | +                                             ssh | tableau | telegram | trino | vertica | yandex | zendesk]... + +Prepare CHANGELOG, README and COMMITS information for providers. + +╭─ Provider documentation preparation flags ───────────────────────────────────────────────────────────────────────────╮ +│--debugDrop user in shell instead of running the command. Useful for debugging.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-prepare-provider-packages.svg b/images/breeze/output-prepare-provider-packages.svg index 339185f1092f75..1da53c7d566be3 100644 --- a/images/breeze/output-prepare-provider-packages.svg +++ b/images/breeze/output-prepare-provider-packages.svg @@ -1,4 +1,4 @@ - + - Command: prepare-provider-packages - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: prepare-provider-packages + + + + + - + -                                                                                                                          - Usage: breeze prepare-provider-packages [OPTIONS] [airbyte | alibaba | amazon | apache.beam | apache.cassandra |        -                                         apache.drill | apache.druid | apache.hdfs | apache.hive | apache.kylin |        -                                         apache.livy | apache.pig | apache.pinot | apache.spark | apache.sqoop |         -                                         arangodb | asana | celery | cloudant | cncf.kubernetes | databricks | datadog   -                                         | dbt.cloud | dingding | discord | docker | elasticsearch | exasol | facebook   -                                         | ftp | github | google | grpc | hashicorp | http | imap | influxdb | jdbc |    -                                         jenkins | jira | microsoft.azure | microsoft.mssql | microsoft.psrp |           -                                         microsoft.winrm | mongo | mysql | neo4j | odbc | openfaas | opsgenie | oracle   -                                         | pagerduty | papermill | plexus | postgres | presto | qubole | redis |         -                                         salesforce | samba | segment | sendgrid | sftp | singularity | slack |          -                                         snowflake | sqlite | ssh | tableau | telegram | trino | vertica | yandex |      -                                         zendesk]...                                                                     -                                                                                                                         - Prepare sdist/whl packages of Airflow Providers.                                                                        -                                                                                                                         -╭─ Package flags ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --package-format             Format of packages. (wheel | sdist | both) [default: wheel]                             │ -│ --version-suffix-for-pypi    Version suffix used for PyPI packages (alpha, beta, rc1, etc.). (TEXT)                  │ -│ --package-list-file          Read list of packages from text file (one package per line) (FILENAME)                  │ -│ --debug                      Drop user in shell instead of running the command. Useful for debugging.                │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze prepare-provider-packages [OPTIONS] [airbyte | alibaba | amazon | apache.beam | apache.cassandra | +                                        apache.drill | apache.druid | apache.hdfs | apache.hive | apache.kylin | +                                        apache.livy | apache.pig | apache.pinot | apache.spark | apache.sqoop | +                                        arangodb | asana | celery | cloudant | cncf.kubernetes | databricks | datadog +                                        | dbt.cloud | dingding | discord | docker | elasticsearch | exasol | facebook +                                        | ftp | github | google | grpc | hashicorp | http | imap | influxdb | jdbc | +                                        jenkins | jira | microsoft.azure | microsoft.mssql | microsoft.psrp | +                                        microsoft.winrm | mongo | mysql | neo4j | odbc | openfaas | opsgenie | oracle +                                        | pagerduty | papermill | plexus | postgres | presto | qubole | redis | +                                        salesforce | samba | segment | sendgrid | sftp | singularity | slack | +                                        snowflake | sqlite | ssh | tableau | telegram | trino | vertica | yandex | +                                        zendesk]... + +Prepare sdist/whl packages of Airflow Providers. + +╭─ Package flags ──────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--package-formatFormat of packages.(wheel | sdist | both)[default: wheel]│ +│--version-suffix-for-pypiVersion suffix used for PyPI packages (alpha, beta, rc1, etc.).(TEXT)│ +│--package-list-fileRead list of packages from text file (one package per line)(FILENAME)│ +│--debugDrop user in shell instead of running the command. Useful for debugging.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-pull-image.svg b/images/breeze/output-pull-image.svg index d713be1d5aa9a8..e1cce7beebc1c7 100644 --- a/images/breeze/output-pull-image.svg +++ b/images/breeze/output-pull-image.svg @@ -1,4 +1,4 @@ - + - Command: pull-image - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: pull-image + + + + + - + -                                                                                                                          - Usage: breeze pull-image [OPTIONS] [EXTRA_PYTEST_ARGS]...                                                               -                                                                                                                         - Pull and optionally verify CI images - possibly in parallel for all Python versions.                                    -                                                                                                                         -╭─ Pull image flags ───────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --image-tag       -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)                  │ -│ --python          -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)        │ -│                       [default: 3.7]                                                                                 │ -│ --github-token        The token used to authenticate to GitHub. (TEXT)                                               │ -│ --verify-image        Verify image.                                                                                  │ -│ --wait-for-image      Wait until image is available.                                                                 │ -│ --tag-as-latest       Tags the image as latest and update checksum of all files after pulling. Useful when you build │ -│                       or pull image with --image-tag.                                                                │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Parallel running ───────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --run-in-parallel    Run the operation in parallel on all or selected subset of Python versions.                     │ -│ --parallelism        Maximum number of processes to use while running the operation in parallel. (INTEGER RANGE)     │ -│                      [default: 4; 1<=x<=8]                                                                           │ -│ --python-versions    Space separated list of python versions used for build with multiple versions. (TEXT)           │ -│                      [default: 3.7 3.8 3.9 3.10]                                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze pull-image [OPTIONS] [EXTRA_PYTEST_ARGS]... + +Pull and optionally verify CI images - possibly in parallel for all Python versions. + +╭─ Pull image flags ───────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--github-tokenThe token used to authenticate to GitHub.(TEXT)│ +│--verify-imageVerify image.│ +│--wait-for-imageWait until image is available.│ +│--tag-as-latestTags the image as latest and update checksum of all files after pulling. Useful when you build│ +│or pull image with --image-tag.                                                               │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Parallel running ───────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--run-in-parallelRun the operation in parallel on all or selected subset of Python versions.│ +│--parallelismMaximum number of processes to use while running the operation in parallel.(INTEGER RANGE)│ +│[default: 4; 1<=x<=8]                                                      │ +│--python-versionsSpace separated list of python versions used for build with multiple versions.(TEXT)│ +│[default: 3.7 3.8 3.9 3.10]                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-pull-prod-image.svg b/images/breeze/output-pull-prod-image.svg index 01a30c28721ff0..d6ee293d03b8a8 100644 --- a/images/breeze/output-pull-prod-image.svg +++ b/images/breeze/output-pull-prod-image.svg @@ -1,4 +1,4 @@ - + - Command: pull-prod-image - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: pull-prod-image + + + + + - + -                                                                                                                          - Usage: breeze pull-prod-image [OPTIONS] [EXTRA_PYTEST_ARGS]...                                                          -                                                                                                                         - Pull and optionally verify Production images - possibly in parallel for all Python versions.                            -                                                                                                                         -╭─ Pull image flags ───────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --image-tag       -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)                  │ -│ --python          -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)        │ -│                       [default: 3.7]                                                                                 │ -│ --github-token        The token used to authenticate to GitHub. (TEXT)                                               │ -│ --verify-image        Verify image.                                                                                  │ -│ --wait-for-image      Wait until image is available.                                                                 │ -│ --tag-as-latest       Tags the image as latest and update checksum of all files after pulling. Useful when you build │ -│                       or pull image with --image-tag.                                                                │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Parallel running ───────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --run-in-parallel    Run the operation in parallel on all or selected subset of Python versions.                     │ -│ --parallelism        Maximum number of processes to use while running the operation in parallel. (INTEGER RANGE)     │ -│                      [default: 4; 1<=x<=8]                                                                           │ -│ --python-versions    Space separated list of python versions used for build with multiple versions. (TEXT)           │ -│                      [default: 3.7 3.8 3.9 3.10]                                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze pull-prod-image [OPTIONS] [EXTRA_PYTEST_ARGS]... + +Pull and optionally verify Production images - possibly in parallel for all Python versions. + +╭─ Pull image flags ───────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--github-tokenThe token used to authenticate to GitHub.(TEXT)│ +│--verify-imageVerify image.│ +│--wait-for-imageWait until image is available.│ +│--tag-as-latestTags the image as latest and update checksum of all files after pulling. Useful when you build│ +│or pull image with --image-tag.                                                               │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Parallel running ───────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--run-in-parallelRun the operation in parallel on all or selected subset of Python versions.│ +│--parallelismMaximum number of processes to use while running the operation in parallel.(INTEGER RANGE)│ +│[default: 4; 1<=x<=8]                                                      │ +│--python-versionsSpace separated list of python versions used for build with multiple versions.(TEXT)│ +│[default: 3.7 3.8 3.9 3.10]                                                   │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-release-prod-images.svg b/images/breeze/output-release-prod-images.svg index 79d78779f454bc..a3a392acc5583e 100644 --- a/images/breeze/output-release-prod-images.svg +++ b/images/breeze/output-release-prod-images.svg @@ -1,4 +1,4 @@ - + - Command: release-prod-images - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: release-prod-images + + + + + - + -                                                                                                                          - Usage: breeze release-prod-images [OPTIONS]                                                                             -                                                                                                                         - Release production images to DockerHub (needs DockerHub permissions).                                                   -                                                                                                                         -╭─ Release PROD IMAGE flags ───────────────────────────────────────────────────────────────────────────────────────────╮ -│ *  --airflow-version    Airflow version to release (2.3.0, 2.3.0rc1 etc.) (TEXT) [required]                          │ -│    --dockerhub-repo     DockerHub repository for the images (TEXT) [default: apache/airflow]                         │ -│    --slim-images        Whether to prepare slim images instead of the regular ones.                                  │ -│    --limit-python       Specific python to build slim images for (if not specified - the images are built for all    │ -│                         available python versions)                                                                   │ -│                         (3.7 | 3.8 | 3.9 | 3.10)                                                                     │ -│    --limit-platform     Specific platform to build images for (if not specified, multiplatform images will be built. │ -│                         (linux/amd64 | linux/arm64 | linux/amd64,linux/arm64)                                        │ -│                         [default: linux/amd64,linux/arm64]                                                           │ -│    --skip-latest        Whether to skip publishing the latest images (so that 'latest' images are not updated). This │ -│                         should only be used if you release image for previous branches. Automatically set when       │ -│                         rc/alpha/beta images are built.                                                              │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze release-prod-images [OPTIONS] + +Release production images to DockerHub (needs DockerHub permissions). + +╭─ Release PROD IMAGE flags ───────────────────────────────────────────────────────────────────────────────────────────╮ +│*--airflow-versionAirflow version to release (2.3.0, 2.3.0rc1 etc.)(TEXT)[required]│ +│--dockerhub-repoDockerHub repository for the images(TEXT)[default: apache/airflow]│ +│--slim-imagesWhether to prepare slim images instead of the regular ones.│ +│--limit-pythonSpecific python to build slim images for (if not specified - the images are built for all   │ +│available python versions)                                                                  │ +│(3.7 | 3.8 | 3.9 | 3.10)                                                                    │ +│--limit-platformSpecific platform to build images for (if not specified, multiplatform images will be built.│ +│(linux/amd64 | linux/arm64 | linux/amd64,linux/arm64)                                       │ +│[default: linux/amd64,linux/arm64]                                                          │ +│--skip-latestWhether to skip publishing the latest images (so that 'latest' images are not updated). This│ +│should only be used if you release image for previous branches. Automatically set when      │ +│rc/alpha/beta images are built.                                                             │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-resource-check.svg b/images/breeze/output-resource-check.svg index e10fd1169b8792..8ec8aa32d7e7c2 100644 --- a/images/breeze/output-resource-check.svg +++ b/images/breeze/output-resource-check.svg @@ -1,4 +1,4 @@ - + - Command: resource-check - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: resource-check + + + + + - + -                                                                                                                          - Usage: breeze resource-check [OPTIONS]                                                                                  -                                                                                                                         - Check if available docker resources are enough.                                                                         -                                                                                                                         -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze resource-check [OPTIONS] + +Check if available docker resources are enough. + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-self-upgrade.svg b/images/breeze/output-self-upgrade.svg index 7fd44e00f72168..205b6f1042e641 100644 --- a/images/breeze/output-self-upgrade.svg +++ b/images/breeze/output-self-upgrade.svg @@ -1,4 +1,4 @@ - + - Command: self-upgrade - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: self-upgrade + + + + + - + -                                                                                                                          - Usage: breeze self-upgrade [OPTIONS]                                                                                    -                                                                                                                         - Self upgrade Breeze.                                                                                                    -                                                                                                                         -╭─ Self-upgrade flags ─────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --use-current-airflow-sources  -a  Use current workdir Airflow sources for upgrade.                                  │ -│ --force                        -f  Force upgrade without asking question to the user.                                │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --help  -h  Show this message and exit.                                                                              │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze self-upgrade [OPTIONS] + +Self upgrade Breeze. + +╭─ Self-upgrade flags ─────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--use-current-airflow-sources-aUse current workdir Airflow sources for upgrade.│ +│--force-fForce upgrade without asking question to the user.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-setup-autocomplete.svg b/images/breeze/output-setup-autocomplete.svg index 4caa5a2793f8b4..de7c17ab43ee5e 100644 --- a/images/breeze/output-setup-autocomplete.svg +++ b/images/breeze/output-setup-autocomplete.svg @@ -1,4 +1,4 @@ - + - Command: setup-autocomplete - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: setup-autocomplete + + + + + - + -                                                                                                                          - Usage: breeze setup-autocomplete [OPTIONS]                                                                              -                                                                                                                         - Enables autocompletion of breeze commands.                                                                              -                                                                                                                         -╭─ Setup autocomplete flags ───────────────────────────────────────────────────────────────────────────────────────────╮ -│ --force  -f  Force autocomplete setup even if already setup before (overrides the setup).                            │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --answer   -a  Force answer to questions. (y | n | q | yes | no | quit)                                              │ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze setup-autocomplete [OPTIONS] + +Enables autocompletion of breeze commands. + +╭─ Setup autocomplete flags ───────────────────────────────────────────────────────────────────────────────────────────╮ +│--force-fForce autocomplete setup even if already setup before (overrides the setup).│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--verbose-vPrint verbose information about performed steps.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-shell.svg b/images/breeze/output-shell.svg index c4bce85bda61ea..f279eab2d729ef 100644 --- a/images/breeze/output-shell.svg +++ b/images/breeze/output-shell.svg @@ -1,4 +1,4 @@ - + - Command: shell - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: shell + + + + + - + -                                                                                                                          - Usage: breeze shell [OPTIONS] [EXTRA_ARGS]...                                                                           -                                                                                                                         - Enter breeze.py environment. this is the default command use when no other is selected.                                 -                                                                                                                         -╭─ Basic flags ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --python               -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)   │ -│                            [default: 3.7]                                                                            │ -│ --backend              -b  Database backend to use. (>sqlite< | mysql | postgres | mssql) [default: sqlite]          │ -│ --postgres-version     -P  Version of Postgres used. (>10< | 11 | 12 | 13 | 14) [default: 10]                        │ -│ --mysql-version        -M  Version of MySQL used. (>5.7< | 8) [default: 5.7]                                         │ -│ --mssql-version        -S  Version of MsSQL used. (>2017-latest< | 2019-latest) [default: 2017-latest]               │ -│ --integration              Integration(s) to enable when running (can be more than one).                             │ -│                            (cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino |    │ -│                            all)                                                                                      │ -│ --forward-credentials  -f  Forward local credentials to container when running.                                      │ -│ --db-reset             -d  Reset DB when entering the container.                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Advanced flag for running ──────────────────────────────────────────────────────────────────────────────────────────╮ -│ --use-airflow-version       Use (reinstall at entry) Airflow version from PyPI. It can also be `none`, `wheel`, or   │ -│                             `sdist` if Airflow should be removed, installed from wheel packages or sdist packages    │ -│                             available in dist folder respectively. Implies --mount-sources `none`.                   │ -│                             (none | wheel | sdist | <airflow_version>)                                               │ -│ --airflow-extras            Airflow extras to install when --use-airflow-version is used (TEXT)                      │ -│ --use-packages-from-dist    Install all found packages (--package-format determines type) from 'dist' folder when    │ -│                             entering breeze.                                                                         │ -│ --package-format            Format of packages that should be installed from dist. (wheel | sdist) [default: wheel]  │ -│ --force-build               Force image build no matter if it is determined as needed.                               │ -│ --mount-sources             Choose scope of local sources should be mounted (default = selected).                    │ -│                             (selected | all | none)                                                                  │ -│                             [default: selected]                                                                      │ -│ --debian-version            Debian version used for the image. (bullseye | buster) [default: bullseye]               │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose                        -v  Print verbose information about performed steps.                                │ -│ --dry-run                        -D  If dry-run is set, commands are only printed, not executed.                     │ -│ --github-repository              -g  GitHub repository used to pull, push run images. (TEXT)                         │ -│                                      [default: apache/airflow]                                                       │ -│ --airflow-constraints-reference      Constraint reference to use. Useful with --use-airflow-version parameter to     │ -│                                      specify constraints for the installed version and to find newer dependencies    │ -│                                      (TEXT)                                                                          │ -│ --answer                         -a  Force answer to questions. (y | n | q | yes | no | quit)                        │ -│ --help                           -h  Show this message and exit.                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze shell [OPTIONS] [EXTRA_ARGS]... + +Enter breeze.py environment. this is the default command use when no other is selected. + +╭─ Basic flags ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--backend-bDatabase backend to use.(>sqlite< | mysql | postgres | mssql)[default: sqlite]│ +│--postgres-version-PVersion of Postgres used.(>10< | 11 | 12 | 13 | 14)[default: 10]│ +│--mysql-version-MVersion of MySQL used.(>5.7< | 8)[default: 5.7]│ +│--mssql-version-SVersion of MsSQL used.(>2017-latest< | 2019-latest)[default: 2017-latest]│ +│--integrationIntegration(s) to enable when running (can be more than one).                            │ +│(cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino |   │ +│all)                                                                                     │ +│--forward-credentials-fForward local credentials to container when running.│ +│--db-reset-dReset DB when entering the container.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Advanced flag for running ──────────────────────────────────────────────────────────────────────────────────────────╮ +│--use-airflow-versionUse (reinstall at entry) Airflow version from PyPI. It can also be `none`, `wheel`, or  │ +│`sdist` if Airflow should be removed, installed from wheel packages or sdist packages   │ +│available in dist folder respectively. Implies --mount-sources `none`.                  │ +│(none | wheel | sdist | <airflow_version>)                                              │ +│--airflow-extrasAirflow extras to install when --use-airflow-version is used(TEXT)│ +│--use-packages-from-distInstall all found packages (--package-format determines type) from 'dist' folder when   │ +│entering breeze.                                                                        │ +│--package-formatFormat of packages that should be installed from dist.(wheel | sdist)[default: wheel]│ +│--force-buildForce image build no matter if it is determined as needed.│ +│--mount-sourcesChoose scope of local sources should be mounted (default = selected).│ +│(selected | all | none)                                              │ +│[default: selected]                                                  │ +│--debian-versionDebian version used for the image.(bullseye | buster)[default: bullseye]│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)│ +│[default: apache/airflow]                       │ +│--airflow-constraints-referenceConstraint reference to use. Useful with --use-airflow-version parameter to    │ +│specify constraints for the installed version and to find newer dependencies   │ +│(TEXT)                                                                         │ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-start-airflow.svg b/images/breeze/output-start-airflow.svg index 8487e5ebebc4f1..159eec8cb29a03 100644 --- a/images/breeze/output-start-airflow.svg +++ b/images/breeze/output-start-airflow.svg @@ -1,4 +1,4 @@ - + - Command: start-airflow - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: start-airflow + + + + + - + -                                                                                                                          - Usage: breeze start-airflow [OPTIONS] [EXTRA_ARGS]...                                                                   -                                                                                                                         - Enter breeze.py environment and starts all Airflow components in the tmux session.                                      -                                                                                                                         -╭─ Basic flags ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --python                    -p  Python major/minor version used in Airflow image for images.                         │ -│                                 (>3.7< | 3.8 | 3.9 | 3.10)                                                           │ -│                                 [default: 3.7]                                                                       │ -│ --load-example-dags         -e  Enable configuration to load example DAGs when starting Airflow.                     │ -│ --load-default-connections  -c  Enable configuration to load default connections when starting Airflow.              │ -│ --backend                   -b  Database backend to use. (>sqlite< | mysql | postgres | mssql) [default: sqlite]     │ -│ --postgres-version          -P  Version of Postgres used. (>10< | 11 | 12 | 13 | 14) [default: 10]                   │ -│ --mysql-version             -M  Version of MySQL used. (>5.7< | 8) [default: 5.7]                                    │ -│ --mssql-version             -S  Version of MsSQL used. (>2017-latest< | 2019-latest) [default: 2017-latest]          │ -│ --integration                   Integration(s) to enable when running (can be more than one).                        │ -│                                 (cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino │ -│                                 | all)                                                                               │ -│ --forward-credentials       -f  Forward local credentials to container when running.                                 │ -│ --db-reset                  -d  Reset DB when entering the container.                                                │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Advanced flag for running ──────────────────────────────────────────────────────────────────────────────────────────╮ -│ --use-airflow-version       Use (reinstall at entry) Airflow version from PyPI. It can also be `none`, `wheel`, or   │ -│                             `sdist` if Airflow should be removed, installed from wheel packages or sdist packages    │ -│                             available in dist folder respectively. Implies --mount-sources `none`.                   │ -│                             (none | wheel | sdist | <airflow_version>)                                               │ -│ --airflow-extras            Airflow extras to install when --use-airflow-version is used (TEXT)                      │ -│ --use-packages-from-dist    Install all found packages (--package-format determines type) from 'dist' folder when    │ -│                             entering breeze.                                                                         │ -│ --package-format            Format of packages that should be installed from dist. (wheel | sdist) [default: wheel]  │ -│ --force-build               Force image build no matter if it is determined as needed.                               │ -│ --mount-sources             Choose scope of local sources should be mounted (default = selected).                    │ -│                             (selected | all | none)                                                                  │ -│                             [default: selected]                                                                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --dry-run                        -D  If dry-run is set, commands are only printed, not executed.                     │ -│ --github-repository              -g  GitHub repository used to pull, push run images. (TEXT)                         │ -│                                      [default: apache/airflow]                                                       │ -│ --airflow-constraints-reference      Constraint reference to use. Useful with --use-airflow-version parameter to     │ -│                                      specify constraints for the installed version and to find newer dependencies    │ -│                                      (TEXT)                                                                          │ -│ --answer                         -a  Force answer to questions. (y | n | q | yes | no | quit)                        │ -│ --verbose                        -v  Print verbose information about performed steps.                                │ -│ --help                           -h  Show this message and exit.                                                     │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze start-airflow [OPTIONS] [EXTRA_ARGS]... + +Enter breeze.py environment and starts all Airflow components in the tmux session. + +╭─ Basic flags ────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--python-pPython major/minor version used in Airflow image for images.│ +│(>3.7< | 3.8 | 3.9 | 3.10)                                  │ +│[default: 3.7]                                              │ +│--load-example-dags-eEnable configuration to load example DAGs when starting Airflow.│ +│--load-default-connections-cEnable configuration to load default connections when starting Airflow.│ +│--backend-bDatabase backend to use.(>sqlite< | mysql | postgres | mssql)[default: sqlite]│ +│--postgres-version-PVersion of Postgres used.(>10< | 11 | 12 | 13 | 14)[default: 10]│ +│--mysql-version-MVersion of MySQL used.(>5.7< | 8)[default: 5.7]│ +│--mssql-version-SVersion of MsSQL used.(>2017-latest< | 2019-latest)[default: 2017-latest]│ +│--integrationIntegration(s) to enable when running (can be more than one).                       │ +│(cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino│ +│| all)                                                                              │ +│--forward-credentials-fForward local credentials to container when running.│ +│--db-reset-dReset DB when entering the container.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Advanced flag for running ──────────────────────────────────────────────────────────────────────────────────────────╮ +│--use-airflow-versionUse (reinstall at entry) Airflow version from PyPI. It can also be `none`, `wheel`, or  │ +│`sdist` if Airflow should be removed, installed from wheel packages or sdist packages   │ +│available in dist folder respectively. Implies --mount-sources `none`.                  │ +│(none | wheel | sdist | <airflow_version>)                                              │ +│--airflow-extrasAirflow extras to install when --use-airflow-version is used(TEXT)│ +│--use-packages-from-distInstall all found packages (--package-format determines type) from 'dist' folder when   │ +│entering breeze.                                                                        │ +│--package-formatFormat of packages that should be installed from dist.(wheel | sdist)[default: wheel]│ +│--force-buildForce image build no matter if it is determined as needed.│ +│--mount-sourcesChoose scope of local sources should be mounted (default = selected).│ +│(selected | all | none)                                              │ +│[default: selected]                                                  │ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)│ +│[default: apache/airflow]                       │ +│--airflow-constraints-referenceConstraint reference to use. Useful with --use-airflow-version parameter to    │ +│specify constraints for the installed version and to find newer dependencies   │ +│(TEXT)                                                                         │ +│--answer-aForce answer to questions.(y | n | q | yes | no | quit)│ +│--verbose-vPrint verbose information about performed steps.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-static-checks.svg b/images/breeze/output-static-checks.svg index 73ad94e12df2d8..3563ed61278b7f 100644 --- a/images/breeze/output-static-checks.svg +++ b/images/breeze/output-static-checks.svg @@ -1,4 +1,4 @@ - + - Command: static-checks - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: static-checks + + + + + - + -                                                                                                                          - Usage: breeze static-checks [OPTIONS] [PRECOMMIT_ARGS]...                                                               -                                                                                                                         - Run static checks.                                                                                                      -                                                                                                                         -╭─ Pre-commit flags ───────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --type                  -t  Type(s) of the static checks to run (multiple can be added).                             │ -│                             (all | black | blacken-docs | check-airflow-2-1-compatibility |                          │ -│                             check-airflow-config-yaml-consistent | check-airflow-providers-have-extras |             │ -│                             check-apache-license-rat | check-base-operator-partial-arguments |                       │ -│                             check-base-operator-usage | check-boring-cyborg-configuration |                          │ -│                             check-breeze-top-dependencies-limited | check-builtin-literals |                         │ -│                             check-changelog-has-no-duplicates | check-daysago-import-from-utils |                    │ -│                             check-docstring-param-types | check-executables-have-shebangs |                          │ -│                             check-extra-packages-references | check-extras-order | check-for-inclusive-language |    │ -│                             check-hooks-apply | check-incorrect-use-of-LoggingMixin |                                │ -│                             check-integrations-are-consistent | check-merge-conflict | check-newsfragments-are-valid │ -│                             | check-no-providers-in-core-examples | check-no-relative-imports |                      │ -│                             check-persist-credentials-disabled-in-github-workflows |                                 │ -│                             check-pre-commit-information-consistent | check-provide-create-sessions-imports |        │ -│                             check-provider-yaml-valid | check-providers-init-file-missing |                          │ -│                             check-providers-subpackages-init-file-exist | check-pydevd-left-in-code |                │ -│                             check-revision-heads-map | check-safe-filter-usage-in-html | check-setup-order |         │ -│                             check-start-date-not-used-in-defaults | check-system-tests-present | check-xml |         │ -│                             codespell | debug-statements | detect-private-key | doctoc | end-of-file-fixer |         │ -│                             fix-encoding-pragma | flynt | forbid-tabs | identity | insert-license | isort |          │ -│                             lint-chart-schema | lint-css | lint-dockerfile | lint-helm-chart | lint-javascript |     │ -│                             lint-json-schema | lint-markdown | lint-openapi | mixed-line-ending | pretty-format-json │ -│                             | pydocstyle | python-no-log-warn | pyupgrade | rst-backticks | run-flake8 | run-mypy |  │ -│                             run-shellcheck | static-check-autoflake | trailing-whitespace | update-breeze-file |     │ -│                             update-breeze-readme-config-hash | update-extras | update-in-the-wild-to-be-sorted |     │ -│                             update-inlined-dockerfile-scripts | update-local-yml-file | update-migration-references  │ -│                             | update-providers-dependencies | update-setup-cfg-file |                                │ -│                             update-spelling-wordlist-to-be-sorted | update-supported-versions |                      │ -│                             update-vendored-in-k8s-json-schema | update-version | yamllint | yesqa)                  │ -│ --file                  -f  List of files to run the checks on. (PATH)                                               │ -│ --all-files             -a  Run checks on all files.                                                                 │ -│ --show-diff-on-failure  -s  Show diff for files modified by the checks.                                              │ -│ --last-commit           -c  Run checks for all files in last commit. Mutually exclusive with --commit-ref.           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --commit-ref         -r  Run checks for this commit reference only (can be any git commit-ish reference). Mutually   │ -│                          exclusive with --last-commit.                                                               │ -│                          (TEXT)                                                                                      │ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze static-checks [OPTIONS] [PRECOMMIT_ARGS]... + +Run static checks. + +╭─ Pre-commit flags ───────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--type-tType(s) of the static checks to run (multiple can be added).                            │ +│(all | black | blacken-docs | check-airflow-2-1-compatibility |                         │ +│check-airflow-config-yaml-consistent | check-airflow-providers-have-extras |            │ +│check-apache-license-rat | check-base-operator-partial-arguments |                      │ +│check-base-operator-usage | check-boring-cyborg-configuration |                         │ +│check-breeze-top-dependencies-limited | check-builtin-literals |                        │ +│check-changelog-has-no-duplicates | check-daysago-import-from-utils |                   │ +│check-docstring-param-types | check-executables-have-shebangs |                         │ +│check-extra-packages-references | check-extras-order | check-for-inclusive-language |   │ +│check-hooks-apply | check-incorrect-use-of-LoggingMixin |                               │ +│check-integrations-are-consistent | check-merge-conflict | check-newsfragments-are-valid│ +│| check-no-providers-in-core-examples | check-no-relative-imports |                     │ +│check-persist-credentials-disabled-in-github-workflows |                                │ +│check-pre-commit-information-consistent | check-provide-create-sessions-imports |       │ +│check-provider-yaml-valid | check-providers-init-file-missing |                         │ +│check-providers-subpackages-init-file-exist | check-pydevd-left-in-code |               │ +│check-revision-heads-map | check-safe-filter-usage-in-html | check-setup-order |        │ +│check-start-date-not-used-in-defaults | check-system-tests-present | check-xml |        │ +│codespell | debug-statements | detect-private-key | doctoc | end-of-file-fixer |        │ +│fix-encoding-pragma | flynt | forbid-tabs | identity | insert-license | isort |         │ +│lint-chart-schema | lint-css | lint-dockerfile | lint-helm-chart | lint-javascript |    │ +│lint-json-schema | lint-markdown | lint-openapi | mixed-line-ending | pretty-format-json│ +│| pydocstyle | python-no-log-warn | pyupgrade | rst-backticks | run-flake8 | run-mypy | │ +│run-shellcheck | static-check-autoflake | trailing-whitespace | update-breeze-file |    │ +│update-breeze-readme-config-hash | update-extras | update-in-the-wild-to-be-sorted |    │ +│update-inlined-dockerfile-scripts | update-local-yml-file | update-migration-references │ +│| update-providers-dependencies | update-setup-cfg-file |                               │ +│update-spelling-wordlist-to-be-sorted | update-supported-versions |                     │ +│update-vendored-in-k8s-json-schema | update-version | yamllint | yesqa)                 │ +│--file-fList of files to run the checks on.(PATH)│ +│--all-files-aRun checks on all files.│ +│--show-diff-on-failure-sShow diff for files modified by the checks.│ +│--last-commit-cRun checks for all files in last commit. Mutually exclusive with --commit-ref.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--commit-ref-rRun checks for this commit reference only (can be any git commit-ish reference). Mutually  │ +│exclusive with --last-commit.                                                              │ +│(TEXT)                                                                                     │ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-stop.svg b/images/breeze/output-stop.svg index 40f24b393dd3de..5fc1819e952937 100644 --- a/images/breeze/output-stop.svg +++ b/images/breeze/output-stop.svg @@ -1,4 +1,4 @@ - + - Command: stop - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: stop + + + + + - + -                                                                                                                          - Usage: breeze stop [OPTIONS]                                                                                            -                                                                                                                         - Stop running breeze environment.                                                                                        -                                                                                                                         -╭─ Stop flags ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --preserve-volumes  -p  Skip removing volumes when stopping Breeze.                                                  │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze stop [OPTIONS] + +Stop running breeze environment. + +╭─ Stop flags ─────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--preserve-volumes-pSkip removing volumes when stopping Breeze.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-tests.svg b/images/breeze/output-tests.svg index 3a3d3ca450a755..7c024583422140 100644 --- a/images/breeze/output-tests.svg +++ b/images/breeze/output-tests.svg @@ -1,4 +1,4 @@ - + - Command: tests - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: tests + + + + + - + -                                                                                                                          - Usage: breeze tests [OPTIONS] [EXTRA_PYTEST_ARGS]...                                                                    -                                                                                                                         - Run the specified unit test targets. Multiple targets may be specified separated by spaces.                             -                                                                                                                         -╭─ Basic flag for tests command ───────────────────────────────────────────────────────────────────────────────────────╮ -│ --integration       Integration(s) to enable when running (can be more than one).                                    │ -│                     (cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino | all)      │ -│ --test-type    -tt  Type of test to run.                                                                             │ -│                     (All | Always | Core | Providers | API | CLI | Integration | Other | WWW | Postgres | MySQL |    │ -│                     Helm | Quarantined)                                                                              │ -│ --db-reset     -d   Reset DB when entering the container.                                                            │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --dry-run  -D  If dry-run is set, commands are only printed, not executed.                                           │ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze tests [OPTIONS] [EXTRA_PYTEST_ARGS]... + +Run the specified unit test targets. Multiple targets may be specified separated by spaces. + +╭─ Basic flag for tests command ───────────────────────────────────────────────────────────────────────────────────────╮ +│--integrationIntegration(s) to enable when running (can be more than one).                              │ +│(cassandra | kerberos | mongo | openldap | pinot | rabbitmq | redis | statsd | trino | all)│ +│--test-type-ttType of test to run.                                                                            │ +│(All | Always | Core | Providers | API | CLI | Integration | Other | WWW | Postgres | MySQL |   │ +│Helm | Quarantined)                                                                             │ +│--db-reset-dReset DB when entering the container.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--verbose-vPrint verbose information about performed steps.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-verify-image.svg b/images/breeze/output-verify-image.svg index ef652a60eeb7df..b79efb93f26020 100644 --- a/images/breeze/output-verify-image.svg +++ b/images/breeze/output-verify-image.svg @@ -1,4 +1,4 @@ - + - Command: verify-image - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: verify-image + + + + + - + -                                                                                                                          - Usage: breeze verify-image [OPTIONS] [EXTRA_PYTEST_ARGS]...                                                             -                                                                                                                         - Verify CI image.                                                                                                        -                                                                                                                         -╭─ Verify image flags ─────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --image-name  -n  Name of the image to verify (overrides --python and --image-tag). (TEXT)                           │ -│ --python      -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)            │ -│                   [default: 3.7]                                                                                     │ -│ --image-tag   -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze verify-image [OPTIONS] [EXTRA_PYTEST_ARGS]... + +Verify CI image. + +╭─ Verify image flags ─────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--image-name-nName of the image to verify (overrides --python and --image-tag).(TEXT)│ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-verify-prod-image.svg b/images/breeze/output-verify-prod-image.svg index 46432f50968ce6..4bc7a36527741e 100644 --- a/images/breeze/output-verify-prod-image.svg +++ b/images/breeze/output-verify-prod-image.svg @@ -1,4 +1,4 @@ - + - Command: verify-prod-image - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: verify-prod-image + + + + + - + -                                                                                                                          - Usage: breeze verify-prod-image [OPTIONS] [EXTRA_PYTEST_ARGS]...                                                        -                                                                                                                         - Verify Production image.                                                                                                -                                                                                                                         -╭─ Verify image flags ─────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --image-name  -n  Name of the image to verify (overrides --python and --image-tag). (TEXT)                           │ -│ --python      -p  Python major/minor version used in Airflow image for images. (>3.7< | 3.8 | 3.9 | 3.10)            │ -│                   [default: 3.7]                                                                                     │ -│ --image-tag   -t  Tag added to the default naming conventions of Airflow CI/PROD images. (TEXT)                      │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze verify-prod-image [OPTIONS] [EXTRA_PYTEST_ARGS]... + +Verify Production image. + +╭─ Verify image flags ─────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--image-name-nName of the image to verify (overrides --python and --image-tag).(TEXT)│ +│--python-pPython major/minor version used in Airflow image for images.(>3.7< | 3.8 | 3.9 | 3.10)│ +│[default: 3.7]                                              │ +│--image-tag-tTag added to the default naming conventions of Airflow CI/PROD images.(TEXT)│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-verify-provider-packages.svg b/images/breeze/output-verify-provider-packages.svg index 59a2dd397e3212..cfb88fbcc47556 100644 --- a/images/breeze/output-verify-provider-packages.svg +++ b/images/breeze/output-verify-provider-packages.svg @@ -1,4 +1,4 @@ - + - Command: verify-provider-packages - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: verify-provider-packages + + + + + - + -                                                                                                                          - Usage: breeze verify-provider-packages [OPTIONS]                                                                        -                                                                                                                         - Verifies if all provider code is following expectations for providers.                                                  -                                                                                                                         -╭─ Provider verification flags ────────────────────────────────────────────────────────────────────────────────────────╮ -│ --use-airflow-version              Use (reinstall at entry) Airflow version from PyPI. It can also be `none`,        │ -│                                    `wheel`, or `sdist` if Airflow should be removed, installed from wheel packages   │ -│                                    or sdist packages available in dist folder respectively. Implies --mount-sources  │ -│                                    `none`.                                                                           │ -│                                    (none | wheel | sdist | <airflow_version>)                                        │ -│ --airflow-constraints-reference    Constraint reference to use. Useful with --use-airflow-version parameter to       │ -│                                    specify constraints for the installed version and to find newer dependencies      │ -│                                    (TEXT)                                                                            │ -│ --airflow-extras                   Airflow extras to install when --use-airflow-version is used (TEXT)               │ -│ --use-packages-from-dist           Install all found packages (--package-format determines type) from 'dist' folder  │ -│                                    when entering breeze.                                                             │ -│ --package-format                   Format of packages that should be installed from dist. (wheel | sdist)            │ -│                                    [default: wheel]                                                                  │ -│ --debug                            Drop user in shell instead of running the command. Useful for debugging.          │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose            -v  Print verbose information about performed steps.                                            │ -│ --dry-run            -D  If dry-run is set, commands are only printed, not executed.                                 │ -│ --github-repository  -g  GitHub repository used to pull, push run images. (TEXT) [default: apache/airflow]           │ -│ --help               -h  Show this message and exit.                                                                 │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze verify-provider-packages [OPTIONS] + +Verifies if all provider code is following expectations for providers. + +╭─ Provider verification flags ────────────────────────────────────────────────────────────────────────────────────────╮ +│--use-airflow-versionUse (reinstall at entry) Airflow version from PyPI. It can also be `none`,       │ +│`wheel`, or `sdist` if Airflow should be removed, installed from wheel packages  │ +│or sdist packages available in dist folder respectively. Implies --mount-sources│ +│`none`.                                                                          │ +│(none | wheel | sdist | <airflow_version>)                                       │ +│--airflow-constraints-referenceConstraint reference to use. Useful with --use-airflow-version parameter to      │ +│specify constraints for the installed version and to find newer dependencies     │ +│(TEXT)                                                                           │ +│--airflow-extrasAirflow extras to install when --use-airflow-version is used(TEXT)│ +│--use-packages-from-distInstall all found packages (--package-format determines type) from 'dist' folder │ +│when entering breeze.                                                            │ +│--package-formatFormat of packages that should be installed from dist.(wheel | sdist)│ +│[default: wheel]                                      │ +│--debugDrop user in shell instead of running the command. Useful for debugging.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--dry-run-DIf dry-run is set, commands are only printed, not executed.│ +│--github-repository-gGitHub repository used to pull, push run images.(TEXT)[default: apache/airflow]│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/images/breeze/output-version.svg b/images/breeze/output-version.svg index 6636182300ccc2..9d37a0a7ac8524 100644 --- a/images/breeze/output-version.svg +++ b/images/breeze/output-version.svg @@ -1,4 +1,4 @@ - + - Command: version - - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Command: version + + + + + - + -                                                                                                                          - Usage: breeze version [OPTIONS]                                                                                         -                                                                                                                         - Print information about version of apache-airflow-breeze.                                                               -                                                                                                                         -╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ -│ --verbose  -v  Print verbose information about performed steps.                                                      │ -│ --help     -h  Show this message and exit.                                                                           │ -╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ - + + +Usage: breeze version [OPTIONS] + +Print information about version of apache-airflow-breeze. + +╭─ Options ────────────────────────────────────────────────────────────────────────────────────────────────────────────╮ +│--verbose-vPrint verbose information about performed steps.│ +│--help-hShow this message and exit.│ +╰──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯ + + diff --git a/setup.cfg b/setup.cfg index 6311319feb22e3..bd7310499674b3 100644 --- a/setup.cfg +++ b/setup.cfg @@ -156,7 +156,7 @@ install_requires = python-dateutil>=2.3 python-nvd3>=0.15.0 python-slugify>=5.0 - rich>=12.4.1 + rich>=12.4.4 setproctitle>=1.1.8 # SQL Alchemy 1.4.10 introduces a bug where for PyODBC driver UTCDateTime fields get wrongly converted # as string and fail to be converted back to datetime. It was supposed to be fixed in