<button class="button button-with-icon cloud-select-dropdown__button button-primary" aria-haspopup="true">Version 1.14 </button>

- [Latest](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/latest/reference/cluster-config-ref)
- [Version 1.16](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.16/reference/cluster-config-ref.md.txt)
- [Earlier versions (unsupported)](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/getting-support.md.txt#version-support)

<br />

This page describes the fields supported in the Google Distributed Cloud 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:

```bash
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](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/reference/bmctl.md.txt).
For an example of the generated cluster configuration file, see
[Cluster configuration file sample](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/reference/cluster-config.md.txt).

## 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

Select a configuration type Cluster resource Namespace resource NodePool resource Credentials Registry mirror ClusterCIDRConfig resource

| Field name | Resource type | Required? | Mutable? |
|---|---|---|---|
| ##### `anthosBareMetalVersion` Required. String. The cluster version. This value is set for cluster creation and cluster upgrades. **Mutability:** This value can't be modified for existing clusters. The version can be updated only through the [cluster upgrade process](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/upgrade.md.txt). | Cluster resource | Required | Mutable |
| ##### `authentication` This section contains settings needed to use OpenID Connect (OIDC). OIDC lets you use your existing identity provider to manage user and group authentication in Google Distributed Cloud clusters. | Cluster resource | --- | --- |
| ##### `authentication.oidc.certificateAuthorityData` Optional. A `base64`-encoded [PEM-encoded certificate](https://wikipedia.org/wiki/Privacy-Enhanced_Mail) for the OIDC provider. To create the string, encode the certificate, including headers, into `base64`. Include the resulting string in `certificateAuthorityData` as a single line. For example (sample wrapped to fit table): ```yaml certificateAuthorityData: LS0tLS1CRUdJTiBDRVJUSUZJQ0FURS0tLS0tC ...k1JSUN2RENDQWFT== ``` | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.clientID` Optional. String. The ID for the client application that makes authentication requests to the OpenID provider. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.clientSecret` Optional. String. Shared secret between OIDC client application and OIDC provider. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.deployCloudConsoleProxy` Optional. Boolean (`true`\|`false`). Specifies whether a reverse proxy is deployed in the cluster to connect Google Cloud console to an on-premises identity provider that is not publicly accessible over the internet. If your identity provider isn't reachable over the public internet, set this field to `true` to authenticate with Google Cloud console. By default this value is set to `false`. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.extraParams` Optional. Comma-delimited list. Additional key-value parameters to send to the OpenID provider. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.groupPrefix` Optional. String. Prefix prepended to group claims to prevent clashes with existing names. For example, given a group `dev` and a prefix `oidc:`, `oidc:dev`. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.group` Optional. String. [JWT](https://tools.ietf.org/html/rfc7519) claim that the provider uses to return your security groups. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.issuerURL` Optional. URL string. URL where authorization requests are sent to your OpenID, such as `https://example.com/adfs`. The Kubernetes API server uses this URL to discover public keys for verifying tokens. The URL must use HTTPS. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.kubectlRedirectURL` Optional. URL string. The redirect URL that `kubectl` uses for authorization. When you enable OIDC, you must specify a `kubectlRedirectURL` value. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.proxy` Optional. URL string. Proxy server to use for the cluster to connect to your OIDC provider, if applicable. The value should include a hostname/IP address and optionally a port, username, and password. For example: `http://user:password@10.10.10.10:8888`. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.scopes` Optional. Comma-delimited list. Additional scopes to send to the OpenID provider. Microsoft Azure and Okta require the `offline_access` scope. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.usernamePrefix` Optional. String. Prefix prepended to username claims. | Cluster resource | Optional | Immutable |
| ##### `authentication.oidc.username` Optional. String. [JWT](https://tools.ietf.org/html/rfc7519) claim to use as the username. If not specified, defaults to `sub`. | Cluster resource | Optional | Immutable |
| ##### `bypassPreflightCheck` Optional. Boolean (`true`\|`false`). When set to `true`, the internal preflight checks are ignored when applying resources to existing clusters. Defaults to `false`. **Mutability:** This value can be modified for existing clusters with the `bmctl update` command. | Cluster resource | Optional | Mutable |
| ##### `clusterNetwork` This section contains network settings for your cluster. | Cluster resource | Required | Mutable |
| ##### `clusterNetwork.advancedNetworking` Boolean. Set this field to `true` to enable advanced networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Both of these features use the Network Gateway for GDC. Network Gateway for GDC is the key component for enabling advanced networking features in GKE Enterprise and Google Kubernetes Engine (GKE). One of the main benefits of Network Gateway for GDC is that it can dynamically allocate floating IP addresses from a set of addresses that you specify in a \`NetworkGatewayGroup\` custom resource. For more information about Network Gateway for GDC and related advanced networking features, see [Configure an egress NAT gateway](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/egress-nat.md.txt) and [Configure bundled load balancers with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt). | Cluster resource | Optional | Immutable |
| ##### `clusterNetwork.bundledIngress` Boolean. Set this field to `false` to disable the Ingress capabilities bundled with Google Distributed Cloud. The bundled Ingress capabilities for your cluster support ingress only. If you integrate with Istio or Cloud Service Mesh for the additional benefits of a fully functional service mesh, we recommend that you disable bundled Ingress. This field is set to `true` by default. This field is not present in the generated cluster configuration file. You can disable bundled Ingress for version 1.13.0 clusters and later only. For more information about the bundled Ingress capability, see [Create a Service and an Ingress](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/create-service-ingress.md.txt). | Cluster resource | Optional | Mutable |
| ##### `clusterNetwork.flatIPv4` Boolean. Set this field to `true` to enable the flat mode cluster networking model. In flat mode, each pod has its own, unique IP address. Pods can communicate with each other directly without the need for an intermediary gateway or network address translation (NAT). `flatIPv4` is `false` by default. You can enable flat mode during cluster creation only. Once you enable flat mode for your cluster, you can't disable it. | Cluster resource | Optional | Immutable |
| ##### `clusterNetwork.multipleNetworkInterfaces` Optional. Boolean. Set this field to `true` to enable multiple network interfaces for your pods. For more information about the setting up and using multiple network interfaces, see the [Configure multiple network interfaces for Pods](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/multi-nic.md.txt) Preview documentation. | Cluster resource | Optional | Immutable |
| ##### `clusterNetwork.pods.cidrBlocks` Required. Range of IPv4 addresses in CIDR block format. Pods specify the IP ranges from which pod networks are allocated. - **Minimum Pod CIDR range:** Mask value of `/18`, which corresponds to a size of 14 bits (16,384 IP addresses). - **Maximum Pod CIDR range:** Mask value of `/8`, which corresponds to a size of 24 bits (16,777,216 IP addresses). For example: ```yaml pods: cidrBlocks: - 192.168.0.0/16 ``` | Cluster resource | Required | Immutable |
| ##### `clusterNetwork.sriovOperator` Optional. Boolean. Set this field to `true` to enable SR-IOV networking for your cluster. For more information about configuring and using SR-IOV networking, see the [Set up SR-IOV networking](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/sriov.md.txt) documentation. | Cluster resource | Optional | Mutable |
| ##### `clusterNetwork.services.cidrBlocks` Required. Range of IPv4 addresses in CIDR block format. Specify the range of IP addresses from which service virtual IP (VIP) addresses are allocated. The ranges must not overlap with any subnets reachable from your network. For more information about address allocation for private internets, see [RFC 1918](https://datatracker.ietf.org/doc/html/rfc1918). - **Minimum Service CIDR range:** Mask value of `/24`, which corresponds to a size of 8 bits (256 addresses). - **Maximum Service CIDR range:** Mask value of `/12`, which corresponds to a size of 20 bits (1,048,576 IP addresses). For example: ```yaml services: cidrBlocks: - 10.96.0.0/12 ``` | Cluster resource | Required | Immutable |
| ##### `clusterOperations` This section holds information for Cloud Logging and Cloud Monitoring. | Cluster resource | Required | Mutable |
| ##### `clusterOperations.enableApplication` Boolean. Set to `true` to collect application logs/metrics in addition to the default collection of system logs/metrics, which correspond to system components such as the Kubernetes control plane or cluster management agents. You can change this value at any time. | Cluster resource | Optional | Mutable |
| ##### `clusterOperations.disableCloudAuditLogging` Boolean. Cloud Audit Logs is useful for investigating suspicious API requests and for collecting statistics. Cloud Audit Logs is enabled (`disableCloudAuditLogging: false`) by default. Set to `true` to disable Cloud Audit Logs. For more information, see [Use Audit Logging](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/audit-logging.md.txt). | Cluster resource | Optional | Mutable |
| ##### `clusterOperations.location` String. A Google Cloud region where you want to store Logging logs and Monitoring metrics. It's a good idea to choose a region that is near your on-premises data center. For more information, see [Global Locations](https://cloud.google.com/about/locations). For example: ```yaml location: us-central1 ``` | Cluster resource | Required | Immutable |
| ##### `clusterOperations.projectID` String. The project ID of the Google Cloud project where you want to view logs and metrics. | Cluster resource | Required | Immutable |
| ##### `controlPlane` This section holds information about the control plane and its components. | Cluster resource | Required | Mutable |
| ##### `controlPlane.nodePoolSpec` This section specifies the IP addresses for the node pool used by the control plane and its components. The control plane node pool specification (like the [load balancer node pool specification](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/reference/cluster-config-ref.md.txt#loadbalancer-nodepoolspec)) is special. This specification declares and controls critical cluster resources. The canonical source for this resource is this section in the cluster configuration file. Don't modify the top-level control plane node pool resources directly. Modify the associated sections in the cluster configuration file instead. | Cluster resource | Required | Mutable |
| ##### `controlPlane.nodePoolSpec.nodes` Required. An array of IP addresses. Typically, this array is either an IP address for a single machine, or IP addresses for three machines for a high-availability (HA) deployment. For example: ```yaml controlPlane: nodePoolSpec: nodes: - address: 192.168.1.212 - address: 192.168.1.213 - address: 192.168.1.214 ``` This field can be changed whenever you update or upgrade a cluster. | Cluster resource | Required | Mutable |
| ##### `gkeConnect` This section holds information about the Google Cloud project you want to use to connect your cluster to Google Cloud. | Cluster resource | Required | Immutable |
| ##### `gkeConnect.projectID` Required: String. The ID of the Google Cloud project that you want to use for connecting your cluster to Google Cloud. This is also referred to as the [fleet host project](https://docs.cloud.google.com/anthos/fleet-management/docs/fleet-concepts#fleet-host-project). For example: ```yaml spec: ... gkeConnect: projectID: "my-connect-project-123" ``` This value can't be modified for existing clusters. | Cluster resource | Required | Immutable |
| ##### `kubevirt.useEmulation` (deprecated) **Deprecated.** As of release 1.11.2, you can enable or disable VM Runtime on GDC by updating the VMRuntime custom resource only. Boolean. Determines whether or not software emulation is used to run virtual machines. If the node supports hardware virtualization, set `useEmulation` to `false` for better performance. If hardware virtualization isn't supported or you aren't sure, set it to `true`. > [!NOTE] > This field is no longer used. The `useEmulation` setting and other VM settings are configured in the `VMRuntime` custom resource. For more information, see [Enable VM Runtime on GDC](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/vm-workloads#enable_anthos_vm_runtime). | Cluster resource | Optional | Mutable |
| ##### `loadBalancer` This section contains settings for cluster load balancing. | Cluster resource | Required | Mutable |
| ##### `loadBalancer.addressPools` Object. The name and an array of IP addresses for your cluster load balancer pool. Address pool configuration is only valid for `bundled` LB mode in non-admin clusters. You can add new address pools at any time, but you can't modify or remove existing address pools. | Cluster resource | Optional | Immutable |
| ##### `loadBalancer.addressPools.addresses` Array of IP address ranges. Specify a list of non-overlapping IP ranges for the data plane load balancer. All addresses must be in the same subnet as the load balancer nodes. For example: ```yaml addressPools: - name: pool1 addresses: - 192.168.1.0-192.168.1.4 - 192.168.1.240/28 ``` | Cluster resource | Optional | Immutable |
| ##### `loadBalancer.addressPools.name` String. The name you choose for your cluster load balancer pool. | Cluster resource | Required | Immutable |
| ##### `loadBalancer.addressPools.avoidBuggyIPs` Optional. Boolean (`true` \| `false`). If `true`, the pool omits IP addresses ending in `.0` and `.255`. Some network hardware drops traffic to these special addresses. You can omit this field, its default value is `false`. | Cluster resource | Optional | Immutable |
| ##### `loadBalancer.addressPools.manualAssign` Optional. Boolean (`true` \| `false`). If `true`, addresses in this pool are not automatically assigned to Kubernetes Services. If `true`, an IP address in this pool is used only when it is specified explicitly by a service. You can omit this field, its default value is `false`. | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.mode` Required. String. Specifies the load-balancing mode. In `bundled` mode, Google Distributed Cloud installs a load balancer on load balancer nodes during cluster creation. In `manual` mode, the cluster relies on a manually configured external load balancer. For more information, see [Overview of load balancers](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/load-balance.md.txt). Allowed values: `bundled` \| `manual` | Cluster resource | Required | Immutable |
| ##### `loadBalancer.type` Optional. String. Specifies the type of bundled load-balancing used, Layer 2 or Border Gateway Protocol (BGP). If you are using the [standard, bundled load balancing](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/bundled-lb.md.txt), set `type` to `layer2`. If you are using [bundled load balancing with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt), set `type` to `bgp`. If you don't set `type`, it defaults to `layer2`. Allowed values: `layer2` \| `bgp` | Cluster resource | Optional | Immutable |
| ##### `loadBalancer.nodePoolSpec` Optional. Use this section to configure a load balancer node pool. The nodes you specify are part of the Kubernetes cluster and run regular workloads and load balancers. If you don't specify a node pool, then the control plane nodes are used for load balancing. This section applies only when the load-balancing mode is set to `bundled`. > [!IMPORTANT] > **Important:** If you create your cluster without specifying a `loadBalancer.nodePoolSpec`, you can't add the `nodePoolSpec` later. For clusters configured with a `loadBalancer.nodePoolSpec`, you can update the `nodePoolSpec` at any time. | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.nodePoolSpec.nodes` This section contains an array of IP addresses for the nodes in your load-balancer node pool. | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.nodePoolSpec.nodes.address` Optional. String (IPv4 address). IP address of a node. | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.ports.controlPlaneLBPort` Number. The destination port used for traffic sent to the Kubernetes control plane (the Kubernetes API servers). | Cluster resource | Required | Immutable |
| ##### `loadBalancer.vips.controlPlaneVIP` Required. Specifies the virtual IP address (VIP) to connect to the Kubernetes API server. This address must not fall within the range of any IP addresses used for load balancer address pools, [`loadBalancer.addressPools.addresses`](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/reference/cluster-config-ref.md.txt#loadbalancer-addresspools-addresses). | Cluster resource | Required | Immutable |
| ##### `loadBalancer.vips.ingressVIP` Optional. String (IPv4 address). The IP address that you have chosen to configure on the load balancer for ingress traffic. | Cluster resource | Optional | Immutable |
| ##### `loadBalancer.localASN` Optional. String. Specifies the autonomous system number (ASN) for the cluster being created. This field is used when setting up the bundled load-balancing solution that uses border gateway protocol (BGP). For more information, see [Configure bundled load balancers with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt). | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.bgpPeers` Optional. Object (list of mappings). This section specifies one or more border gateway protocol (BGP) peers from your (external to the cluster) local network. You specify BGP peers when you set up control plane load balancing part of the bundled load-balancing solution that uses BGP. Each peer is specified with a mapping, consisting of an IP address, an autonomous system number (ASN), and, optionally, a list of one or more IP addresses for control plane nodes. The BGP-peering configuration for control plane load balancing can't be updated after the cluster has been created. For example: ```yaml loadBalancer: mode: bundled type: bgp localASN: 65001 bgpPeers: - ip: 10.0.1.254 asn: 65002 controlPlaneNodes: - 10.0.1.10 - 10.0.1.11 - ip: 10.0.2.254 asn: 65002 controlPlaneNodes: - 10.0.2.10 ``` For more information, see [Configure bundled load balancers with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt). | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.bgpPeers.ip` Optional. String (IPv4 address). The IP address of an external peering device from your local network. For more information, see [Configure bundled load balancers with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt). | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.bgpPeers.asn` Optional. String. The autonomous system number (ASN) for the network that contains the external peer device. Specify an ASN for every BGP peer you set up for control plane load balancing, when you set up the bundled load-balancing solution that uses BGP. For more information, see [Configure bundled load balancers with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt). | Cluster resource | Optional | Mutable |
| ##### `loadBalancer.bgpPeers.controlPlaneNodes` Optional. Array of IP (IPv4) addresses. One or more IP addresses for control plane nodes that connect to the external BGP peer, when you set up the bundled load-balancing solution that uses BGP. If you don't specify any control plane nodes, all control plane nodes will connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions. For more information, see [Configure bundled load balancers with BGP](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/lb-bundled-bgp.md.txt). | Cluster resource | Optional | Mutable |
| ##### `maintenanceBlocks.cidrBlocks` Optional. Single IPv4 address or a range of IPv4 addresses. Specify the IP addresses for the node machines you want to put into maintenance mode. For more information, see [Put nodes into maintenance mode](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/maintenance-mode.md.txt). For example: ```yaml maintenanceBlocks: cidrBlocks: - 192.168.1.200  # Single machine - 192.168.1.100-192.168.1.109  # Ten machines ``` | Cluster resource | Optional | Mutable |
| ##### `nodeAccess.loginUser` Optional. String. Specify the non-root username you want to use for passwordless SUDO capability access to the node machines in your cluster. Your SSH key, [`sshPrivateKeyPath`](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/reference/cluster-config-ref.md.txt#sshprivatekeypath), must work for the specified user. The cluster create and update operations check that node machines can be accessed with the specified user and SSH key. | Cluster resource | Optional | Mutable |
| ##### `osEnvironmentConfig.addPackageRepo` Optional. Boolean (`true`\|`false`). Specifies whether adding package repository when initializing bare metal machines. | Cluster resource | Optional | Immutable |
| ##### `nodeConfig` This section contains settings for cluster node configuration. | Cluster resource | Optional | Mutable (upgrade only) |
| ##### `nodeConfig.containerRuntime` (deprecated) Deprecated. As of release 1.13.0, Google Distributed Cloud supports `containerd` only as the container runtime. The `containerRuntime` field is deprecated and has been removed from the generated cluster configuration file. For Google Distributed Cloud versions 1.13.0 and higher, if your cluster configuration file contains this field, the value must be `containerd`. | Cluster resource | Optional | Mutable (upgrade only) |
| ##### `nodeConfig.podDensity` This section specifies the pod density configuration. | Cluster resource | Optional | Immutable |
| ##### `nodeConfig.podDensity.maxPodsPerNode` Optional. Integer. Specifies the maximum number of pods that can be run on a single node. For self-managed clusters, allowable values for `maxPodsPerNode` are `32`--`250` for high-availability (HA) clusters and `64`--`250` for non-HA clusters. For user clusters, allowable values for `maxPodsPerNode` are `32`--`250`. The default value if unspecified is `110`. Once the cluster is created, this value can't be updated. Kubernetes assigns a [Classless Inter-Domain Routing (CIDR) block](https://tools.ietf.org/html/rfc1918) to each node so that each pod can have a unique IP address. The size of the CIDR block corresponds to the maximum number of pods per node. For more information about setting the maximum number of pods per node, see [Pod networking](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/concepts/network-reqs.md.txt#pod_networking). | Cluster resource | Optional | Immutable |
| ##### `periodicHealthCheck` This section holds configuration information for periodic health checks. In the Cluster resource, the only setting available for periodic health checks is the `enable` field. For more information, see [Periodic health checks](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/troubleshooting/healthchecks.md.txt#health_period). | Cluster resource | Optional | Mutable |
| ##### `periodicHealthCheck.enable` Optional. Boolean (`true`\|`false`). Enable or disable periodic health checks for your cluster. Periodic health checks are enabled by default on all clusters. You can disable periodic health checks for a cluster by setting the `periodicHealthCheck.enable` field to `false`. For more information, see [Disable periodic health checks](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/troubleshooting/healthchecks.md.txt#health_period_disable) | Cluster resource | Optional | Mutable |
| ##### `profile` Optional. String. When `profile` is set to `edge` for a standalone cluster, it minimizes the resource consumption of the cluster. The edge profile is available for standalone clusters only. The edge profile has reduced system resource requirements and is recommended for edge devices with restrictive resource constraints. For hardware requirements associated with the edge profile, see [Resource requirements for standalone clusters using the edge profile](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/hardware#resource_requirements_for_standalone_clusters_using_the_edge_profile). | Cluster resource | Optional | Immutable |
| ##### `proxy` If your network is behind a proxy server, fill in this section. Otherwise, remove this section. | Cluster resource | Optional | Mutable |
| ##### `proxy.noProxy` String. A comma-separated list of IP addresses, IP address ranges, host names, and domain names that shouldn't go through the proxy server. When Google Distributed Cloud sends a request to one of these addresses, hosts, or domains, the request is sent directly. | Cluster resource | Optional | Immutable |
| ##### `proxy.url` String. The HTTP address of your proxy server. Include the port number even if it's the same as the scheme's default port. For example: ```yaml proxy: url: "http://my-proxy.example.local:80" noProxy: "10.151.222.0/24, my-host.example.local,10.151.2.1" ``` | Cluster resource | Optional | Immutable |
| ##### `clusterSecurity` This section specifies the cluster security-related settings. | Cluster resource | Optional | Mutable |
| ##### `clusterSecurity.enableSeccomp` ([Preview](https://cloud.google.com/products/#product-launch-stages)) Optional. Boolean (`true`\|`false`). Enable/Disable cluster-wide \`seccomp\`. When this field is disabled, containers without a \`seccomp\` profile in the cluster configuration file run unconfined. When this field is enabled, those same containers are secured using the container runtime's default \`seccomp\` profile. This feature is enabled by default. After cluster creation, this field can be toggled only during upgrade. For more information, see [Use `seccomp` to restrict containers](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/hardening-your-cluster.md.txt#use_seccomp_to_restrict_containers). | Cluster resource | Optional | Mutable (upgrade only) |
| ##### `clusterSecurity.enableRootlessContainers` Optional. Boolean (`true`\|`false`). Enable/Disable rootless bare metal system containers. When this field is enabled, bare metal system containers run as a non-root user with a user ID in the range 2000-5000. When disabled, bare metal system containers run as a root user. By default, this feature is enabled. Turning off this feature is highly discouraged, because running containers as a root user poses a security risk. After cluster creation, this field can be toggled only during upgrade. For more information, see [Don't run containers as root user](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/hardening-your-cluster.md.txt#dont_run_containers_as_root_user). | Cluster resource | Optional | Mutable (upgrade only) |
| ##### `clusterSecurity.authorization` Optional. Authorization configures user access to the cluster. | Cluster resource | Optional | Mutable |
| ##### `clusterSecurity.authorization.clusterAdmin` Optional. Specifies cluster administrator for this cluster. | Cluster resource | Optional | Mutable |
| ##### `clusterSecurity.authorization.clusterAdmin.gcpAccounts` Optional. The `gcpAccounts` field specifies a list of accounts that are granted the Kubernetes role-based access control (RBAC) role `clusterrole/cluster-admin`. Accounts with this role have full access to every resource in the cluster in all namespaces. This field also configures the RBAC policies that let the specified accounts use the [connect gateway](https://docs.cloud.google.com/anthos/multicluster-management/gateway) to run `kubectl` commands against the cluster. This is convenient if you have multiple clusters to manage, particularly in a hybrid environment with both GKE and on-premises clusters. These RBAC policies also let users sign in to the Google Cloud console using their Google identity, if they have the required [Identity and Access Management roles to access the console](https://docs.cloud.google.com/anthos/multicluster-management/gateway/setup#grant_roles_for_access_through_the_cloud_console). This field takes an array of account names. User accounts and service accounts are supported. For users, you specify their Google Cloud account email addresses. For service accounts, specify the email addresses in the following format: `SERVICE_ACCOUNT@PROJECT_ID.iam.gserviceaccount.com`. For example: ``` ... clusterSecurity: authorization: clusterAdmin: gcpAccounts: - alex@example.com - hao@example.com - my-sa@example-project-123.iam.gserviceaccount.com ... ``` When updating a cluster to add an account, be sure to include all accounts in the list (both existing and new accounts) because the update command overwrites the list with what you specify in the update. This field only applies to clusters that can run workloads. For example, you can't specify `gcpAccounts` for admin clusters. | Cluster resource | Optional | Mutable |
| ##### `storage.lvpNodeMounts.path` Required. String. Use the `path` field to specify the host machine path where mounted disks can be discovered. A local PersistentVolume (PV) is created for each mount. The default path is `/mnt/localpv-share`. For instructions for configuring your node mounts, see [Configure LVP node mounts](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-local-storage.md.txt#configure_lvp_node_mounts). | Cluster resource | Required | Immutable |
| ##### `storage` This section contains settings for cluster storage. | Cluster resource | Required | Immutable |
| ##### `storage.lvpNodeMounts` This section specifies the configuration (path) for local persistent volumes backed by mounted disks. You must format and mount these disks yourself. You can do this task before or after cluster creation. For more information, see [LVP node mounts](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-local-storage.md.txt#lvp_node_mounts). | Cluster resource | Required | Immutable |
| ##### `storage.lvpShare` This section specifies the configuration for local persistent volumes backed by subdirectories in a shared file system. These subdirectories are automatically created during cluster creation. For more information, see [LVP share](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-local-storage.md.txt#lvp_share). | Cluster resource | Required | Immutable |
| ##### `storage.lvpShare.path` Required. String. Use the `path` field to specify the host machine path where subdirectories can be created. A local PersistentVolume (PV) is created for each subdirectory. For instructions to configure your LVP share, see [Configuring an LVP share](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-local-storage.md.txt#configuring_an_lvp_share). | Cluster resource | Required | Immutable |
| ##### `storage.lvpShare.numPVUnderSharedPath` Required. String. Specify the number of subdirectories to create under `lvpShare.path`. The default value is `5`. For instructions to configure your LVP share, see [Configuring an LVP share](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-local-storage.md.txt#configuring_an_lvp_share). | Cluster resource | Required | Immutable |
| ##### `storage.lvpShare.storageClassName` Required. String. Specify the StorageClass to use to create persistent volumes. The StorageClass is created during cluster creation. The default value is `local-shared`. For instructions to configure your LVP share, see [Configuring an LVP share](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-local-storage.md.txt#configuring_an_lvp_share). | Cluster resource | Optional | Immutable |
| ##### `type` Required. String. Specifies the type of cluster. The standard deployment model consists of a single admin cluster and one or more user clusters, which are managed by the admin cluster. Google Distributed Cloud supports the following types of clusters: - Admin - cluster used to manage user clusters. - User - cluster used to run workloads. - Hybrid - single cluster for both admin and workloads, that can also manage user clusters. - Standalone - single cluster that can administer itself, and that can also run workloads, but can't create or manage other user clusters. Cluster type is specified at cluster creation and can't be changed for updates or upgrades. For more information about how to create a cluster, see [Creating clusters: overview](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/creating-clusters/create-clusters-overview.md.txt). Allowed values: `admin` \| `user` \| `hybrid` \| `standalone` This value can't be modified for existing clusters. | Cluster resource | Required | Immutable |
| ##### `name` Required. String. Typically, the namespace name uses a pattern of `cluster-CLUSTER_NAME`, but the `cluster-` prefix is not strictly required since Google Distributed Cloud release 1.7.2. This value can't be modified for existing clusters. | Namespace resource | Required | Immutable |
| ##### `clusterName` String. Required. The name of the cluster to which you are adding the node pool. Create the node pool resource in the same namespace as the associated cluster and reference the cluster name in this field. For more information, see [Add and remove node pools in a cluster](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/how-to/add-remove-node-pools.md.txt). For example: ```yaml apiVersion: baremetal.cluster.gke.io/v1 kind: NodePool metadata: name: node-pool-new namespace: cluster-my-cluster spec: clusterName: my-cluster nodes: - address:  10.200.0.10 - address:  10.200.0.11 - address:  10.200.0.12 ``` | NodePool resource | Required | Immutable |
| ##### `nodes` Optional. Array of IP (IPv4) addresses. This defines the node pool for your worker nodes. | NodePool resource | Optional | Mutable |
| ##### `nodes.address` Optional. String (IPv4 address). One or more IP addresses for the nodes that make your pool for worker nodes. | NodePool resource | Optional | Mutable |
| ##### `taints` Optional. Object. A node taint lets you mark a node so that the scheduler avoids or prevents using it for certain pods. A taint consists of a key-value pair and an associated effect. The `key` and `value` values are strings you use to identify the taint and the `effect` value specifies how pods are handled for the node. The `taints` object can have multiple taints. The `effect` field can take one of the following values: - `NoSchedule` - no pod is able to schedule onto the node unless it has a matching toleration. - `PreferNoSchedule` - the system avoids placing a pod that does not tolerate the taint on the node, but it is not required. - `NoExecute` - pods that don't tolerate the taint are evicted immediately, and pods that do tolerate the taint are never evicted. For Google Distributed Cloud, taints are reconciled to the nodes of the node pool unless the `baremetal.cluster.gke.io/label-taint-no-sync` annotation is applied to the cluster. For more information about taints, see [Taints and Tolerations](https://kubernetes.io/docs/concepts/scheduling-eviction/taint-and-toleration/). For example: ```yaml taints: - key: status value: testpool effect: NoSchedule ``` | NodePool resource | Optional | Mutable |
| ##### `labels` Optional. Mapping (key-value pairs). Labels are reconciled to the nodes of the node pool unless the `baremetal.cluster.gke.io/label-taint-no-sync` annotation is applied to the cluster. For more information about labels, see [Labels and Selectors](https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/). | NodePool resource | Optional | Mutable |
| ##### `registryMirrors` Optional. Use this section to specify a registry mirror to use for installing clusters, instead of Container Registry (`gcr.io`). For more information about using a registry mirror, see [Installing Google Distributed Cloud using a registry mirror](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/registry-mirror.md.txt). > [!NOTE] > As a convenience, `bmctl` accepts the `registryMirrors` fields outside of the cluster spec, like the credentials key-value pairs. For an example, see the [registry mirror > setup instructions](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/registry-mirror.md.txt). For example: ```yaml registryMirrors: - endpoint: https://172.18.0.20:5000 caCertPath: /root/ca.crt pullCredentialConfigPath: /root/.docker/config.json hosts: - somehost.io - otherhost.io ``` | Registry mirror | Optional | Mutable |
| ##### `registryMirrors.endpoint` String. The endpoint of the mirror, consisting of the registry server IP address and port number. Optionally, you can use your own namespace in your registry server instead of the root namespace. Without a namespace, the endpoint format is `REGISTRY_IP:PORT`. When you use a namespace, the endpoint format is `REGISTRY_IP:PORT/v2/NAMESPACE`. The `/v2` is required when specifying a namespace. The `endpoint` field is required when you specify a registry mirror. You can specify multiple mirrors/endpoints. For example: ```yaml - endpoint: https://172.18.0.20:5000/v2/test-namespace ``` | Registry mirror | Optional | Mutable |
| ##### `registryMirrors.caCertPath` Optional. String. Path of the CA cert file (server root CA) if your registry server uses a private TLS certificate. If your local registry doesn't require a private TLS certificate, then you can omit this field. | Registry mirror | Optional | Mutable |
| ##### `registryMirrors.pullCredentialConfigPath` Optional. String. Path to the [Docker CLI configuration file](https://docs.docker.com/engine/reference/commandline/cli/#configjson-properties), `config.json`. Docker saves authentication settings in the configuration file. This field applies to the use of registry mirrors only. If your registry server doesn't require a Docker configuration file for authentication, then you can omit this field. For example: ```yaml registryMirrors: - endpoint: https://172.18.0.20:5000 caCertPath: /root/ca.crt pullCredentialConfigPath: /root/.docker/config.json ``` | Registry mirror | Optional | Mutable |
| ##### `registryMirrors.hosts` Optional. An array of domain names for hosts that are mirrored locally for the given registry mirror (`endpoint`). When the container runtime encounters pull requests for images from a specified host, it checks the local registry mirror first. For additional information, see [Create clusters from the registry mirror](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/registry-mirror.md.txt#create_clusters_from_the_registry_mirror). For example: ```yaml registryMirrors: - endpoint: https://172.18.0.20:5000 caCertPath: /root/ca.crt pullCredentialConfigPath: /root/.docker/config.json hosts: - somehost.io - otherhost.io ``` | Registry mirror | Optional | Mutable |
| ##### Credentials The cluster configuration file generated by `bmctl` for Google Distributed Cloud includes fields for specifying paths to credentials and keys files in the local file system. These credentials and keys needed to connect your clusters to each other and to your Google Cloud project. > [!NOTE] > These key-value pair fields are not valid elements of a Kubernetes cluster custom resource. This format is only understood by `bmctl` and not by standard Kubernetes tools. If you want to use `kubectl` to apply changes to your cluster, remove the credentials and keys fields. For example: ```yaml gcrKeyPath: bmctl-workspace/.sa-keys/my-gcp-project-anthos-baremetal-gcr.json sshPrivateKeyPath: /home/root-user/.ssh/id_rsa gkeConnectAgentServiceAccountKeyPath: bmctl-workspace/.sa-keys/my-gcp-project-anthos-baremetal-connect.json gkeConnectRegisterServiceAccountKeyPath: bmctl-workspace/.sa-keys/my-gcp-project-anthos-baremetal-register.json cloudOperationsServiceAccountKeyPath: bmctl-workspace/.sa-keys/my-gcp-project-anthos-baremetal-cloud-ops.json ``` | Credentials | Optional | Mutable |
| ##### `gcrKeyPath` String. The path to the Container Registry service account key. The [Container Registry service account](https://docs.cloud.google.com/container-registry/docs/gcr-service-account) is a service agent that acts on behalf of Container Registry when interacting with Google Cloud services. | Credentials | Optional | Mutable |
| ##### `sshPrivateKeyPath` String. The path to the SSH private key. SSH is required for Node access. | Credentials | Optional | Mutable |
| ##### `gkeConnectAgentServiceAccountKeyPath` String. The path to the agent service account key. Google Distributed Cloud uses this service account to maintain a connection between Google Distributed Cloud and Google Cloud. For instructions on configuring this service account, see [Configuring service accounts for use with Connect](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-sa.md.txt#connect-sa). | Credentials | Optional | Mutable |
| ##### `gkeConnectRegisterServiceAccountKeyPath` String. The path to the registration service account key. Google Distributed Cloud uses this service account to register your user clusters with Google Cloud. For instructions on configuring this service account, see [Configuring service accounts for use with Connect](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-sa.md.txt#connect-sa). | Credentials | Optional | Mutable |
| ##### `cloudOperationsServiceAccountKeyPath` String. The path to the operations service account key. Google Distributed Cloud uses the operations service account to authenticate with Google Cloud Observability for access to the Logging API and the Monitoring API. For instructions on configuring this service account, see [Configuring a service account for use with Logging and Monitoring](https://docs.cloud.google.com/anthos/clusters/docs/bare-metal/1.14/installing/configure-sa.md.txt#logmon-config-sa). | Credentials | Optional | Mutable |
| ##### `ipv4` Defines the configuration for the IPv4 CIDR range. At least one of the `ipv4` or `ipv6` fields must be provided for the `ClusterCidrConfig` resource. | ClusterCIDRConfig resource | Optional | Immutable |
| ##### `ipv4.cidr` String. Sets the IPv4 node CIDR block. Nodes can only have one range from each family. This CIDR block must match the pod CIDR described in the `Cluster` resource. For example: ```yaml ipv4: cidr: "10.1.0.0/16" ``` | ClusterCIDRConfig resource | Required | Immutable |
| ##### `ipv4.perNodeMaskSize` Integer. Defines the mask size for the node IPv4 CIDR block. For example, the value `24` translates to netmask `/24`. Ensure that the node's CIDR block netmask is larger than the maximum amount of pods the kubelet can schedule, which is defined in the kubelet's `--max-pods` flag. | ClusterCIDRConfig resource | Required | Immutable |
| ##### `ipv6` Defines the configuration for the IPv6 CIDR range. At least one of the `ipv4` or `ipv6` fields must be provided for the `ClusterCidrConfig` resource. | ClusterCIDRConfig resource | Optional | Immutable |
| ##### `ipv6.cidr` String. Sets the IPv6 node CIDR block. Nodes can only have one range from each family. For example: ```yaml ipv6: cidr: "2620:0:1000:2631:3:10:3:0/112" ``` | ClusterCIDRConfig resource | Required | Immutable |
| ##### `ipv6.perNodeMaskSize` Integer. Defines the mask size for the node IPv6 CIDR block. For example, the value `120` translates to netmask `/120`. Ensure that the node's CIDR block netmask is larger than the maximum amount of pods the kubelet can schedule, which is defined in the kubelet's `--max-pods` flag. | ClusterCIDRConfig resource | Required | Immutable |
| ##### `nodeSelector.matchLabels` Defines which nodes the CIDR configuration is applicable to. An empty node selector functions as a default that applies to all nodes. For example: ```yaml nodeSelector: matchLabels: baremetal.cluster.gke.io/node-pool: "workers" ``` | ClusterCIDRConfig resource | Optional | Mutable |