Cluster configuration field reference

This page describes the fields supported in the Anthos clusters on bare metal cluster configuration file. For each field, the following table identifies whether the field is required. The table also shows which fields are mutable, meaning which fields can be changed after a cluster has been created. As noted in the table, some mutable fields can only be changed during a cluster upgrade.

Generating a template for your cluster configuration file

You can create a cluster configuration file with the bmctl create config command. Although some fields have default values and others, such as metadata.name can be auto-filled, this YAML format configuration file is a template for specifying information about your cluster.

To create a new cluster configuration file, use the following command in the /baremetal folder:

bmctl create config -c CLUSTER_NAME

Replace CLUSTER_NAME with the name for the cluster you want to create. For more information about bmctl, see bmctl tool. For an example of the generated cluster configuration file, see Cluster configuration file sample.

Filling in your configuration file

In your configuration file, enter field values as described in the following field reference table before you create or upgrade your cluster.

Cluster configuration fields

Field name Resource type Required? Mutable?
Cluster resource Required Mutable
Cluster resource
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Optional Mutable
Cluster resource
Cluster resource Optional Immutable
Cluster resource Optional Mutable
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Required Immutable
Cluster resource Optional Mutable
Cluster resource Required Immutable
Cluster resource
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Required Immutable
Cluster resource Required Immutable
Cluster resource
Cluster resource
Cluster resource Required Mutable
Cluster resource
Cluster resource Required Immutable
Cluster resource Optional Mutable
Cluster resource
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource Required Immutable
Cluster resource Optional Immutable
Cluster resource Optional Mutable
Cluster resource Required Immutable
Cluster resource Optional Immutable
Cluster resource
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Required Immutable
Cluster resource Required Immutable
Cluster resource Optional Immutable
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Optional Mutable
Cluster resource Optional Immutable
Cluster resource Optional Mutable (upgrade only)
Cluster resource
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource
Cluster resource Optional Immutable
Cluster resource Optional Immutable
Cluster resource
Cluster resource Optional Mutable (upgrade only)
Cluster resource Optional Mutable (upgrade only)
Cluster resource
Cluster resource
Cluster resource Optional Mutable
Cluster resource Required Immutable
Cluster resource Required Immutable
Cluster resource Required Immutable
Cluster resource Required Immutable
Cluster resource Required Immutable
Cluster resource Optional Immutable
Cluster resource Required Immutable
Namespace resource Required Immutable
NodePool resource Required Immutable
NodePool resource Optional Mutable
NodePool resource Optional Mutable
NodePool resource Optional Mutable
NodePool resource Optional Mutable
Registry mirror Optional Mutable
Registry mirror Optional Mutable
Registry mirror Optional Mutable
Registry mirror Optional Mutable
Registry mirror Optional Mutable
Credentials 
Credentials  Optional Mutable
Credentials  Optional Mutable
Credentials  Optional Mutable
Credentials  Optional Mutable
Credentials  Optional Mutable
ClusterCIDRConfig resource Optional Immutable
ClusterCIDRConfig resource Required Immutable
ClusterCIDRConfig resource Required Immutable
ClusterCIDRConfig resource Optional Immutable
ClusterCIDRConfig resource Required Immutable
ClusterCIDRConfig resource Required Immutable
ClusterCIDRConfig resource Optional Mutable