1
0
Fork 0
mirror of https://github.com/imjasonh/gcloud-help synced 2026-07-18 06:47:12 +00:00

gcloud: Wed Sep 25 09:51:52 UTC 2024

This commit is contained in:
Automated 2024-09-25 09:51:52 +00:00
parent 8ebed5b0f1
commit 0a5b6f11af
202 changed files with 9781 additions and 830 deletions

View file

@ -87,7 +87,7 @@ OPTIONAL FLAGS
For more information about examples and how to use this filter, please
refer to the Backup for GKE documentation:
https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke.
https://cloud.google.com/kubernetes-engine/docs/add-on/backup-for-gke/how-to/fine-grained-restore.
--labels=[KEY=VALUE,...]
List of label KEY=VALUE pairs to add.

View file

@ -1,20 +1,26 @@
NAME
gcloud beta container fleet config-management apply - update a Config
Management Feature Spec
Management feature spec
SYNOPSIS
gcloud beta container fleet config-management apply --config=CONFIG
[--version=VERSION] [--membership=MEMBERSHIP : --location=LOCATION]
[GCLOUD_WIDE_FLAG ...]
gcloud beta container fleet config-management apply
(--origin=ORIGIN | [--config=CONFIG : --version=VERSION])
[--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update a user-specified config file to a ConfigManagement Custom
Resource. The config file should be a .yaml file, all eligible fields are
listed in
https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields
(BETA) Update a membership configuration for the Config Management feature
in a fleet. This command errors if the Config Management feature is not
enabled on the fleet.
EXAMPLES
To apply a YAML config file to a membership, prepare apply-spec.yaml
To apply the fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
to MEMBERSHIP_NAME, run:
$ gcloud beta container fleet config-management apply \
--membership=MEMBERSHIP_NAME --origin=FLEET
To apply a membership configuration as a YAML file, prepare apply-spec.yaml
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields#example_gcloud_apply_spec)
then run:
@ -23,13 +29,43 @@ EXAMPLES
--version=VERSION
REQUIRED FLAGS
--config=CONFIG
The path to config-management.yaml.
Update the membership configuration either to the fleet-default membership
configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
with --origin or to a user-provided configuration with --config and
--version.
Exactly one of these must be specified:
--origin=ORIGIN
Updates the configuration of the target membership to the current
fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features).
Errors if fleet-default membership configuration is not enabled; see
the enable command for more details. ORIGIN must be (only one value
is supported): FLEET.
Provide the entire membership configuration to update with --config and
--version.
--config=CONFIG
Path to YAML file that contains the configuration to update the
target membership to. The file accepts the following fields
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields).
This flag argument must be specified if any of the other arguments
in this group are specified.
--version=VERSION
Version of Config Management. Equivalent to the `spec.version`
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields#common)
field in the --config file. Provides --config with a version in the
absence of spec.version. Cannot specify this flag without --config;
cannot set both this flag and spec.version. See `spec.version`
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields#common)
for more details.
OPTIONAL FLAGS
--version=VERSION
The version of ACM to install.
Membership resource - The group of arguments defining a membership. 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

View file

@ -1,23 +1,40 @@
NAME
gcloud beta container fleet config-management disable - disable Config
Management Feature
Management feature
SYNOPSIS
gcloud beta container fleet config-management disable [--force]
[GCLOUD_WIDE_FLAG ...]
gcloud beta container fleet config-management disable
[--fleet-default-member-config | --force] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Disable the Config Management Feature in a fleet.
(BETA) Disable the Config Management feature in a fleet. Disable the
feature entirely or only disable fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
for the feature.
EXAMPLES
To disable the Config Management Feature, run:
To disable the Config Management feature entirely, run:
$ gcloud beta container fleet config-management disable
To disable only fleet-default membership configuration for the feature,
run:
$ gcloud beta container fleet config-management disable \
--fleet-default-member-config
FLAGS
--force
Disable this feature, even if it is currently in use. Force disablement
may result in unexpected behavior.
At most one of these can be specified:
--fleet-default-member-config
Disable fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
without disabling the feature. Does not change existing membership
configurations. Exits silently if the feature is not enabled.
--force
Disable this feature, even if it is currently in use. Force
disablement may result in unexpected behavior.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

