gcloud_alpha_composer_environments_run (1)
NAME
- gcloud alpha composer environments run - run an Airflow sub-command remotely in a Cloud Composer environment
SYNOPSIS
-
gcloud alpha composer environments run (ENVIRONMENT : --location=LOCATION) SUBCOMMAND [GCLOUD_WIDE_FLAG ...] [-- CMD_ARGS ...]
DESCRIPTION
(ALPHA) Executes an Airflow CLI sub-command remotely in an environment.
POSITIONAL ARGUMENTS
-
-
Environment resource - The environment in which to run an Airflow command. The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways. To set the [project] attribute: provide the argument [environment]
on the command line with a fully specified name; provide the argument
[--project] on the command line; set the property [core/project]. This must be
specified.
-
- ENVIRONMENT
-
ID of the environment or fully qualified identifier for the environment. This
positional must be specified if any of the other arguments in this group are
specified.
- --location=LOCATION
-
Compute Engine region in which to create the environment.
-
- SUBCOMMAND
-
The Airflow CLI subcommand to run. (see
airflow.incubator.apache.org/cli.html
- [-- CMD_ARGS ...]
-
Command line arguments to the subcommand.
The '--' argument must be specified between gcloud specific args on the left and CMD_ARGS on the right. Example:
gcloud alpha composer environments run myenv trigger_dag -- some_dag --run_id=foo
-
Environment resource - The environment in which to run an Airflow command. The
arguments in this group can be used to specify the attributes of this resource.
(NOTE) Some attributes are not given arguments in this group but can be set in
other ways. To set the [project] attribute: provide the argument [environment]
on the command line with a fully specified name; provide the argument
[--project] on the command line; set the property [core/project]. This must be
specified.
GCLOUD WIDE FLAGS
These flags are available to all commands: --account, --configuration, --flags-file, --flatten, --format, --help, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity. Run $ gcloud help for details.
EXAMPLES
The following command:
- gcloud alpha composer environments run myenv trigger_dag -- some_dag --run_id=foo
is equivalent to running the following command from a shell inside the my-environment environment:
- airflow trigger_dag some_dag --run_id=foo
NOTES
This command is currently in ALPHA and may change without notice. If this command fails with API permission errors despite specifying the right project, you will have to apply for early access and have your projects registered on the API whitelist to use it. To do so, contact Support at cloud.google.com/support These variants are also available:
- $ gcloud composer environments run $ gcloud beta composer environments run