[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 4f40b889059b6eb8d3b710a3abca5c526659861c
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-Enter
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 99d37e2d35a9d82103b35e4042c27a7f5620b568
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 99d37e2d35a9d82103b35e4042c27a7f5620b568
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 512f5f9d4c675bad50ec1888538808c294275209
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 512f5f9d4c675bad50ec1888538808c294275209
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 512f5f9d4c675bad50ec1888538808c294275209
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 512f5f9d4c675bad50ec1888538808c294275209
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
[airflow] 09/09: Update Breeze documentation (#9608)
This is an automated email from the ASF dual-hosted git repository.
kaxilnaik pushed a commit to branch v1-10-test
in repository https://gitbox.apache.org/repos/asf/airflow.git
commit 512f5f9d4c675bad50ec1888538808c294275209
Author: Jarek Potiuk
AuthorDate: Wed Jul 1 16:02:24 2020 +0200
Update Breeze documentation (#9608)
* Update Breeze documentation
(cherry picked from commit f3e1f9a313d8a6f841f6a5c9f2663518fee16b8f)
---
BREEZE.rst | 293
TESTING.rst | 2 +-
2 files changed, 198 insertions(+), 97 deletions(-)
diff --git a/BREEZE.rst b/BREEZE.rst
index 9b318e2..735286a 100644
--- a/BREEZE.rst
+++ b/BREEZE.rst
@@ -232,44 +232,6 @@ from your ``logs`` directory in the Airflow sources, so
all logs created in the
visible in the host as well. Every time you enter the container, the ``logs``
directory is
cleaned so that logs do not accumulate.
-CLIs for cloud providers
-
-
-For development convenience we installed simple wrappers for the most common
cloud providers CLIs. Those
-CLIs are not installed when you build or pull the image - they will be
downloaded as docker images
-the first time you attempt to use them. It is downloaded and executed in your
host's docker engine so once
-it is downloaded, it will stay until you remove the downloaded images from
your host container.
-
-For each of those CLI credentials are taken (automatically) from the
credentials you have defined in
-your ${HOME} directory on host.
-
-Those tools also have host Airflow source directory mounted in /opt/airflow
path
-so you can directly transfer files to/from your airflow host sources.
-
-Those are currently installed CLIs (they are available as aliases to the
docker commands):
-
-+---+--+-+---+
-| Cloud Provider| CLI tool | Docker image
| Configuration dir |
-+===+==+=+===+
-| Amazon Web Services | aws | amazon/aws-cli:latest
| .aws |
-+---+--+-+---+
-| Microsoft Azure | az | mcr.microsoft.com/azure-cli:latest
| .azure|
-+---+--+-+---+
-| Google Cloud Platform | bq |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gcloud |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-|
+--+-+---+
-| | gsutil |
gcr.io/google.com/cloudsdktool/cloud-sdk:latest | .config/gcloud|
-+---+--+-+---+
-
-For each of the CLIs we have also an accompanying ``*-update`` alias (for
example ``aws-update``) which
-will pull the latest image for the tool. Note that all Google Cloud Platform
tools are served by one
-image and they are updated together.
-
-Also - in case you run several different Breeze containers in parallel (from
different directories,
-with different versions) - they docker images for CLI Cloud Providers tools
are shared so if you update it
-for one Breeze container, they will also get updated for all the other
containers.
-
Using the Airflow Breeze Environment
=
@@ -287,6 +249,7 @@ Managing CI environment:
* Stop running interactive environment with ``breeze stop`` command
* Restart running interactive environment with ``breeze restart`` command
* Run test specified with ``breeze tests`` command
+* Generate requirements with ``breeze generate-requirements`` command
* Execute arbitrary command in the test environment with ``breeze shell``
command
* Execute arbitrary docker-compose command with ``breeze docker-compose``
command
* Push docker images with ``breeze push-image`` command (require
committer's rights to push images)
@@ -319,7 +282,7 @@ Manage and Interact with Kubernetes tests environment:
Run static checks:
* Run static checks - either for currently staged change or for all files
with
- ``breeze static-check`` or ``breeze static-check-all-files`` command
+ ``breeze static-check`` command
Build documentation:
@@ -330,10 +293,12 @@ Set up local development environment:
* Setup local virtualenv with ``breeze setup-virtualenv`` command
* Setup autocomplete for itself with ``breeze setup-autocomplete`` command
-
-En