View file

@ -1,18 +1,43 @@
NAME
gcloud beta container fleet config-management enable - enable Config
Management Feature
Management feature
SYNOPSIS
gcloud beta container fleet config-management enable [GCLOUD_WIDE_FLAG ...]
gcloud beta container fleet config-management enable
[--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Enables the Config Management Feature in a fleet.
(BETA) Enables the Config Management feature in a fleet. Without any flags,
this command no-ops if the feature is already enabled. This command can
also enable the feature with a fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
for Config Sync.
EXAMPLES
To enable the Config Management Feature, run:
To enable the Config Management feature, run:
$ gcloud beta container fleet config-management enable
To enable the Config Management feature with a fleet-default membership
configuration for Config Sync, run:
$ gcloud beta container fleet config-management enable \
--fleet-default-member-config=config.yaml
FLAGS
--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG
Path to YAML file that contains the fleet-default membership
configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
to enable with a new feature. This file shares the syntax of the
--config flag on the apply command: see recognized fields here
(https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/reference/gcloud-apply-fields).
Errors if the Policy Controller or Hierarchy Controller field is set.
This flag will also enable or update the fleet-default membership
configuration on an existing feature. See the apply command for how to
sync a membership to the fleet-default membership configuration.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -1,13 +1,13 @@
NAME
gcloud beta container fleet config-management - manage Config Management
Feature
feature
SYNOPSIS
gcloud beta container fleet config-management COMMAND
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Config Sync using the Config Management Feature. Policy
(BETA) Manage Config Sync using the Config Management feature. Policy
Controller users should use the separate command group: gcloud container
fleet policycontroller. Hierarchy Controller users should use
https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
@ -21,23 +21,23 @@ COMMANDS
COMMAND is one of the following:
apply
(BETA) Update a Config Management Feature Spec.
(BETA) Update a Config Management feature spec.
disable
(BETA) Disable Config Management Feature.
(BETA) Disable Config Management feature.
enable
(BETA) Enable Config Management Feature.
(BETA) Enable Config Management feature.
status
(BETA) Print the status of all clusters with Config Management enabled.
unmanage
(BETA) Remove the Config Management Feature Spec for the given
(BETA) Remove the Config Management feature spec for the given
membership.
upgrade
(BETA) Upgrade the version of the Config Management Feature.
(BETA) Upgrade the version of the Config Management feature.
version
(BETA) Print the version of all clusters with Config Management

View file

@ -8,16 +8,24 @@ SYNOPSIS
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Print the status of all clusters with Config Management enabled.
(BETA) The Synced_to_Fleet_Default status indicates whether each
membership's configuration has been synced with the fleet-default
membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features).
Synced_to_Fleet_Default displays FLEET_DEFAULT_NOT_CONFIGURED when
fleet-default membership configuration is not enabled.
Synced_to_Fleet_Default for an individual membership may be UNKNOWN if
configuration has yet to be applied to this membership since enabling
fleet-default membership configuration. See the enable and apply commands
for more details.
EXAMPLES
Print the status of the Config Management Feature:
Print the status of the Config Management feature:
$ gcloud beta container fleet config-management status
Name Status Last_Synced_Token Sync_Branch Last_Synced_Time Hierarchy_Controller
managed-cluster SYNCED 2945500b7f acme 2020-03-23
11:12:31 -0700 PDT INSTALLED
Name Status Last_Synced_Token Sync_Branch Last_Synced_Time Policy_Controller Hierarchy_Controller Version Upgrades Synced_To_Fleet_Default
managed-cluster SYNCED 2945500b7f acme 2020-03-23 11:12:31 -0700 PDT NA NA 1.18.3 auto FLEET_DEFAULT_NOT_CONFIGURED
View the status for the cluster named managed-cluster-a:
@ -29,13 +37,13 @@ EXAMPLES
$ gcloud beta container fleet config-management status \
--filter="acm_status.name ~ managed-cluster.*"
List all clusters where current status is SYNCED:
List all clusters where current Config Sync Status is SYNCED:
$ gcloud beta container fleet config-management status \
--filter="acm_status.config_sync:SYNCED"
List all the clusters where sync_branch is v1 and current Config Sync
status is not SYNCED:
Status is not SYNCED:
$ gcloud beta container fleet config-management status \
--filter="acm_status.sync_branch:v1 AND \

