gcloud container hub scopes update Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud container hub scopes update - update a scope
- SYNOPSIS
gcloud container hub scopes update(SCOPE:--location=LOCATION)[--update-labels=[KEY=VALUE,…]][--update-namespace-labels=[KEY=VALUE,…]][--clear-labels|--remove-labels=[KEY,…]][--clear-namespace-labels|--remove-namespace-labels=[KEY,…]][--default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING--remove-upgrade-soaking-overrides|--add-upgrade-soaking-override=ADD_UPGRADE_SOAKING_OVERRIDE--upgrade-selector=[name=NAME],[version=VERSION]--reset-upstream-scope|--upstream-scope=UPSTREAM_SCOPE][GCLOUD_WIDE_FLAG …]
- DESCRIPTION
- Update an existing Fleet Scope.
- EXAMPLES
- First retrieve the ID of the scope using the command below.
gcloudcontainerhubscopeslistUpdate a scope.
gcloudcontainerhubscopesupdateSCOPE_NAME - POSITIONAL ARGUMENTS
- Scope resource - fleet scope resource. The arguments in this group can be usedto specify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
To set the
projectattribute:- provide the argument
scopeon the command line with a fullyspecified name; - provide the argument
--projecton the command line; - set the property
core/project.
This must be specified.
SCOPE- ID of the scope or fully qualified identifier for the scope.
To set the
scopeattribute:- provide the argument
scopeon the command line.
This positional argument must be specified if any of the other arguments in thisgroup are specified.
- provide the argument
--location=LOCATION- The location name.
To set the
locationattribute:- provide the argument
scopeon the command line with a fullyspecified name; - provide the argument
--locationon the command line; - global is the only supported location.
- provide the argument
- provide the argument
- Scope resource - fleet scope resource. The arguments in this group can be usedto specify the attributes of this resource. (NOTE) Some attributes are not givenarguments in this group but can be set in other ways.
- FLAGS
--update-labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to update. If a label exists, its value ismodified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens(
-), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers. --update-namespace-labels=[KEY=VALUE,…]- List of scope-level label KEY=VALUE pairs to update in the cluster namespace. Ifa label exists, its value is modified. Otherwise, a new label is' created.
- At most one of these can be specified:
--clear-labels- Remove all labels. If
--update-labelsis also specified then--clear-labelsis applied first.For example, to remove all labels:
gcloudcontainerhubscopesupdate--clear-labelsTo remove all existing labels and create two new labels,
andfoo:bazgcloudcontainerhubscopesupdate--clear-labels--update-labelsfoo=bar,baz=qux --remove-labels=[KEY,…]- List of label keys to remove. If a label does not exist it is silently ignored.If
--update-labelsis also specified then--update-labelsis applied first.
- At most one of these can be specified:
--clear-namespace-labels- Remove all scope-level labels from the cluster namespace. If
--update-namespace-labelsis also specified then--clear-namespace-labelsis applied first.For example, to remove all labels:
gcloudcontainerhubscopesupdatescope_name--clear-namespace-labelsTo remove all existing scope-level labels and create two new labels,
andfoo:bazgcloudcontainerhubscopesupdatescope_name--clear-namespace-labels--update-namespace-labelsfoo=bar,baz=qux --remove-namespace-labels=[KEY,…]- List of scope-level label keys to remove in the cluster namespace. If a labeldoes not exist it is silently ignored. If
--update-namespace-labelsis also specified then--update-namespace-labelsis applied first.
- Rollout Sequencing
--default-upgrade-soaking=DEFAULT_UPGRADE_SOAKING- Configures the default soaking duration for each upgrade propagating through thecurrent scope to become "COMPLETE". Soaking begins after all clusters in thescope are on the target version, or after 30 days if all cluster upgrades arenot complete. Once an upgrade state becomes "COMPLETE", it will automatically bepropagated to the downstream scope. Max is 30 days.
See
$gcloud topicdatetimesfor information on duration formats.To configure Rollout Sequencing for a given scope,
, this attribute must be set. Todo this while specifying a default soaking duration of 7 days, run:SCOPE_NAMEgcloudcontainerhubscopesupdateSCOPE_NAMEdefault-upgrade-soaking=7d - At most one of these can be specified:
--remove-upgrade-soaking-overrides- Removes soaking time overrides for all upgrades propagating through the currentscope. Consequently, all upgrades will follow the soak time configured by
--default-upgrade-soakinguntil new overrides are configured with--add_upgrade_soaking_overrideand--upgrade_selector.To remove all soaking time overrides configured for
, run:SCOPE_NAMEgcloudcontainerhubscopesupdateSCOPE_NAME--remove-upgrade-soaking-overrides - Upgrade soaking override.
Defines a specific soaking time override for a particular upgrade propagatingthrough the current scope that supercedes the default soaking durationconfigured by
--default-upgrade-soaking.To set an upgrade soaking override of 12 hours for the upgrade with name,
k8s_control_plane, and version,1.23.1-gke.1000, run:gcloudcontainerhubscopesupdateSCOPE_NAME--add-upgrade-soaking-override=12h--upgrade-selector=name="k8s_control_plane",version="1.23.1-gke.1000"--add-upgrade-soaking-override=ADD_UPGRADE_SOAKING_OVERRIDE- Overrides the soaking time for a particular upgrade name and version propagatingthrough the current scope. Set soaking to 0 days to bypass soaking andfast-forward the upgrade to the downstream scope.
See
$gcloud topicdatetimesfor information on duration formats.This flag argument must be specified if any of the other arguments in this groupare specified.
--upgrade-selector=[name=NAME],[version=VERSION]- Name and version of the upgrade to be overridden where version is a full GKEversion. Currently, name can be either
k8s_control_planeork8s_node.This flag argument must be specified if any of the other arguments in this groupare specified.
- At most one of these can be specified:
--reset-upstream-scope- Clears the relationship between the current scope and its upstream scope in therollout sequence.
To remove the link between
andits upstream scope, run:SCOPE_NAMEgcloudcontainerhubscopesupdateSCOPE_NAME--reset-upstream-scope --upstream-scope=UPSTREAM_SCOPE- Full resource name of the upstream scope in the format ofprojects/{project}/locations/{location}/scopes/{scope}. GKE will finish upgradeson the upstream scope before applying the same upgrades to the current scope.
To configure the upstream scope for
, run:SCOPE_NAMEgcloudcontainerhubscopesupdateSCOPE_NAME--upstream-scope=projects/{upstream_project}/locations/global/scopes/{upstream_scope}
- 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
$gcloud helpfor details. - API REFERENCE
- This command uses the
gkehub/v1API. The full documentation forthis API can be found at:https://cloud.google.com/anthos/multicluster-management/connect/registering-a-cluster - NOTES
- These variants are also available:
gcloudalphacontainerhubscopesupdategcloudbetacontainerhubscopesupdate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-05-07 UTC.