.TH "GCLOUD_CONTAINER_FLEET_SCOPES_UPDATE" 1



.SH "NAME"
.HP
gcloud container fleet scopes update \- update a scope



.SH "SYNOPSIS"
.HP
\f5gcloud container fleet scopes update\fR (\fISCOPE\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-update\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-update\-namespace\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-clear\-labels\fR\ |\ \fB\-\-remove\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-clear\-namespace\-labels\fR\ |\ \fB\-\-remove\-namespace\-labels\fR=[\fIKEY\fR,...]] [\fB\-\-default\-upgrade\-soaking\fR=\fIDEFAULT_UPGRADE_SOAKING\fR\ \fB\-\-remove\-upgrade\-soaking\-overrides\fR\ |\ \fB\-\-add\-upgrade\-soaking\-override\fR=\fIADD_UPGRADE_SOAKING_OVERRIDE\fR\ \fB\-\-upgrade\-selector\fR=[\fIname\fR=\fINAME\fR],[\fIversion\fR=\fIVERSION\fR]\ \fB\-\-reset\-upstream\-scope\fR\ |\ \fB\-\-upstream\-scope\fR=\fIUPSTREAM_SCOPE\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "DESCRIPTION"

Update an existing Fleet Scope.



.SH "EXAMPLES"

First retrieve the ID of the scope using the command below.

.RS 2m
$ gcloud container fleet scopes list
.RE

Update a scope.

.RS 2m
$ gcloud container fleet scopes update SCOPE_NAME
.RE



.SH "POSITIONAL ARGUMENTS"

.RS 2m
.TP 2m

Scope resource \- fleet scope resource. 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 \f5scope\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
\fISCOPE\fR

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

To set the \f5scope\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5scope\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

The location name.

To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5scope\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
global is the only supported location.
.RE
.sp


.RE
.RE
.sp

.SH "FLAGS"

.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
\fB\-\-update\-namespace\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of scope\-level label KEY=VALUE pairs to update in the cluster namespace.
If a label exists, its value is modified. Otherwise, a new label is' created.

.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 container fleet scopes 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 container fleet scopes 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
.sp
.TP 2m

At most one of these can be specified:


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

Remove all scope\-level labels from the cluster namespace. If
\f5\-\-update\-namespace\-labels\fR is also specified then
\f5\-\-clear\-namespace\-labels\fR is applied first.

For example, to remove all labels:

.RS 2m
$ gcloud container fleet scopes update scope_name \e
  \-\-clear\-namespace\-labels
.RE

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

.RS 2m
$ gcloud container fleet scopes update scope_name \e
  \-\-clear\-namespace\-labels \e
  \-\-update\-namespace\-labels foo=bar,baz=qux
.RE

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

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

.RE
.sp
.TP 2m

Rollout Sequencing



.RS 2m
.TP 2m
\fB\-\-default\-upgrade\-soaking\fR=\fIDEFAULT_UPGRADE_SOAKING\fR

Configures the default soaking duration for each upgrade propagating through the
current scope to become "COMPLETE". Soaking begins after all clusters in the
scope are on the target version, or after 30 days if all cluster upgrades are
not complete. Once an upgrade state becomes "COMPLETE", it will automatically be
propagated to the downstream scope. Max is 30 days.

See \f5$ gcloud topic datetimes\fR for information on duration formats.

To configure Rollout Sequencing for a given scope, \f5\fISCOPE_NAME\fR\fR, this
attribute must be set. To do this while specifying a default soaking duration of
7 days, run:

.RS 2m
$ gcloud container fleet scopes update SCOPE_NAME \e
    default\-upgrade\-soaking=7d
.RE

.TP 2m

At most one of these can be specified:


.RS 2m
.TP 2m
\fB\-\-remove\-upgrade\-soaking\-overrides\fR

Removes soaking time overrides for all upgrades propagating through the current
scope. Consequently, all upgrades will follow the soak time configured by
\f5\-\-default\-upgrade\-soaking\fR until new overrides are configured with
\f5\-\-add_upgrade_soaking_override\fR and \f5\-\-upgrade_selector\fR.

To remove all soaking time overrides configured for \f5\fISCOPE_NAME\fR\fR, run:

.RS 2m
$ gcloud container fleet scopes update SCOPE_NAME \e
    \-\-remove\-upgrade\-soaking\-overrides
.RE

.TP 2m

Upgrade soaking override.

Defines a specific soaking time override for a particular upgrade propagating
through the current scope that supercedes the default soaking duration
configured by \f5\-\-default\-upgrade\-soaking\fR.

To set an upgrade soaking override of 12 hours for the upgrade with name,
\f5k8s_control_plane\fR, and version, \f51.23.1\-gke.1000\fR, run:

.RS 2m
$ gcloud container fleet scopes update SCOPE_NAME \e
  \-\-add\-upgrade\-soaking\-override=12h \e
  \-\-upgrade\-selector=name="k8s_control_plane",version="1.23.1\-gke.1000"
.RE



.RS 2m
.TP 2m
\fB\-\-add\-upgrade\-soaking\-override\fR=\fIADD_UPGRADE_SOAKING_OVERRIDE\fR

Overrides the soaking time for a particular upgrade name and version propagating
through the current scope. Set soaking to 0 days to bypass soaking and
fast\-forward the upgrade to the downstream scope.

See \f5$ gcloud topic datetimes\fR for information on duration formats.

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

.TP 2m
\fB\-\-upgrade\-selector\fR=[\fIname\fR=\fINAME\fR],[\fIversion\fR=\fIVERSION\fR]

Name and version of the upgrade to be overridden where version is a full GKE
version. Currently, name can be either \f5k8s_control_plane\fR or
\f5k8s_node\fR.

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\-\-reset\-upstream\-scope\fR

Clears the relationship between the current scope and its upstream scope in the
rollout sequence.

To remove the link between \f5\fISCOPE_NAME\fR\fR and its upstream scope, run:

.RS 2m
$ gcloud container fleet scopes update SCOPE_NAME \e
    \-\-reset\-upstream\-scope
.RE

.TP 2m
\fB\-\-upstream\-scope\fR=\fIUPSTREAM_SCOPE\fR

Full resource name of the upstream scope in the format of
projects/{project}/locations/{location}/scopes/{scope}. GKE will finish upgrades
on the upstream scope before applying the same upgrades to the current scope.

To configure the upstream scope for \f5\fISCOPE_NAME\fR\fR, run:

.RS 2m
$ gcloud container fleet scopes update SCOPE_NAME \e
  \-\-upstream\-scope=projects/{upstream_project}/locations/global/scopes/{upstream_scope}
.RE


.RE
.RE
.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 "API REFERENCE"

This command uses the \fBgkehub/v1\fR API. The full documentation for this API
can be found at:
https://cloud.google.com/anthos/multicluster\-management/connect/registering\-a\-cluster



.SH "NOTES"

These variants are also available:

.RS 2m
$ gcloud alpha container fleet scopes update
.RE

.RS 2m
$ gcloud beta container fleet scopes update
.RE