View file

@ -1,18 +1,18 @@
NAME
gcloud beta container fleet config-management unmanage - remove the Config
Management Feature Spec for the given membership
Management feature spec for the given membership
SYNOPSIS
gcloud beta container fleet config-management unmanage
[--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Remove the Config Management Feature Spec for the given membership.
(BETA) Remove the Config Management feature spec for the given membership.
The existing ConfigManagement resources in the clusters will become
unmanaged.
EXAMPLES
To remove the Config Management Feature spec for a membership, run:
To remove the Config Management feature spec for a membership, run:
$ gcloud beta container fleet config-management unmanage \
--membership=MEMBERSHIP_NAME

View file

@ -1,6 +1,6 @@
NAME
gcloud beta container fleet config-management upgrade - upgrade the version
of the Config Management Feature
of the Config Management feature
SYNOPSIS
gcloud beta container fleet config-management upgrade --version=VERSION
@ -8,7 +8,7 @@ SYNOPSIS
DESCRIPTION
(BETA) Upgrade a specified membership to any supported version of the
Config Management Feature.
Config Management feature.
EXAMPLES
To upgrade a membership named MEMBERSHIP_NAME, run:

View file

@ -52,7 +52,7 @@ GROUPS
(BETA) Configure the Fleet clusterupgrade feature.
config-management
(BETA) Manage Config Management Feature.
(BETA) Manage Config Management feature.
dataplane-v2-encryption
(BETA) Manage Dataplane V2 Encryption Feature.

View file

@ -1,20 +1,26 @@
NAME
gcloud beta container hub config-management apply - update a Config
Management Feature Spec
Management feature spec
SYNOPSIS
gcloud beta container hub config-management apply --config=CONFIG
[--version=VERSION] [--membership=MEMBERSHIP : --location=LOCATION]
[GCLOUD_WIDE_FLAG ...]
gcloud beta container hub config-management apply
(--origin=ORIGIN | [--config=CONFIG : --version=VERSION])
[--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Update a user-specified config file to a ConfigManagement Custom
Resource. The config file should be a .yaml file, all eligible fields are
listed in
https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields
(BETA) Update a membership configuration for the Config Management feature
in a fleet. This command errors if the Config Management feature is not
enabled on the fleet.
EXAMPLES
To apply a YAML config file to a membership, prepare apply-spec.yaml
To apply the fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
to MEMBERSHIP_NAME, run:
$ gcloud beta container hub config-management apply \
--membership=MEMBERSHIP_NAME --origin=FLEET
To apply a membership configuration as a YAML file, prepare apply-spec.yaml
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields#example_gcloud_apply_spec)
then run:
@ -23,13 +29,43 @@ EXAMPLES
--version=VERSION
REQUIRED FLAGS
--config=CONFIG
The path to config-management.yaml.
Update the membership configuration either to the fleet-default membership
configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
with --origin or to a user-provided configuration with --config and
--version.
Exactly one of these must be specified:
--origin=ORIGIN
Updates the configuration of the target membership to the current
fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features).
Errors if fleet-default membership configuration is not enabled; see
the enable command for more details. ORIGIN must be (only one value
is supported): FLEET.
Provide the entire membership configuration to update with --config and
--version.
--config=CONFIG
Path to YAML file that contains the configuration to update the
target membership to. The file accepts the following fields
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields).
This flag argument must be specified if any of the other arguments
in this group are specified.
--version=VERSION
Version of Config Management. Equivalent to the `spec.version`
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields#common)
field in the --config file. Provides --config with a version in the
absence of spec.version. Cannot specify this flag without --config;
cannot set both this flag and spec.version. See `spec.version`
(https://cloud.google.com/anthos-config-management/docs/reference/gcloud-apply-fields#common)
for more details.
OPTIONAL FLAGS
--version=VERSION
The version of ACM to install.
Membership resource - The group of arguments defining a membership. 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

View file

@ -1,23 +1,40 @@
NAME
gcloud beta container hub config-management disable - disable Config
Management Feature
Management feature
SYNOPSIS
gcloud beta container hub config-management disable [--force]
[GCLOUD_WIDE_FLAG ...]
gcloud beta container hub config-management disable
[--fleet-default-member-config | --force] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Disable the Config Management Feature in a fleet.
(BETA) Disable the Config Management feature in a fleet. Disable the
feature entirely or only disable fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
for the feature.
EXAMPLES
To disable the Config Management Feature, run:
To disable the Config Management feature entirely, run:
$ gcloud beta container hub config-management disable
To disable only fleet-default membership configuration for the feature,
run:
$ gcloud beta container hub config-management disable \
--fleet-default-member-config
FLAGS
--force
Disable this feature, even if it is currently in use. Force disablement
may result in unexpected behavior.
At most one of these can be specified:
--fleet-default-member-config
Disable fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
without disabling the feature. Does not change existing membership
configurations. Exits silently if the feature is not enabled.
--force
Disable this feature, even if it is currently in use. Force
disablement may result in unexpected behavior.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,

View file

@ -1,18 +1,43 @@
NAME
gcloud beta container hub config-management enable - enable Config
Management Feature
Management feature
SYNOPSIS
gcloud beta container hub config-management enable [GCLOUD_WIDE_FLAG ...]
gcloud beta container hub config-management enable
[--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG]
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Enables the Config Management Feature in a fleet.
(BETA) Enables the Config Management feature in a fleet. Without any flags,
this command no-ops if the feature is already enabled. This command can
also enable the feature with a fleet-default membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
for Config Sync.
EXAMPLES
To enable the Config Management Feature, run:
To enable the Config Management feature, run:
$ gcloud beta container hub config-management enable
To enable the Config Management feature with a fleet-default membership
configuration for Config Sync, run:
$ gcloud beta container hub config-management enable \
--fleet-default-member-config=config.yaml
FLAGS
--fleet-default-member-config=FLEET_DEFAULT_MEMBER_CONFIG
Path to YAML file that contains the fleet-default membership
configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features)
to enable with a new feature. This file shares the syntax of the
--config flag on the apply command: see recognized fields here
(https://cloud.google.com/kubernetes-engine/enterprise/config-sync/docs/reference/gcloud-apply-fields).
Errors if the Policy Controller or Hierarchy Controller field is set.
This flag will also enable or update the fleet-default membership
configuration on an existing feature. See the apply command for how to
sync a membership to the fleet-default membership configuration.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account,
--billing-project, --configuration, --flags-file, --flatten, --format,

View file

@ -1,12 +1,12 @@
NAME
gcloud beta container hub config-management - manage Config Management
Feature
feature
SYNOPSIS
gcloud beta container hub config-management COMMAND [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Manage Config Sync using the Config Management Feature. Policy
(BETA) Manage Config Sync using the Config Management feature. Policy
Controller users should use the separate command group: gcloud container
fleet policycontroller. Hierarchy Controller users should use
https://github.com/kubernetes-sigs/hierarchical-namespaces instead.
@ -20,23 +20,23 @@ COMMANDS
COMMAND is one of the following:
apply
(BETA) Update a Config Management Feature Spec.
(BETA) Update a Config Management feature spec.
disable
(BETA) Disable Config Management Feature.
(BETA) Disable Config Management feature.
enable
(BETA) Enable Config Management Feature.
(BETA) Enable Config Management feature.
status
(BETA) Print the status of all clusters with Config Management enabled.
unmanage
(BETA) Remove the Config Management Feature Spec for the given
(BETA) Remove the Config Management feature spec for the given
membership.
upgrade
(BETA) Upgrade the version of the Config Management Feature.
(BETA) Upgrade the version of the Config Management feature.
version
(BETA) Print the version of all clusters with Config Management

View file

@ -8,16 +8,24 @@ SYNOPSIS
[GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Print the status of all clusters with Config Management enabled.
(BETA) The Synced_to_Fleet_Default status indicates whether each
membership's configuration has been synced with the fleet-default
membership configuration
(https://cloud.google.com/kubernetes-engine/fleet-management/docs/manage-features).
Synced_to_Fleet_Default displays FLEET_DEFAULT_NOT_CONFIGURED when
fleet-default membership configuration is not enabled.
Synced_to_Fleet_Default for an individual membership may be UNKNOWN if
configuration has yet to be applied to this membership since enabling
fleet-default membership configuration. See the enable and apply commands
for more details.
EXAMPLES
Print the status of the Config Management Feature:
Print the status of the Config Management feature:
$ gcloud beta container hub config-management status
Name Status Last_Synced_Token Sync_Branch Last_Synced_Time Hierarchy_Controller
managed-cluster SYNCED 2945500b7f acme 2020-03-23
11:12:31 -0700 PDT INSTALLED
Name Status Last_Synced_Token Sync_Branch Last_Synced_Time Policy_Controller Hierarchy_Controller Version Upgrades Synced_To_Fleet_Default
managed-cluster SYNCED 2945500b7f acme 2020-03-23 11:12:31 -0700 PDT NA NA 1.18.3 auto FLEET_DEFAULT_NOT_CONFIGURED
View the status for the cluster named managed-cluster-a:
@ -29,13 +37,13 @@ EXAMPLES
$ gcloud beta container hub config-management status \
--filter="acm_status.name ~ managed-cluster.*"
List all clusters where current status is SYNCED:
List all clusters where current Config Sync Status is SYNCED:
$ gcloud beta container hub config-management status \
--filter="acm_status.config_sync:SYNCED"
List all the clusters where sync_branch is v1 and current Config Sync
status is not SYNCED:
Status is not SYNCED:
$ gcloud beta container hub config-management status \
--filter="acm_status.sync_branch:v1 AND \

View file

@ -1,18 +1,18 @@
NAME
gcloud beta container hub config-management unmanage - remove the Config
Management Feature Spec for the given membership
Management feature spec for the given membership
SYNOPSIS
gcloud beta container hub config-management unmanage
[--membership=MEMBERSHIP : --location=LOCATION] [GCLOUD_WIDE_FLAG ...]
DESCRIPTION
(BETA) Remove the Config Management Feature Spec for the given membership.
(BETA) Remove the Config Management feature spec for the given membership.
The existing ConfigManagement resources in the clusters will become
unmanaged.
EXAMPLES
To remove the Config Management Feature spec for a membership, run:
To remove the Config Management feature spec for a membership, run:
$ gcloud beta container hub config-management unmanage \
--membership=MEMBERSHIP_NAME

View file

@ -1,6 +1,6 @@
NAME
gcloud beta container hub config-management upgrade - upgrade the version
of the Config Management Feature
of the Config Management feature
SYNOPSIS
gcloud beta container hub config-management upgrade --version=VERSION
@ -8,7 +8,7 @@ SYNOPSIS
DESCRIPTION
(BETA) Upgrade a specified membership to any supported version of the
Config Management Feature.
Config Management feature.
EXAMPLES
To upgrade a membership named MEMBERSHIP_NAME, run:

View file

@ -52,7 +52,7 @@ GROUPS
(BETA) Configure the Fleet clusterupgrade feature.
config-management
(BETA) Manage Config Management Feature.
(BETA) Manage Config Management feature.
dataplane-v2-encryption
(BETA) Manage Dataplane V2 Encryption Feature.