File: //snap/google-cloud-cli/current/help/man/man1/gcloud_container_bare-metal_clusters_update.1
.TH "GCLOUD_CONTAINER_BARE\-METAL_CLUSTERS_UPDATE" 1
.SH "NAME"
.HP
gcloud container bare\-metal clusters update \- update an Anthos cluster on bare metal
.SH "SYNOPSIS"
.HP
\f5gcloud container bare\-metal clusters update\fR (\fICLUSTER\fR\ :\ \fB\-\-location\fR=\fILOCATION\fR) [\fB\-\-admin\-users\fR=\fIADMIN_USERS\fR] [\fB\-\-allow\-missing\fR] [\fB\-\-async\fR] [\fB\-\-binauthz\-evaluation\-mode\fR=\fIBINAUTHZ_EVALUATION_MODE\fR] [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-enable\-application\-logs\fR] [\fB\-\-login\-user\fR=\fILOGIN_USER\fR] [\fB\-\-maintenance\-address\-cidr\-blocks\fR=[\fIMAINTENANCE_ADDRESS_CIDR_BLOCKS\fR,...]] [\fB\-\-validate\-only\fR] [\fB\-\-version\fR=\fIVERSION\fR] [\fB\-\-add\-annotations\fR=[\fIKEY1\fR=\fIVALUE1\fR,\fIKEY2\fR=\fIVALUE2\fR,...]\ |\ \fB\-\-remove\-annotations\fR=[\fIKEY1\fR,\fIKEY2\fR,...]] [\fB\-\-api\-server\-args\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-control\-plane\-node\-configs\fR=[\fIlabels\fR=\fILABELS\fR],[\fInode\-ip\fR=\fINODE\-IP\fR]\ \fB\-\-control\-plane\-node\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-control\-plane\-node\-taints\fR=[\fIKEY\fR=\fIVALUE\fR:\fIEFFECT\fR,...]\ \fB\-\-control\-plane\-registry\-burst\fR=\fICONTROL_PLANE_REGISTRY_BURST\fR\ \fB\-\-control\-plane\-registry\-pull\-qps\fR=\fICONTROL_PLANE_REGISTRY_PULL_QPS\fR\ \fB\-\-disable\-control\-plane\-serialize\-image\-pulls\fR\ |\ \fB\-\-enable\-control\-plane\-serialize\-image\-pulls\fR] [\fB\-\-bgp\-address\-pools\fR=[\fIaddresses\fR=\fIADDRESSES\fR],[\fIavoid\-buggy\-ips\fR=\fIAVOID\-BUGGY\-IPS\fR],[\fImanual\-assign\fR=\fIMANUAL\-ASSIGN\fR],[\fIpool\fR=\fIPOOL\fR]\ \fB\-\-bgp\-asn\fR=\fIBGP_ASN\fR\ \fB\-\-bgp\-peer\-configs\fR=[\fIasn\fR=\fIASN\fR,\fIip\fR=\fIIP\fR,\fIcontrol\-plane\-nodes\fR=\fINODE_IP_1\fR;\fINODE_IP_2\fR,...]\ \fB\-\-bgp\-load\-balancer\-node\-configs\fR=[\fInode\-ip\fR=\fIIP\fR,\fIlabels\fR=\fIKEY1\fR=\fIVALUE1\fR;\fIKEY2\fR=\fIVALUE2\fR,...]\ \fB\-\-bgp\-load\-balancer\-node\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-bgp\-load\-balancer\-node\-taints\fR=[\fIKEY\fR=\fIVALUE\fR:\fIEFFECT\fR,...]\ \fB\-\-bgp\-load\-balancer\-registry\-burst\fR=\fIBGP_LOAD_BALANCER_REGISTRY_BURST\fR\ \fB\-\-bgp\-load\-balancer\-registry\-pull\-qps\fR=\fIBGP_LOAD_BALANCER_REGISTRY_PULL_QPS\fR\ \fB\-\-disable\-bgp\-load\-balancer\-serialize\-image\-pulls\fR\ |\ \fB\-\-enable\-bgp\-load\-balancer\-serialize\-image\-pulls\fR\ |\ \fB\-\-metal\-lb\-address\-pools\fR=[\fIaddresses\fR=\fIADDRESSES\fR],[\fIavoid\-buggy\-ips\fR=\fIAVOID\-BUGGY\-IPS\fR],[\fImanual\-assign\fR=\fIMANUAL\-ASSIGN\fR],[\fIpool\fR=\fIPOOL\fR]\ \fB\-\-metal\-lb\-load\-balancer\-node\-configs\fR=[\fIlabels\fR=\fILABELS\fR],[\fInode\-ip\fR=\fINODE\-IP\fR]\ \fB\-\-metal\-lb\-load\-balancer\-node\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]\ \fB\-\-metal\-lb\-load\-balancer\-node\-taints\fR=[\fIKEY\fR=\fIVALUE\fR:\fIEFFECT\fR,...]\ \fB\-\-metal\-lb\-load\-balancer\-registry\-burst\fR=\fIMETAL_LB_LOAD_BALANCER_REGISTRY_BURST\fR\ \fB\-\-metal\-lb\-load\-balancer\-registry\-pull\-qps\fR=\fIMETAL_LB_LOAD_BALANCER_REGISTRY_PULL_QPS\fR\ \fB\-\-disable\-metal\-lb\-load\-balancer\-serialize\-image\-pulls\fR\ |\ \fB\-\-enable\-metal\-lb\-load\-balancer\-serialize\-image\-pulls\fR] [\fB\-\-island\-mode\-service\-address\-cidr\-blocks\fR=\fISERVICE_ADDRESS\fR,[...]\ \fB\-\-disable\-sr\-iov\-config\fR\ |\ \fB\-\-enable\-sr\-iov\-config\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]
.SH "DESCRIPTION"
Update an Anthos cluster on bare metal.
.SH "EXAMPLES"
To update a cluster named \f5\fImy\-cluster\fR\fR managed in location
\f5\fIus\-west1\fR\fR, run:
.RS 2m
$ gcloud container bare\-metal clusters update my\-cluster \e
\-\-location=us\-west1
.RE
.SH "POSITIONAL ARGUMENTS"
.RS 2m
.TP 2m
Cluster resource \- cluster 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 \f5cluster\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
\fICLUSTER\fR
ID of the cluster or fully qualified identifier for the cluster.
To set the \f5cluster\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\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
Google Cloud location for the cluster.
To set the \f5location\fR attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \f5cluster\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 \f5container_bare_metal/location\fR.
.RE
.sp
.RE
.RE
.sp
.SH "FLAGS"
.RS 2m
.TP 2m
Anthos on bare metal cluster security configuration.
.RS 2m
.TP 2m
User cluster authorization configurations to bootstrap onto the admin cluster
.RS 2m
.TP 2m
\fB\-\-admin\-users\fR=\fIADMIN_USERS\fR
Users that will be granted the cluster\-admin role on the cluster, providing
full access to the cluster.
.RE
.RE
.sp
.TP 2m
\fB\-\-allow\-missing\fR
If set, and the Anthos cluster on bare metal is not found, the update request
will try to create a new cluster with the provided configuration.
.TP 2m
\fB\-\-async\fR
Return immediately, without waiting for the operation in progress to complete.
.TP 2m
\fB\-\-binauthz\-evaluation\-mode\fR=\fIBINAUTHZ_EVALUATION_MODE\fR
Set Binary Authorization evaluation mode for this cluster.
\fIBINAUTHZ_EVALUATION_MODE\fR must be one of: \fBDISABLED\fR,
\fBPROJECT_SINGLETON_POLICY_ENFORCE\fR.
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR
Description for the resource.
.TP 2m
Anthos on bare metal cluster operations configuration.
.RS 2m
.TP 2m
\fB\-\-enable\-application\-logs\fR
Whether collection of application logs/metrics should be enabled (in addition to
system logs/metrics).
.RE
.sp
.TP 2m
Anthos on bare metal node access related settings for the user cluster.
.RS 2m
.TP 2m
\fB\-\-login\-user\fR=\fILOGIN_USER\fR
User name used to access node machines.
.RE
.sp
.TP 2m
Anthos on bare metal cluster maintenance configuration.
.RS 2m
.TP 2m
\fB\-\-maintenance\-address\-cidr\-blocks\fR=[\fIMAINTENANCE_ADDRESS_CIDR_BLOCKS\fR,...]
IPv4 addresses to be placed into maintenance mode.
.RE
.sp
.TP 2m
\fB\-\-validate\-only\fR
If set, only validate the request, but do not actually perform the operation.
.TP 2m
\fB\-\-version\fR=\fIVERSION\fR
Anthos cluster on bare metal version for the user cluster resource.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-add\-annotations\fR=[\fIKEY1\fR=\fIVALUE1\fR,\fIKEY2\fR=\fIVALUE2\fR,...]
Add the given key\-value pairs to the current annotations, or update its value
if the key already exists.
.TP 2m
\fB\-\-remove\-annotations\fR=[\fIKEY1\fR,\fIKEY2\fR,...]
Remove annotations of the given keys.
.RE
.sp
.TP 2m
Anthos on bare metal cluster control plane configuration.
.RS 2m
.TP 2m
\fB\-\-api\-server\-args\fR=[\fIKEY\fR=\fIVALUE\fR,...]
API Server argument configuration.
.TP 2m
Anthos on bare metal cluster control plane node pool configuration.
.RS 2m
.TP 2m
Anthos on bare metal node pool configuration for control plane nodes.
.RS 2m
.TP 2m
Anthos on bare metal node configuration for control plane nodes.
.RS 2m
.TP 2m
Populate control plane node config.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-control\-plane\-node\-configs\fR=[\fIlabels\fR=\fILABELS\fR],[\fInode\-ip\fR=\fINODE\-IP\fR]
Control plane node configuration.
.RE
.sp
.TP 2m
\fB\-\-control\-plane\-node\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Labels assigned to nodes of a node pool.
.TP 2m
\fB\-\-control\-plane\-node\-taints\fR=[\fIKEY\fR=\fIVALUE\fR:\fIEFFECT\fR,...]
Node taint applied to every Kubernetes node in a node pool.
.TP 2m
Modifiable kubelet configurations for bare metal machines.
.RS 2m
.TP 2m
\fB\-\-control\-plane\-registry\-burst\fR=\fICONTROL_PLANE_REGISTRY_BURST\fR
Maximum size of bursty pulls, temporarily allow pulls to burst to this number,
while still not exceeding registry_pull_qps.
.TP 2m
\fB\-\-control\-plane\-registry\-pull\-qps\fR=\fICONTROL_PLANE_REGISTRY_PULL_QPS\fR
Limit of registry pulls per second.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-disable\-control\-plane\-serialize\-image\-pulls\fR
If set, prevent the Kubelet from pulling multiple images at a time.
.TP 2m
\fB\-\-enable\-control\-plane\-serialize\-image\-pulls\fR
If set, enable the Kubelet to pull multiple images at a time.
.RE
.RE
.RE
.RE
.RE
.RE
.sp
.TP 2m
Anthos on bare metal cluster load balancer configuration.
.RS 2m
.TP 2m
Populate one of the load balancers.
At most one of these can be specified:
.RS 2m
.TP 2m
BGP load balancer configuration.
.RS 2m
.TP 2m
\fB\-\-bgp\-address\-pools\fR=[\fIaddresses\fR=\fIADDRESSES\fR],[\fIavoid\-buggy\-ips\fR=\fIAVOID\-BUGGY\-IPS\fR],[\fImanual\-assign\fR=\fIMANUAL\-ASSIGN\fR],[\fIpool\fR=\fIPOOL\fR]
BGP load balancer address pools configurations.
Examples:
To specify configurations for two address pools \f5pool1\fR and \f5pool2\fR,
.RS 2m
$ gcloud container bare\-metal clusters update example_cluster
\-\-bgp\-address\-pools 'pool=pool1,avoid\-buggy\-ips=True,manual\-assign=True,addresses=192.168.1.1/32;192.168.1.2\-192.168.1.3'
\-\-bgp\-address\-pools 'pool=pool2,avoid\-buggy\-ips=False,manual\-assign=False,addresses=192.168.2.1/32;192.168.2.2\-192.168.2.3'
.RE
Use quote around the flag value to escape semicolon in the terminal.
.TP 2m
\fB\-\-bgp\-asn\fR=\fIBGP_ASN\fR
BGP autonomous system number (ASN) of the cluster.
.TP 2m
\fB\-\-bgp\-peer\-configs\fR=[\fIasn\fR=\fIASN\fR,\fIip\fR=\fIIP\fR,\fIcontrol\-plane\-nodes\fR=\fINODE_IP_1\fR;\fINODE_IP_2\fR,...]
List of BGP peers that the cluster will connect to. At least one peer must be
configured for each control plane node.
Examples:
To specify configurations for two peers of BGP autonomous system number (ASN)
10000 and 20000,
.RS 2m
$ gcloud container bare\-metal clusters update example_cluster
\-\-bgp\-peer\-configs 'asn=10000,ip=192.168.1.1,control\-plane\-nodes=192.168.1.2;192.168.1.3'
\-\-bgp\-peer\-configs 'asn=20000,ip=192.168.2.1,control\-plane\-nodes=192.168.2.2;192.168.2.3'
.RE
Use quote around the flag value to escape semicolon in the terminal.
.TP 2m
\fB\-\-bgp\-load\-balancer\-node\-configs\fR=[\fInode\-ip\fR=\fIIP\fR,\fIlabels\fR=\fIKEY1\fR=\fIVALUE1\fR;\fIKEY2\fR=\fIVALUE2\fR,...]
BGP load balancer data plane node configurations.
Examples:
To specify configurations for two nodes of IP \f5192.168.0.1\fR and
\f5192.168.1.1\fR,
.RS 2m
$ gcloud container bare\-metal clusters update example_cluster
\-\-bgp\-load\-balancer\-node\-configs 'node\-ip=192.168.0.1,labels=KEY1=VALUE1;KEY2=VALUE2'
\-\-bgp\-load\-balancer\-node\-configs 'node\-ip=192.168.1.1,labels=KEY3=VALUE3'
.RE
Use quote around the flag value to escape semicolon in the terminal.
.TP 2m
\fB\-\-bgp\-load\-balancer\-node\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Labels assigned to nodes of a BGP node pool.
.TP 2m
\fB\-\-bgp\-load\-balancer\-node\-taints\fR=[\fIKEY\fR=\fIVALUE\fR:\fIEFFECT\fR,...]
Node taint applied to every Kubernetes node in a node pool.
.TP 2m
Modifiable kubelet configurations for bare metal machines.
.RS 2m
.TP 2m
\fB\-\-bgp\-load\-balancer\-registry\-burst\fR=\fIBGP_LOAD_BALANCER_REGISTRY_BURST\fR
Maximum size of bursty pulls, temporarily allow pulls to burst to this number,
while still not exceeding registry_pull_qps.
.TP 2m
\fB\-\-bgp\-load\-balancer\-registry\-pull\-qps\fR=\fIBGP_LOAD_BALANCER_REGISTRY_PULL_QPS\fR
Limit of registry pulls per second.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-disable\-bgp\-load\-balancer\-serialize\-image\-pulls\fR
If set, prevent the Kubelet from pulling multiple images at a time.
.TP 2m
\fB\-\-enable\-bgp\-load\-balancer\-serialize\-image\-pulls\fR
If set, enable the Kubelet to pull multiple images at a time.
.RE
.RE
.RE
.sp
.TP 2m
MetalLB load balancer configuration.
.RS 2m
.TP 2m
MetalLB address pools configuration.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-metal\-lb\-address\-pools\fR=[\fIaddresses\fR=\fIADDRESSES\fR],[\fIavoid\-buggy\-ips\fR=\fIAVOID\-BUGGY\-IPS\fR],[\fImanual\-assign\fR=\fIMANUAL\-ASSIGN\fR],[\fIpool\fR=\fIPOOL\fR]
MetalLB load balancer configurations.
Examples:
To specify MetalLB load balancer configurations for two address pools
\f5pool1\fR and \f5pool2\fR,
.RS 2m
$ gcloud container bare\-metal clusters update example_cluster
\-\-metal\-lb\-address\-pools 'pool=pool1,avoid\-buggy\-ips=True,manual\-assign=True,addresses=192.168.1.1/32;192.168.1.2\-192.168.1.3'
\-\-metal\-lb\-address\-pools 'pool=pool2,avoid\-buggy\-ips=False,manual\-assign=False,addresses=192.168.2.1/32;192.168.2.2\-192.168.2.3'
.RE
Use quote around the flag value to escape semicolon in the terminal.
.RE
.sp
.TP 2m
Anthos on bare metal node pool configuration for MetalLB load balancer nodes.
.RS 2m
.TP 2m
MetalLB Node Pool configuration.
.RS 2m
.TP 2m
Populate MetalLB load balancer node config.
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-metal\-lb\-load\-balancer\-node\-configs\fR=[\fIlabels\fR=\fILABELS\fR],[\fInode\-ip\fR=\fINODE\-IP\fR]
MetalLB load balancer node configuration.
.RE
.sp
.TP 2m
\fB\-\-metal\-lb\-load\-balancer\-node\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]
Labels assigned to nodes of a MetalLB node pool.
.TP 2m
\fB\-\-metal\-lb\-load\-balancer\-node\-taints\fR=[\fIKEY\fR=\fIVALUE\fR:\fIEFFECT\fR,...]
Node taint applied to every node in a MetalLB node pool.
.TP 2m
Modifiable kubelet configurations for bare metal machines.
.RS 2m
.TP 2m
\fB\-\-metal\-lb\-load\-balancer\-registry\-burst\fR=\fIMETAL_LB_LOAD_BALANCER_REGISTRY_BURST\fR
Maximum size of bursty pulls, temporarily allow pulls to burst to this number,
while still not exceeding registry_pull_qps.
.TP 2m
\fB\-\-metal\-lb\-load\-balancer\-registry\-pull\-qps\fR=\fIMETAL_LB_LOAD_BALANCER_REGISTRY_PULL_QPS\fR
Limit of registry pulls per second.
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-disable\-metal\-lb\-load\-balancer\-serialize\-image\-pulls\fR
If set, prevent the Kubelet from pulling multiple images at a time.
.TP 2m
\fB\-\-enable\-metal\-lb\-load\-balancer\-serialize\-image\-pulls\fR
If set, enable the Kubelet to pull multiple images at a time.
.RE
.RE
.RE
.RE
.RE
.RE
.RE
.sp
.TP 2m
Anthos on bare metal cluster network configurations.
.RS 2m
.TP 2m
Populate one of the network configs.
.RS 2m
.TP 2m
Island mode CIDR network configuration.
.RS 2m
.TP 2m
\fB\-\-island\-mode\-service\-address\-cidr\-blocks\fR=\fISERVICE_ADDRESS\fR,[...]
IPv4 address range for all services in the cluster.
.RE
.RE
.sp
.TP 2m
SR\-IOV networking operator configurations.
.RS 2m
.TP 2m
At most one of these can be specified:
.RS 2m
.TP 2m
\fB\-\-disable\-sr\-iov\-config\fR
If set, the SR\-IOV operator won't be installed.
.TP 2m
\fB\-\-enable\-sr\-iov\-config\fR
If set, install the SR\-IOV operator.
.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 "NOTES"
These variants are also available:
.RS 2m
$ gcloud alpha container bare\-metal clusters update
.RE
.RS 2m
$ gcloud beta container bare\-metal clusters update
.RE