.TH "GCLOUD_COMPOSER_ENVIRONMENTS_UPDATE" 1



.SH "NAME"
.HP
gcloud composer environments update \- update properties of a Cloud Composer environment



.SH "SYNOPSIS"
.HP
\f5gcloud composer environments update\fR (\fIENVIRONMENT\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) (\fB\-\-airflow\-database\-retention\-days\fR=\fIAIRFLOW_DATABASE_RETENTION_DAYS\fR\ |\ \fB\-\-cloud\-sql\-machine\-type\fR=\fICLOUD_SQL_MACHINE_TYPE\fR\ |\ \fB\-\-disable\-high\-resilience\fR\ |\ \fB\-\-disable\-logs\-in\-cloud\-logging\-only\fR\ |\ \fB\-\-disable\-private\-environment\fR\ |\ \fB\-\-enable\-high\-resilience\fR\ |\ \fB\-\-enable\-logs\-in\-cloud\-logging\-only\fR\ |\ \fB\-\-enable\-private\-environment\fR\ |\ \fB\-\-environment\-size\fR=\fIENVIRONMENT_SIZE\fR\ |\ \fB\-\-image\-version\fR=\fIIMAGE_VERSION\fR\ |\ \fB\-\-node\-count\fR=\fINODE_COUNT\fR\ |\ \fB\-\-support\-web\-server\-plugins\fR\ |\ \fB\-\-web\-server\-machine\-type\fR=\fIWEB_SERVER_MACHINE_TYPE\fR\ |\ \fB\-\-clear\-maintenance\-window\fR\ |\ \fB\-\-maintenance\-window\-end\fR=\fIMAINTENANCE_WINDOW_END\fR\ \fB\-\-maintenance\-window\-recurrence\fR=\fIMAINTENANCE_WINDOW_RECURRENCE\fR\ \fB\-\-maintenance\-window\-start\fR=\fIMAINTENANCE_WINDOW_START\fR\ |\ \fB\-\-disable\-cloud\-data\-lineage\-integration\fR\ |\ \fB\-\-enable\-cloud\-data\-lineage\-integration\fR\ |\ \fB\-\-disable\-master\-authorized\-networks\fR\ \fB\-\-enable\-master\-authorized\-networks\fR\ \fB\-\-master\-authorized\-networks\fR=[\fINETWORK\fR,...]\ |\ \fB\-\-disable\-private\-builds\-only\fR\ |\ \fB\-\-enable\-private\-builds\-only\fR\ |\ \fB\-\-disable\-scheduled\-snapshot\-creation\fR\ |\ \fB\-\-enable\-scheduled\-snapshot\-creation\fR\ \fB\-\-snapshot\-creation\-schedule\fR=\fISNAPSHOT_CREATION_SCHEDULE\fR\ \fB\-\-snapshot\-location\fR=\fISNAPSHOT_LOCATION\fR\ \fB\-\-snapshot\-schedule\-timezone\fR=\fISNAPSHOT_SCHEDULE_TIMEZONE\fR\ |\ \fB\-\-disable\-vpc\-connectivity\fR\ |\ \fB\-\-network\-attachment\fR=\fINETWORK_ATTACHMENT\fR\ |\ [\fB\-\-network\fR=\fINETWORK\fR\ :\ \fB\-\-subnetwork\fR=\fISUBNETWORK\fR]\ |\ \fB\-\-max\-workers\fR=\fIMAX_WORKERS\fR\ \fB\-\-min\-workers\fR=\fIMIN_WORKERS\fR\ \fB\-\-scheduler\-count\fR=\fISCHEDULER_COUNT\fR\ \fB\-\-scheduler\-cpu\fR=\fISCHEDULER_CPU\fR\ \fB\-\-scheduler\-memory\fR=\fISCHEDULER_MEMORY\fR\ \fB\-\-scheduler\-storage\fR=\fISCHEDULER_STORAGE\fR\ \fB\-\-web\-server\-cpu\fR=\fIWEB_SERVER_CPU\fR\ \fB\-\-web\-server\-memory\fR=\fIWEB_SERVER_MEMORY\fR\ \fB\-\-web\-server\-storage\fR=\fIWEB_SERVER_STORAGE\fR\ \fB\-\-worker\-cpu\fR=\fIWORKER_CPU\fR\ \fB\-\-worker\-memory\fR=\fIWORKER_MEMORY\fR\ \fB\-\-worker\-storage\fR=\fIWORKER_STORAGE\fR\ \fB\-\-dag\-processor\-count\fR=\fIDAG_PROCESSOR_COUNT\fR\ \fB\-\-dag\-processor\-cpu\fR=\fIDAG_PROCESSOR_CPU\fR\ \fB\-\-dag\-processor\-memory\fR=\fIDAG_PROCESSOR_MEMORY\fR\ \fB\-\-dag\-processor\-storage\fR=\fIDAG_PROCESSOR_STORAGE\fR\ \fB\-\-disable\-triggerer\fR\ |\ \fB\-\-enable\-triggerer\fR\ \fB\-\-triggerer\-count\fR=\fITRIGGERER_COUNT\fR\ \fB\-\-triggerer\-cpu\fR=\fITRIGGERER_CPU\fR\ \fB\-\-triggerer\-memory\fR=\fITRIGGERER_MEMORY\fR\ |\ \fB\-\-update\-airflow\-configs\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-airflow\-configs\fR\ |\ \fB\-\-remove\-airflow\-configs\fR=[\fIKEY\fR,...]\ |\ \fB\-\-update\-env\-variables\fR=[\fINAME\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-env\-variables\fR\ |\ \fB\-\-remove\-env\-variables\fR=[\fINAME\fR,...]\ |\ \fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]\ |\ \fB\-\-update\-pypi\-packages\-from\-file\fR=\fIUPDATE_PYPI_PACKAGES_FROM_FILE\fR\ |\ \fB\-\-update\-pypi\-package\fR=\fIPACKAGE\fR[\fIEXTRAS_LIST\fR]\fIVERSION_SPECIFIER\fR\ \fB\-\-clear\-pypi\-packages\fR\ |\ \fB\-\-remove\-pypi\-packages\fR=[\fIPACKAGE\fR,...]\ |\ \fB\-\-update\-web\-server\-allow\-ip\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIip_range\fR=\fIIP_RANGE\fR]\ |\ \fB\-\-web\-server\-allow\-all\fR\ |\ \fB\-\-web\-server\-deny\-all\fR) [\fB\-\-async\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update properties of a Cloud Composer environment.



.SH "EXAMPLES"

To update the Cloud Composer environment named \f5\fIenv\-1\fR\fR to have 8
Airflow workers, and not have the \f5\fIproduction\fR\fR label, run:

.RS 2m
$ gcloud composer environments update env\-1 \-\-node\-count=8 \e
    \-\-remove\-labels=production
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Environment resource \- The environment to update. 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 \f5project\fR attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(em" 2m
provide the argument \f5\-\-project\fR on the command line;
.IP "\(em" 2m
set the property \f5core/project\fR.
.RE
.sp

This must be specified.


.RS 2m
.TP 2m
\fIENVIRONMENT\fR

ID of the environment or fully qualified identifier for the environment.

To set the \f5environment\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line.
.RE
.sp

This positional argument must be specified if any of the other arguments in this
group are specified.

.TP 2m
\fB\-\-location\fR=\fILOCATION\fR

Region where Composer environment runs or in which to create the environment.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5environment\fR on the command line with a fully
specified name;
.IP "\(bu" 2m
provide the argument \f5\-\-location\fR on the command line;
.IP "\(bu" 2m
set the property \f5composer/location\fR.
.RE
.sp


.RE
.RE
.sp

.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m

The update type.

Exactly one of these must be specified:


.RS 2m
.TP 2m
\fB\-\-airflow\-database\-retention\-days\fR=\fIAIRFLOW_DATABASE_RETENTION_DAYS\fR

The number of days for the Airflow database retention period. If set to 0, the
Airflow database retention mechanism will be disabled.

.TP 2m
\fB\-\-cloud\-sql\-machine\-type\fR=\fICLOUD_SQL_MACHINE_TYPE\fR

Cloud SQL machine type used by the Airflow database. The list of available
machine types is available here:
https://cloud.google.com/composer/pricing#db\-machine\-types.

.TP 2m
\fB\-\-disable\-high\-resilience\fR

Disable high resilience, supported for Composer 2 Environments.

.TP 2m
\fB\-\-disable\-logs\-in\-cloud\-logging\-only\fR

Disable logs in cloud logging only, supported for Composer 2 Environments.

.TP 2m
\fB\-\-disable\-private\-environment\fR

Enable internet connection from any Composer component, supported in Composer 3
environments or greater.

.TP 2m
\fB\-\-enable\-high\-resilience\fR

Enable high resilience, supported for Composer 2 Environments.

.TP 2m
\fB\-\-enable\-logs\-in\-cloud\-logging\-only\fR

Enable logs in cloud logging only, supported for Composer 2 Environments.

.TP 2m
\fB\-\-enable\-private\-environment\fR

Disable internet connection from any Composer component, supported in Composer 3
environments or greater.

.TP 2m
\fB\-\-environment\-size\fR=\fIENVIRONMENT_SIZE\fR

Size of the environment. Unspecified means that the default option will be
chosen. \fIENVIRONMENT_SIZE\fR must be one of: \fBlarge\fR, \fBmedium\fR,
\fBsmall\fR, \fBunspecified\fR.

.TP 2m

Group of arguments for performing in\-place environment upgrades.


.RS 2m
.TP 2m
\fB\-\-image\-version\fR=\fIIMAGE_VERSION\fR

Upgrade the environment to a later version in\-place.

The image version encapsulates the versions of both Cloud Composer and Apache
Airflow. Must be of the form \f5composer\-A[.B.C[\-D.E]]\-airflow\-X[.Y[.Z]]\fR,
where \f5[]\fR denotes optional fragments.

Examples: \f5composer\-2\-airflow\-2\fR, \f5composer\-2\-airflow\-2.2\fR,
\f5composer\-2.1.2\-airflow\-2.3.4\fR.

The Cloud Composer portion of the image version is a semantic version or an
alias in the form of major version number or \f5latest\fR, resolved to the
current Cloud Composer version. The Apache Airflow portion of the image version
is a semantic version or an alias in the form of major or major.minor version
numbers, resolved to the latest matching Apache Airflow version supported in the
given Cloud Composer version. The resolved versions are stored in the upgraded
environment.

.RE
.sp
.TP 2m
\fB\-\-node\-count\fR=\fINODE_COUNT\fR

The new number of nodes running the environment. Must be >= 3.

.TP 2m
\fB\-\-support\-web\-server\-plugins\fR

Enable the support for web server plugins, supported in Composer 3 or greater.

.TP 2m
\fB\-\-web\-server\-machine\-type\fR=\fIWEB_SERVER_MACHINE_TYPE\fR

machine type used by the Airflow web server. The list of available machine types
is available here: https://cloud.google.com/composer/pricing.

.TP 2m

Group of arguments for setting the maintenance window value during update.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-maintenance\-window\fR

Clears the maintenance window settings. Can be specified for Composer 3 or
greater.

.TP 2m

Group of arguments for setting the maintenance window value.


.RS 2m
.TP 2m
\fB\-\-maintenance\-window\-end\fR=\fIMAINTENANCE_WINDOW_END\fR

End time of the mantenance window in the form of the full date. Only the time of
the day is used as a reference for an ending time of the window with a provided
recurrence. Specified date must take place after the one specified as a start
date, the difference between will be used as a length of a single maintenance
window. See $ gcloud topic datetimes for information on time formats.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-maintenance\-window\-recurrence\fR=\fIMAINTENANCE_WINDOW_RECURRENCE\fR

An RFC 5545 RRULE, specifying how the maintenance window will recur. The minimum
requirement for the length of the maintenance window is 12 hours a week. Only
FREQ=DAILY and FREQ=WEEKLY rules are supported.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-maintenance\-window\-start\fR=\fIMAINTENANCE_WINDOW_START\fR

Start time of the mantenance window in the form of the full date. Only the time
of the day is used as a reference for a starting time of the window with a
provided recurrence. See $ gcloud topic datetimes for information on time
formats.

This flag argument must be specified if any of the other arguments in this group
are specified.

.RE
.RE
.sp
.TP 2m

Group of arguments for setting Cloud Data Lineage integration configuration in
Composer 2.


.RS 2m
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-cloud\-data\-lineage\-integration\fR

Disable Cloud Data Lineage integration, supported for Composer 2 Environments.

.TP 2m
\fB\-\-enable\-cloud\-data\-lineage\-integration\fR

Enable Cloud Data Lineage integration, supported for Composer 2 Environments.

.RE
.RE
.sp
.TP 2m

Group of arguments for setting master authorized networks configuration.


.RS 2m
.TP 2m
\fB\-\-disable\-master\-authorized\-networks\fR

Disable Master Authorized Networks feature
(https://cloud.google.com/kubernetes\-engine/docs/how\-to/authorized\-networks/)
in the Composer Environment's GKE cluster.

.TP 2m
\fB\-\-enable\-master\-authorized\-networks\fR

Enable Master Authorized Networks feature
(https://cloud.google.com/kubernetes\-engine/docs/how\-to/authorized\-networks/)
in the Composer Environment's GKE cluster.

.TP 2m
\fB\-\-master\-authorized\-networks\fR=[\fINETWORK\fR,...]

Comma separated Master Authorized Networks specified in CIDR notation.

Cannot be specified unless \f5\-\-enable\-master\-authorized\-networks\fR is
also specified.

.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-private\-builds\-only\fR

Builds performed during operations that install Python packages have an access
to the internet, supported in Composer 3 or greater.

.TP 2m
\fB\-\-enable\-private\-builds\-only\fR

Builds performed during operations that install Python packages have only
private connectivity to Google services, supported in Composer 3 or greater.

.RE
.sp
.TP 2m

Group of arguments used during update of scheduled snapshots settings in
Composer 2.0.32 or greater.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-scheduled\-snapshot\-creation\fR

Disables automated snapshots creation. Can be specified for Composer 2.0.32 or
greater.

.TP 2m

Group of arguments for setting scheduled snapshots settings in Composer 2.0.32
or greater.


.RS 2m
.TP 2m
\fB\-\-enable\-scheduled\-snapshot\-creation\fR

When specified, snapshots of the environment will be created according to a
schedule. Can be specified for Composer 2.0.32 or greater.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-snapshot\-creation\-schedule\fR=\fISNAPSHOT_CREATION_SCHEDULE\fR

Cron expression specifying when snapshots of the environment should be created.
Can be specified for Composer 2.0.32 or greater.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-snapshot\-location\fR=\fISNAPSHOT_LOCATION\fR

The Cloud Storage location for storing automatically created snapshots. Can be
specified for Composer 2.0.32 or greater.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-snapshot\-schedule\-timezone\fR=\fISNAPSHOT_SCHEDULE_TIMEZONE\fR

Timezone that sets the context to interpret snapshot_creation_schedule. Can be
specified for Composer 2.0.32 or greater.

This flag argument must be specified if any of the other arguments in this group
are specified.

.RE
.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-vpc\-connectivity\fR

Disable connectivity with a user's VPC network, supported in Composer 3
environments or greater.

.TP 2m
\fB\-\-network\-attachment\fR=\fINETWORK_ATTACHMENT\fR

Cloud Composer Network Attachment, which provides connectivity with a user's VPC
network, supported in Composer 3 environments or greater.

.TP 2m

Virtual Private Cloud networking


.RS 2m
.TP 2m
\fB\-\-network\fR=\fINETWORK\fR

The Compute Engine Network to which the environment will be connected. If a
\'Custom Subnet Network' is provided, \f5\-\-subnetwork\fR must be specified as
well.

This flag argument must be specified if any of the other arguments in this group
are specified.

.TP 2m
\fB\-\-subnetwork\fR=\fISUBNETWORK\fR

The Compute Engine Subnetwork
(https://cloud.google.com/compute/docs/subnetworks) to which the environment
will be connected.

.RE
.RE
.sp
.TP 2m

Group of arguments for setting workloads configuration in Composer 2.X or
greater (\-\-scheduler\-count flag is available for Composer 1.X as well).


.RS 2m
.TP 2m
\fB\-\-max\-workers\fR=\fIMAX_WORKERS\fR

Maximum number of workers in the Environment.

.TP 2m
\fB\-\-min\-workers\fR=\fIMIN_WORKERS\fR

Minimum number of workers in the Environment.

.TP 2m
\fB\-\-scheduler\-count\fR=\fISCHEDULER_COUNT\fR

Number of schedulers, supported in the Environments with Airflow 2.0.1 and
later.

.TP 2m
\fB\-\-scheduler\-cpu\fR=\fISCHEDULER_CPU\fR

CPU allocated to Airflow scheduler.

.TP 2m
\fB\-\-scheduler\-memory\fR=\fISCHEDULER_MEMORY\fR

Memory allocated to Airflow scheduler, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB.

.TP 2m
\fB\-\-scheduler\-storage\fR=\fISCHEDULER_STORAGE\fR

Storage allocated to Airflow scheduler, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB.

.TP 2m
\fB\-\-web\-server\-cpu\fR=\fIWEB_SERVER_CPU\fR

CPU allocated to each Airflow web server

.TP 2m
\fB\-\-web\-server\-memory\fR=\fIWEB_SERVER_MEMORY\fR

Memory allocated to Airflow web server, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB.

.TP 2m
\fB\-\-web\-server\-storage\fR=\fIWEB_SERVER_STORAGE\fR

Storage allocated to Airflow web server, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB.

.TP 2m
\fB\-\-worker\-cpu\fR=\fIWORKER_CPU\fR

CPU allocated to each Airflow worker

.TP 2m
\fB\-\-worker\-memory\fR=\fIWORKER_MEMORY\fR

Memory allocated to Airflow worker, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB.

.TP 2m
\fB\-\-worker\-storage\fR=\fIWORKER_STORAGE\fR

Storage allocated to Airflow worker, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB.

.TP 2m

Group of arguments for setting dag processor settings in Composer 3 or greater.


.RS 2m
.TP 2m
\fB\-\-dag\-processor\-count\fR=\fIDAG_PROCESSOR_COUNT\fR

Number of dag processors, supported in Composer 3 environments or greater.

.TP 2m
\fB\-\-dag\-processor\-cpu\fR=\fIDAG_PROCESSOR_CPU\fR

CPU allocated to Airflow dag processor, supported in Composer 3 environments or
greater.

.TP 2m
\fB\-\-dag\-processor\-memory\fR=\fIDAG_PROCESSOR_MEMORY\fR

Memory allocated to Airflow dag processor, ex. 1GB, 3GB, 2. If units are not
provided, defaults to GB, supported in Composer 3 environments or greater.

.TP 2m
\fB\-\-dag\-processor\-storage\fR=\fIDAG_PROCESSOR_STORAGE\fR

Storage allocated to Airflow dag processor, ex. 600MB, 3GB, 2. If units are not
provided, defaults to GB, supported in Composer 3 environments or greater.

.RE
.sp
.TP 2m

Group of arguments for setting triggerer settings in Composer 2.0.31 or greater.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-disable\-triggerer\fR

(DEPRECATED) Disable a triggerer, supported in the Environments with Composer
2.0.31 and Airflow 2.2.5 and greater.

This flag is deprecated. Use \-\-triggerer\-count 0 instead.

.TP 2m

Group of arguments for setting triggerer settings during update in Composer
2.0.31 or greater.


.RS 2m
.TP 2m
\fB\-\-enable\-triggerer\fR

(DEPRECATED) Enable use of a triggerer, supported in the Environments with
Composer 2.0.31 and Airflow 2.2.5 and greater.

This flag is deprecated. Use \-\-triggerer\-count instead.

.TP 2m
\fB\-\-triggerer\-count\fR=\fITRIGGERER_COUNT\fR

Number of triggerers, supported in the Environments with Composer 2.0.31 and
Airflow 2.2.5 and greater.

.TP 2m
\fB\-\-triggerer\-cpu\fR=\fITRIGGERER_CPU\fR

CPU allocated to Airflow triggerer. Supported in the Environments with Composer
2.0.31 and Airflow 2.2.5 and greater.

.TP 2m
\fB\-\-triggerer\-memory\fR=\fITRIGGERER_MEMORY\fR

Memory allocated to Airflow triggerer, ex. 512MB, 3GB, 2. If units are not
provided, defaults to GB. Supported in the Environments with Composer 2.0.31 and
Airflow 2.2.5 and greater.

.RE
.RE
.RE
.sp
.TP 2m

Group of arguments for modifying the Airflow configuration.


.RS 2m
.TP 2m
\fB\-\-update\-airflow\-configs\fR=[\fIKEY\fR=\fIVALUE\fR,...]

A list of Airflow config override KEY=VALUE pairs to set. If a config override
exists, its value is updated; otherwise, a new config override is created.

KEYs should specify the configuration section and property name, separated by a
hyphen, for example \f5core\-print_stats_interval\fR. The section may not
contain a closing square brace or period. The property name must be non\-empty
and may not contain an equals sign, semicolon, or period. By convention,
property names are spelled with \f5snake_case.\fR VALUEs may contain any
character.

.TP 2m

Arguments available for item removal.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-airflow\-configs\fR

Removes all Airflow config overrides from the environment.

.TP 2m
\fB\-\-remove\-airflow\-configs\fR=[\fIKEY\fR,...]

A list of Airflow config override keys to remove.

.RE
.RE
.sp
.TP 2m

Group of arguments for modifying environment variables.


.RS 2m
.TP 2m
\fB\-\-update\-env\-variables\fR=[\fINAME\fR=\fIVALUE\fR,...]

A list of environment variable NAME=VALUE pairs to set and provide to the
Airflow scheduler, worker, and webserver processes. If an environment variable
exists, its value is updated; otherwise, a new environment variable is created.

NAMEs are the environment variable names and may contain upper and lowercase
letters, digits, and underscores; they must not begin with a digit.

User\-specified environment variables should not be used to set Airflow
configuration properties. Instead use the \f5\-\-update\-airflow\-configs\fR
flag.

.TP 2m

Arguments available for item removal.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-env\-variables\fR

Removes all environment variables from the environment.

Environment variables that have system\-provided defaults cannot be unset with
the \f5\-\-remove\-env\-variables\fR or \f5\-\-clear\-env\-variables\fR flags;
only the user\-supplied overrides will be removed.

.TP 2m
\fB\-\-remove\-env\-variables\fR=[\fINAME\fR,...]

A list of environment variables to remove.

Environment variables that have system\-provided defaults cannot be unset with
the \f5\-\-remove\-env\-variables\fR or \f5\-\-clear\-env\-variables\fR flags;
only the user\-supplied overrides will be removed.

.RE
.RE
.sp
.TP 2m

Group of arguments for modifying environment labels.


.RS 2m
.TP 2m
\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.

Keys must start with a lowercase character and contain only hyphens (\f5\-\fR),
underscores (\f5_\fR), lowercase characters, and numbers. Values must contain
only hyphens (\f5\-\fR), underscores (\f5_\fR), lowercase characters, and
numbers.

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-labels\fR

Remove all labels. If \f5\-\-update\-labels\fR is also specified then
\f5\-\-clear\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud composer environments update \-\-clear\-labels
.RE

To remove all existing labels and create two new labels, \f5\fIfoo\fR\fR and
\f5\fIbaz\fR\fR:

.RS 2m
$ gcloud composer environments update \-\-clear\-labels \e
  \-\-update\-labels foo=bar,baz=qux
.RE

.TP 2m
\fB\-\-remove\-labels\fR=[\fIKEY\fR,...]

List of label keys to remove. If a label does not exist it is silently ignored.
If \f5\-\-update\-labels\fR is also specified then \f5\-\-update\-labels\fR is
applied first.

.RE
.RE
.sp
.TP 2m

Group of arguments for modifying the PyPI package configuration.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-update\-pypi\-packages\-from\-file\fR=\fIUPDATE_PYPI_PACKAGES_FROM_FILE\fR

The path to a file containing a list of PyPI packages to install in the
environment. Each line in the file should contain a package specification in the
format of the update\-pypi\-package argument defined above. The path can be a
local file path or a Google Cloud Storage file path (Cloud Storage file path
starts with 'gs://').

.TP 2m
\fB\-\-update\-pypi\-package\fR=\fIPACKAGE\fR[\fIEXTRAS_LIST\fR]\fIVERSION_SPECIFIER\fR

A PyPI package to add to the environment. If a package exists, its value is
updated; otherwise, a new package is installed.

The value takes the form of: \f5PACKAGE[EXTRAS_LIST]VERSION_SPECIFIER\fR, as one
would specify in a pip requirements file.

PACKAGE is specified as a package name, such as \f5numpy.\fR EXTRAS_LIST is a
comma\-delimited list of PEP 508 distribution extras that may be empty, in which
case the enclosing square brackets may be omitted. VERSION_SPECIFIER is an
optional PEP 440 version specifier. If both EXTRAS_LIST and VERSION_SPECIFIER
are omitted, the \f5=\fR and everything to the right may be left empty.

This is a repeated argument that can be specified multiple times to update
multiple packages. If PACKAGE appears more than once, the last value will be
used.

.TP 2m

Arguments available for item removal.

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-clear\-pypi\-packages\fR

Removes all PyPI packages from the environment.

PyPI packages that are required by the environment's core software cannot be
uninstalled with the \f5\-\-remove\-pypi\-packages\fR or
\f5\-\-clear\-pypi\-packages\fR flags.

.TP 2m
\fB\-\-remove\-pypi\-packages\fR=[\fIPACKAGE\fR,...]

A list of PyPI package names to remove.

PyPI packages that are required by the environment's core software cannot be
uninstalled with the \f5\-\-remove\-pypi\-packages\fR or
\f5\-\-clear\-pypi\-packages\fR flags.

.RE
.RE
.sp
.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-update\-web\-server\-allow\-ip\fR=[\fIdescription\fR=\fIDESCRIPTION\fR],[\fIip_range\fR=\fIIP_RANGE\fR]

Specifies a list of IPv4 or IPv6 ranges that will be allowed to access the
Airflow web server. By default, all IPs are allowed to access the web server.

.RS 2m
.TP 2m
\fBip_range\fR
IPv4 or IPv6 range of addresses allowed to access the Airflow web server.

.TP 2m
\fBdescription\fR
An optional description of the IP range.

.RE
.sp
.TP 2m
\fB\-\-web\-server\-allow\-all\fR

Allows all IP addresses to access the Airflow web server.

.TP 2m
\fB\-\-web\-server\-deny\-all\fR

Denies all incoming traffic to the Airflow web server.


.RE
.RE
.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-async\fR

Return immediately, without waiting for the operation in progress to complete.


.RE
.sp

.SH "GCLOUD WIDE FLAGS"

These flags are available to all commands: \-\-access\-token\-file, \-\-account,
\-\-billing\-project, \-\-configuration, \-\-flags\-file, \-\-flatten,
\-\-format, \-\-help, \-\-impersonate\-service\-account, \-\-log\-http,
\-\-project, \-\-quiet, \-\-trace\-token, \-\-user\-output\-enabled,
\-\-verbosity.

Run \fB$ gcloud help\fR for details.



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha composer environments update
.RE

.RS 2m
$ gcloud beta composer environments update
.RE