Last modified May 14, 2020

gsctl update cluster

The gsctl update cluster command allows the modification of some cluster attributes, depending on the release version and the provider.

Changing the cluster name is possible on all providers and in all release versions.

Cluster labelling is only available for clusters with release version v10.0.0 and above on AWS. High availability of master nodes is available on AWS starting at release v11.4.0 .

Usage

The command is called with the cluster ID or name as a positional argument. The desired new name can be specified with the --name or -n flag. The --label flag is used to modify a single label change. It can be specified multiple times in order to change multiple labels at once.

Examples

Modifying the cluster name

gsctl update cluster f01r4 \
  --name "Precious Production Cluster"

Modifying cluster labels

gsctl update cluster vxvc7 \
  --label environment=testing \
  --label locked=

will update the labels of cluster vxvc7. It will add (or update depending on prior existence) label environment=testing and delete the label with key locked.

Switching to high availability of master nodes

Starting with release v11.4.0 , a single master node cluster can be converted into using multiple master nodes in multiple availability zones using a command like the following:

gsctl update cluster vxvc7 \
  --master-ha=true

Note that it is not possible to change from multiple master nodes to a single master.

Full argument reference

  • --name or -n: The new cluster name.
  • --label: Specify a single label update. Allowed multiple times. Available on AWS starting at release 10.0.0 . To remove a label, set its key to an empty string (labeltodelete=).
  • --master-ha: When set to true, the cluster should be modified to use multiple master nodes. Available on AWS starting at release v11.4.0 .