BareMetalCluster

Resource that represents a bare metal user cluster.

Cloud-NativeContainersGoogle CloudKubernetesManaged ServiceContainer Orchestration

Properties

Name Type Description
annotations object Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments:
status object Output only. Detailed cluster status.
reconciling boolean Output only. If set, there are currently changes in flight to the bare metal user cluster.
fleet object Output only. Fleet configuration for the cluster.
osEnvironmentConfig object OS environment related configurations.
bareMetalVersion string Required. The Anthos clusters on bare metal version for your user cluster.
maintenanceStatus object Output only. Status of on-going maintenance tasks.
storage object Required. Storage configuration.
state string Output only. The current state of the bare metal user cluster.
uid string Output only. The unique identifier of the bare metal user cluster.
createTime string Output only. The time when the bare metal user cluster was created.
adminClusterName string Output only. The resource name of the bare metal admin cluster managing this user cluster.
nodeConfig object Workload node configuration.
nodeAccessConfig object Node access related configurations.
loadBalancer object Required. Load balancer configuration.
clusterOperations object Cluster operations configuration.
name string Immutable. The bare metal user cluster resource name.
description string A human readable description of this bare metal user cluster.
etag string Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. A
localNamespace string Output only. The namespace of the cluster.
deleteTime string Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty
localName string Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API
endpoint string Output only. The IP address of the bare metal user cluster's API server.
adminClusterMembership string Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.
updateTime string Output only. The time when the bare metal user cluster was last updated.
binaryAuthorization object Binary Authorization related configurations.
controlPlane object Required. Control plane configuration.
upgradePolicy object The cluster upgrade policy.
maintenanceConfig object Maintenance configuration.
proxy object Proxy configuration.
securityConfig object Security related setting configuration.
networkConfig object Required. Network configuration.
validationCheck object Output only. The result of the preflight check.
View JSON Schema on GitHub

JSON Schema

google-kubernetes-engine-bare-metal-cluster-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/google-kubernetes-engine/json-schema/google-kubernetes-engine-bare-metal-cluster-schema.json",
  "title": "BareMetalCluster",
  "description": "Resource that represents a bare metal user cluster.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/google-kubernetes-engine-gkeonprem-projects-api-openapi.yml#/components/schemas/BareMetalCluster",
  "properties": {
    "annotations": {
      "description": "Annotations on the bare metal user cluster. This field has the same restrictions as Kubernetes annotations. The total size of all keys and values combined is limited to 256k. Key can have 2 segments: prefix (optional) and name (required), separated by a slash (/). Prefix must be a DNS subdomain. Name must be 63 characters or less, begin and end with alphanumerics, with dashes (-), underscores (_), dots (.), and alphanumerics between.",
      "additionalProperties": {
        "type": "string"
      },
      "type": "object"
    },
    "status": {
      "$ref": "#/$defs/ResourceStatus",
      "description": "Output only. Detailed cluster status."
    },
    "reconciling": {
      "readOnly": true,
      "type": "boolean",
      "description": "Output only. If set, there are currently changes in flight to the bare metal user cluster."
    },
    "fleet": {
      "$ref": "#/$defs/Fleet",
      "description": "Output only. Fleet configuration for the cluster."
    },
    "osEnvironmentConfig": {
      "$ref": "#/$defs/BareMetalOsEnvironmentConfig",
      "description": "OS environment related configurations."
    },
    "bareMetalVersion": {
      "type": "string",
      "description": "Required. The Anthos clusters on bare metal version for your user cluster."
    },
    "maintenanceStatus": {
      "$ref": "#/$defs/BareMetalMaintenanceStatus",
      "description": "Output only. Status of on-going maintenance tasks."
    },
    "storage": {
      "$ref": "#/$defs/BareMetalStorageConfig",
      "description": "Required. Storage configuration."
    },
    "state": {
      "description": "Output only. The current state of the bare metal user cluster.",
      "enum": [
        "STATE_UNSPECIFIED",
        "PROVISIONING",
        "RUNNING",
        "RECONCILING",
        "STOPPING",
        "ERROR",
        "DEGRADED"
      ],
      "readOnly": true,
      "type": "string"
    },
    "uid": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. The unique identifier of the bare metal user cluster."
    },
    "createTime": {
      "readOnly": true,
      "type": "string",
      "format": "google-datetime",
      "description": "Output only. The time when the bare metal user cluster was created."
    },
    "adminClusterName": {
      "description": "Output only. The resource name of the bare metal admin cluster managing this user cluster.",
      "type": "string",
      "readOnly": true
    },
    "nodeConfig": {
      "$ref": "#/$defs/BareMetalWorkloadNodeConfig",
      "description": "Workload node configuration."
    },
    "nodeAccessConfig": {
      "$ref": "#/$defs/BareMetalNodeAccessConfig",
      "description": "Node access related configurations."
    },
    "loadBalancer": {
      "$ref": "#/$defs/BareMetalLoadBalancerConfig",
      "description": "Required. Load balancer configuration."
    },
    "clusterOperations": {
      "$ref": "#/$defs/BareMetalClusterOperationsConfig",
      "description": "Cluster operations configuration."
    },
    "name": {
      "description": "Immutable. The bare metal user cluster resource name.",
      "type": "string"
    },
    "description": {
      "description": "A human readable description of this bare metal user cluster.",
      "type": "string"
    },
    "etag": {
      "readOnly": true,
      "description": "Output only. This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding. Allows clients to perform consistent read-modify-writes through optimistic concurrency control.",
      "type": "string"
    },
    "localNamespace": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. The namespace of the cluster."
    },
    "deleteTime": {
      "type": "string",
      "description": "Output only. The time when the bare metal user cluster was deleted. If the resource is not deleted, this must be empty",
      "format": "google-datetime",
      "readOnly": true
    },
    "localName": {
      "type": "string",
      "readOnly": true,
      "description": "Output only. The object name of the bare metal user cluster custom resource on the associated admin cluster. This field is used to support conflicting names when enrolling existing clusters to the API. When used as a part of cluster enrollment, this field will differ from the name in the resource name. For new clusters, this field will match the user provided cluster name and be visible in the last component of the resource name. It is not modifiable. When the local name and cluster name differ, the local name is used in the admin cluster controller logs. You use the cluster name when accessing the cluster using bmctl and kubectl."
    },
    "endpoint": {
      "readOnly": true,
      "type": "string",
      "description": "Output only. The IP address of the bare metal user cluster's API server."
    },
    "adminClusterMembership": {
      "description": "Required. The admin cluster this bare metal user cluster belongs to. This is the full resource name of the admin cluster's fleet membership.",
      "type": "string"
    },
    "updateTime": {
      "readOnly": true,
      "format": "google-datetime",
      "type": "string",
      "description": "Output only. The time when the bare metal user cluster was last updated."
    },
    "binaryAuthorization": {
      "$ref": "#/$defs/BinaryAuthorization",
      "description": "Binary Authorization related configurations."
    },
    "controlPlane": {
      "$ref": "#/$defs/BareMetalControlPlaneConfig",
      "description": "Required. Control plane configuration."
    },
    "upgradePolicy": {
      "$ref": "#/$defs/BareMetalClusterUpgradePolicy",
      "description": "The cluster upgrade policy."
    },
    "maintenanceConfig": {
      "$ref": "#/$defs/BareMetalMaintenanceConfig",
      "description": "Maintenance configuration."
    },
    "proxy": {
      "$ref": "#/$defs/BareMetalProxyConfig",
      "description": "Proxy configuration."
    },
    "securityConfig": {
      "$ref": "#/$defs/BareMetalSecurityConfig",
      "description": "Security related setting configuration."
    },
    "networkConfig": {
      "$ref": "#/$defs/BareMetalNetworkConfig",
      "description": "Required. Network configuration."
    },
    "validationCheck": {
      "$ref": "#/$defs/ValidationCheck",
      "description": "Output only. The result of the preflight check."
    }
  },
  "type": "object",
  "$defs": {
    "Authorization": {
      "description": "Authorization defines the On-Prem cluster authorization configuration to bootstrap onto the admin cluster.",
      "properties": {
        "adminUsers": {
          "items": {
            "$ref": "#/$defs/ClusterUser"
          },
          "description": "For VMware and bare metal user clusters, users will be granted the cluster-admin role on the cluster, which provides full administrative access to the cluster. For bare metal admin clusters, users will be granted the cluster-view role, which limits users to read-only access.",
          "type": "array"
        }
      },
      "type": "object"
    },
    "BareMetalApiServerArgument": {
      "description": "Represents an arg name->value pair. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).",
      "properties": {
        "value": {
          "type": "string",
          "description": "Required. The value of the arg as it will be passed to the API Server command line."
        },
        "argument": {
          "type": "string",
          "description": "Required. The argument name as it appears on the API Server command line, make sure to remove the leading dashes."
        }
      },
      "type": "object"
    },
    "BareMetalBgpLbConfig": {
      "description": "BareMetalBgpLbConfig represents configuration parameters for a Border Gateway Protocol (BGP) load balancer.",
      "properties": {
        "loadBalancerNodePoolConfig": {
          "$ref": "#/$defs/BareMetalLoadBalancerNodePoolConfig",
          "description": "Specifies the node pool running data plane load balancing. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used for data plane load balancing."
        },
        "asn": {
          "description": "Required. BGP autonomous system number (ASN) of the cluster. This field can be updated after cluster creation.",
          "type": "string",
          "format": "int64"
        },
        "bgpPeerConfigs": {
          "description": "Required. The list of BGP peers that the cluster will connect to. At least one peer must be configured for each control plane node. Control plane nodes will connect to these peers to advertise the control plane VIP. The Services load balancer also uses these peers by default. This field can be updated after cluster creation.",
          "items": {
            "$ref": "#/$defs/BareMetalBgpPeerConfig"
          },
          "type": "array"
        },
        "addressPools": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BareMetalLoadBalancerAddressPool"
          },
          "description": "Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools."
        }
      },
      "type": "object"
    },
    "BareMetalBgpPeerConfig": {
      "properties": {
        "asn": {
          "type": "string",
          "description": "Required. BGP autonomous system number (ASN) for the network that contains the external peer device.",
          "format": "int64"
        },
        "ipAddress": {
          "description": "Required. The IP address of the external peer device.",
          "type": "string"
        },
        "controlPlaneNodes": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "The IP address of the control plane node that connects to the external peer. If you don't specify any control plane nodes, all control plane nodes can connect to the external peer. If you specify one or more IP addresses, only the nodes specified participate in peering sessions."
        }
      },
      "description": "BareMetalBgpPeerConfig represents configuration parameters for a Border Gateway Protocol (BGP) peer.",
      "type": "object"
    },
    "BareMetalClusterOperationsConfig": {
      "description": "Specifies the bare metal user cluster's observability infrastructure.",
      "type": "object",
      "properties": {
        "enableApplicationLogs": {
          "type": "boolean",
          "description": "Whether collection of application logs/metrics should be enabled (in addition to system logs/metrics)."
        }
      }
    },
    "BareMetalClusterUpgradePolicy": {
      "description": "BareMetalClusterUpgradePolicy defines the cluster upgrade policy.",
      "properties": {
        "pause": {
          "type": "boolean",
          "readOnly": true,
          "description": "Output only. Pause is used to show the upgrade pause status. It's view only for now."
        },
        "policy": {
          "description": "Specifies which upgrade policy to use.",
          "type": "string",
          "enum": [
            "NODE_POOL_POLICY_UNSPECIFIED",
            "SERIAL",
            "CONCURRENT"
          ]
        }
      },
      "type": "object"
    },
    "BareMetalControlPlaneConfig": {
      "description": "Specifies the control plane configuration.",
      "properties": {
        "controlPlaneNodePoolConfig": {
          "$ref": "#/$defs/BareMetalControlPlaneNodePoolConfig",
          "description": "Required. Configures the node pool running the control plane."
        },
        "apiServerArgs": {
          "description": "Customizes the default API server args. Only a subset of customized flags are supported. For the exact format, refer to the [API server documentation](https://kubernetes.io/docs/reference/command-line-tools-reference/kube-apiserver/).",
          "type": "array",
          "items": {
            "$ref": "#/$defs/BareMetalApiServerArgument"
          }
        }
      },
      "type": "object"
    },
    "BareMetalControlPlaneNodePoolConfig": {
      "type": "object",
      "properties": {
        "nodePoolConfig": {
          "$ref": "#/$defs/BareMetalNodePoolConfig",
          "description": "Required. The generic configuration for a node pool running the control plane."
        }
      },
      "description": "Specifies the control plane node pool configuration."
    },
    "BareMetalDrainedMachine": {
      "type": "object",
      "properties": {
        "nodeIp": {
          "description": "Drained machine IP address.",
          "type": "string"
        }
      },
      "description": "Represents a machine that is currently drained."
    },
    "BareMetalDrainingMachine": {
      "type": "object",
      "properties": {
        "podCount": {
          "type": "integer",
          "format": "int32",
          "description": "The count of pods yet to drain."
        },
        "nodeIp": {
          "description": "Draining machine IP address.",
          "type": "string"
        }
      },
      "description": "Represents a machine that is currently draining."
    },
    "BareMetalIslandModeCidrConfig": {
      "properties": {
        "serviceAddressCidrBlocks": {
          "description": "Required. All services in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field is mutable after creation starting with version 1.15.",
          "type": "array",
          "items": {
            "type": "string"
          }
        },
        "podAddressCidrBlocks": {
          "description": "Required. All pods in the cluster are assigned an RFC1918 IPv4 address from these ranges. This field cannot be changed after creation.",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "description": "Specifies the cluster CIDR configuration while running in island mode.",
      "type": "object"
    },
    "BareMetalKubeletConfig": {
      "properties": {
        "registryPullQps": {
          "format": "int32",
          "description": "The limit of registry pulls per second. Setting this value to 0 means no limit. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 5.",
          "type": "integer"
        },
        "registryBurst": {
          "type": "integer",
          "description": "The maximum size of bursty pulls, temporarily allows pulls to burst to this number, while still not exceeding registry_pull_qps. The value must not be a negative number. Updating this field may impact scalability by changing the amount of traffic produced by image pulls. Defaults to 10.",
          "format": "int32"
        },
        "serializeImagePullsDisabled": {
          "description": "Prevents the Kubelet from pulling multiple images at a time. We recommend *not* changing the default value on nodes that run docker daemon with version < 1.9 or an Another Union File System (Aufs) storage backend. Issue https://github.com/kubernetes/kubernetes/issues/10959 has more details.",
          "type": "boolean"
        }
      },
      "description": "KubeletConfig defines the modifiable kubelet configurations for bare metal machines. Note: this list includes fields supported in GKE (see https://cloud.google.com/kubernetes-engine/docs/how-to/node-system-config#kubelet-options).",
      "type": "object"
    },
    "BareMetalLoadBalancerAddressPool": {
      "properties": {
        "manualAssign": {
          "description": "If true, prevent IP addresses from being automatically assigned.",
          "type": "boolean"
        },
        "avoidBuggyIps": {
          "description": "If true, avoid using IPs ending in .0 or .255. This avoids buggy consumer devices mistakenly dropping IPv4 traffic for those special IP addresses.",
          "type": "boolean"
        },
        "pool": {
          "type": "string",
          "description": "Required. The name of the address pool."
        },
        "addresses": {
          "description": "Required. The addresses that are part of this pool. Each address must be either in the CIDR form (1.2.3.0/24) or range form (1.2.3.1-1.2.3.5).",
          "items": {
            "type": "string"
          },
          "type": "array"
        }
      },
      "type": "object",
      "description": "Represents an IP pool used by the load balancer."
    },
    "BareMetalLoadBalancerConfig": {
      "type": "object",
      "properties": {
        "bgpLbConfig": {
          "$ref": "#/$defs/BareMetalBgpLbConfig",
          "description": "Configuration for BGP typed load balancers. When set network_config.advanced_networking is automatically set to true."
        },
        "portConfig": {
          "$ref": "#/$defs/BareMetalPortConfig",
          "description": "Configures the ports that the load balancer will listen on."
        },
        "metalLbConfig": {
          "$ref": "#/$defs/BareMetalMetalLbConfig",
          "description": "Configuration for MetalLB load balancers."
        },
        "manualLbConfig": {
          "$ref": "#/$defs/BareMetalManualLbConfig",
          "description": "Manually configured load balancers."
        },
        "vipConfig": {
          "$ref": "#/$defs/BareMetalVipConfig",
          "description": "The VIPs used by the load balancer."
        }
      },
      "description": "Specifies the load balancer configuration."
    },
    "BareMetalLoadBalancerNodePoolConfig": {
      "properties": {
        "nodePoolConfig": {
          "$ref": "#/$defs/BareMetalNodePoolConfig",
          "description": "The generic configuration for a node pool running a load balancer."
        }
      },
      "description": "Specifies the load balancer's node pool configuration.",
      "type": "object"
    },
    "BareMetalLvpConfig": {
      "type": "object",
      "description": "Specifies the configs for local persistent volumes (PVs).",
      "properties": {
        "path": {
          "description": "Required. The host machine path.",
          "type": "string"
        },
        "storageClass": {
          "description": "Required. The StorageClass name that PVs will be created with.",
          "type": "string"
        }
      }
    },
    "BareMetalLvpShareConfig": {
      "properties": {
        "sharedPathPvCount": {
          "format": "int32",
          "type": "integer",
          "description": "The number of subdirectories to create under path."
        },
        "lvpConfig": {
          "$ref": "#/$defs/BareMetalLvpConfig",
          "description": "Required. Defines the machine path and storage class for the LVP Share."
        }
      },
      "description": "Specifies the configs for local persistent volumes under a shared file system.",
      "type": "object"
    },
    "BareMetalMachineDrainStatus": {
      "properties": {
        "drainedMachines": {
          "items": {
            "$ref": "#/$defs/BareMetalDrainedMachine"
          },
          "type": "array",
          "description": "The list of drained machines."
        },
        "drainingMachines": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/BareMetalDrainingMachine"
          },
          "description": "The list of draning machines."
        }
      },
      "description": "Represents the status of node machines that are undergoing drain operations.",
      "type": "object"
    },
    "BareMetalMaintenanceConfig": {
      "properties": {
        "maintenanceAddressCidrBlocks": {
          "items": {
            "type": "string"
          },
          "type": "array",
          "description": "Required. All IPv4 address from these ranges will be placed into maintenance mode. Nodes in maintenance mode will be cordoned and drained. When both of these are true, the \"baremetal.cluster.gke.io/maintenance\" annotation will be set on the node resource."
        }
      },
      "type": "object",
      "description": "Specifies configurations to put bare metal nodes in and out of maintenance."
    },
    "BareMetalMaintenanceStatus": {
      "properties": {
        "machineDrainStatus": {
          "$ref": "#/$defs/BareMetalMachineDrainStatus",
          "description": "The maintenance status of node machines."
        }
      },
      "description": "Represents the maintenance status of the bare metal user cluster.",
      "type": "object"
    },
    "BareMetalManualLbConfig": {
      "type": "object",
      "description": "Represents configuration parameters for a manual load balancer.",
      "properties": {
        "enabled": {
          "description": "Whether manual load balancing is enabled.",
          "type": "boolean"
        }
      }
    },
    "BareMetalMetalLbConfig": {
      "description": "Represents configuration parameters for a MetalLB load balancer.",
      "properties": {
        "addressPools": {
          "type": "array",
          "description": "Required. AddressPools is a list of non-overlapping IP pools used by load balancer typed services. All addresses must be routable to load balancer nodes. IngressVIP must be included in the pools.",
          "items": {
            "$ref": "#/$defs/BareMetalLoadBalancerAddressPool"
          }
        },
        "loadBalancerNodePoolConfig": {
          "$ref": "#/$defs/BareMetalLoadBalancerNodePoolConfig",
          "description": "Specifies the node pool running the load balancer. L2 connectivity is required among nodes in this pool. If missing, the control plane node pool is used as the load balancer pool."
        }
      },
      "type": "object"
    },
    "BareMetalMultipleNetworkInterfacesConfig": {
      "properties": {
        "enabled": {
          "description": "Whether to enable multiple network interfaces for your pods. When set network_config.advanced_networking is automatically set to true.",
          "type": "boolean"
        }
      },
      "description": "Specifies the multiple networking interfaces cluster configuration.",
      "type": "object"
    },
    "BareMetalNetworkConfig": {
      "description": "Specifies the cluster network configuration.",
      "type": "object",
      "properties": {
        "islandModeCidr": {
          "$ref": "#/$defs/BareMetalIslandModeCidrConfig",
          "description": "Configuration for island mode CIDR. In an island-mode network, nodes have unique IP addresses, but pods don't have unique addresses across clusters. This doesn't cause problems because pods in one cluster never directly communicate with pods in another cluster. Instead, there are gateways that mediate between a pod in one cluster and a pod in another cluster."
        },
        "srIovConfig": {
          "$ref": "#/$defs/BareMetalSrIovConfig",
          "description": "Configuration for SR-IOV."
        },
        "advancedNetworking": {
          "description": "Enables the use of advanced Anthos networking features, such as Bundled Load Balancing with BGP or the egress NAT gateway. Setting configuration for advanced networking features will automatically set this flag.",
          "type": "boolean"
        },
        "multipleNetworkInterfacesConfig": {
          "$ref": "#/$defs/BareMetalMultipleNetworkInterfacesConfig",
          "description": "Configuration for multiple network interfaces."
        }
      }
    },
    "BareMetalNodeAccessConfig": {
      "properties": {
        "loginUser": {
          "description": "LoginUser is the user name used to access node machines. It defaults to \"root\" if not set.",
          "type": "string"
        }
      },
      "description": "Specifies the node access related settings for the bare metal user cluster.",
      "type": "object"
    },
    "BareMetalNodeConfig": {
      "description": "BareMetalNodeConfig lists machine addresses to access Nodes.",
      "properties": {
        "nodeIp": {
          "type": "string",
          "description": "The default IPv4 address for SSH access and Kubernetes node. Example: 192.168.0.1"
        },
        "labels": {
          "additionalProperties": {
            "type": "string"
          },
          "description": "The labels assigned to this node. An object containing a list of key/value pairs. The labels here, unioned with the labels set on BareMetalNodePoolConfig are the set of labels that will be applied to the node. If there are any conflicts, the BareMetalNodeConfig labels take precedence. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }.",
          "type": "object"
        }
      },
      "type": "object"
    },
    "BareMetalNodePoolConfig": {
      "description": "BareMetalNodePoolConfig describes the configuration of all nodes within a given bare metal node pool.",
      "properties": {
        "labels": {
          "description": "The labels assigned to nodes of this node pool. An object containing a list of key/value pairs. Example: { \"name\": \"wrench\", \"mass\": \"1.3kg\", \"count\": \"3\" }.",
          "additionalProperties": {
            "type": "string"
          },
          "type": "object"
        },
        "nodeConfigs": {
          "items": {
            "$ref": "#/$defs/BareMetalNodeConfig"
          },
          "type": "array",
          "description": "Required. The list of machine addresses in the bare metal node pool."
        },
        "taints": {
          "items": {
            "$ref": "#/$defs/NodeTaint"
          },
          "description": "The initial taints assigned to nodes of this node pool.",
          "type": "array"
        },
        "operatingSystem": {
          "enum": [
            "OPERATING_SYSTEM_UNSPECIFIED",
            "LINUX"
          ],
          "type": "string",
          "description": "Specifies the nodes operating system (default: LINUX)."
        },
        "kubeletConfig": {
          "$ref": "#/$defs/BareMetalKubeletConfig",
          "description": "The modifiable kubelet configurations for the bare metal machines."
        }
      },
      "type": "object"
    },
    "BareMetalOsEnvironmentConfig": {
      "type": "object",
      "description": "Specifies operating system settings for cluster provisioning.",
      "properties": {
        "packageRepoExcluded": {
          "description": "Whether the package repo should not be included when initializing bare metal machines.",
          "type": "boolean"
        }
      }
    },
    "BareMetalPortConfig": {
      "description": "Specifies load balancer ports for the bare metal user cluster.",
      "properties": {
        "controlPlaneLoadBalancerPort": {
          "description": "The port that control plane hosted load balancers will listen on.",
          "type": "integer",
          "format": "int32"
        }
      },
      "type": "object"
    },
    "BareMetalProxyConfig": {
      "description": "Specifies the cluster proxy configuration.",
      "type": "object",
      "properties": {
        "uri": {
          "type": "string",
          "description": "Required. Specifies the address of your proxy server. Examples: `http://domain` Do not provide credentials in the format `http://(username:password@)domain` these will be rejected by the server."
        },
        "noProxy": {
          "description": "A list of IPs, hostnames, and domains that should skip the proxy. Examples: [\"127.0.0.1\", \"example.com\", \".corp\", \"localhost\"].",
          "type": "array",
          "items": {
            "type": "string"
          }
        }
      }
    },
    "BareMetalSecurityConfig": {
      "description": "Specifies the security related settings for the bare metal user cluster.",
      "properties": {
        "authorization": {
          "$ref": "#/$defs/Authorization",
          "description": "Configures user access to the user cluster."
        }
      },
      "type": "object"
    },
    "BareMetalSrIovConfig": {
      "type": "object",
      "description": "Specifies the SR-IOV networking operator config.",
      "properties": {
        "enabled": {
          "description": "Whether to install the SR-IOV operator.",
          "type": "boolean"
        }
      }
    },
    "BareMetalStorageConfig": {
      "description": "BareMetalStorageConfig specifies the cluster storage configuration.",
      "properties": {
        "lvpShareConfig": {
          "$ref": "#/$defs/BareMetalLvpShareConfig",
          "description": "Required. Specifies the config for local PersistentVolumes backed by subdirectories in a shared filesystem. These subdirectores are automatically created during cluster creation."
        },
        "lvpNodeMountsConfig": {
          "$ref": "#/$defs/BareMetalLvpConfig",
          "description": "Required. Specifies the config for local PersistentVolumes backed by mounted node disks. These disks need to be formatted and mounted by the user, which can be done before or after cluster creation."
        }
      },
      "type": "object"
    },
    "BareMetalVipConfig": {
      "type": "object",
      "properties": {
        "ingressVip": {
          "type": "string",
          "description": "The VIP which you previously set aside for ingress traffic into this bare metal user cluster."
        },
        "controlPlaneVip": {
          "type": "string",
          "description": "The VIP which you previously set aside for the Kubernetes API of this bare metal user cluster."
        }
      },
      "description": "Specifies the VIP config for the bare metal load balancer."
    },
    "BareMetalWorkloadNodeConfig": {
      "description": "Specifies the workload node configurations.",
      "properties": {
        "containerRuntime": {
          "description": "Specifies which container runtime will be used.",
          "enum": [
            "CONTAINER_RUNTIME_UNSPECIFIED",
            "CONTAINERD"
          ],
          "type": "string"
        },
        "maxPodsPerNode": {
          "format": "int64",
          "description": "The maximum number of pods a node can run. The size of the CIDR range assigned to the node will be derived from this parameter.",
          "type": "string"
        }
      },
      "type": "object"
    },
    "BinaryAuthorization": {
      "properties": {
        "evaluationMode": {
          "enum": [
            "EVALUATION_MODE_UNSPECIFIED",
            "DISABLED",
            "PROJECT_SINGLETON_POLICY_ENFORCE"
          ],
          "description": "Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.",
          "type": "string"
        }
      },
      "description": "Configuration for Binary Authorization.",
      "type": "object"
    },
    "ClusterUser": {
      "description": "ClusterUser configures user principals for an RBAC policy.",
      "type": "object",
      "properties": {
        "username": {
          "description": "Required. The name of the user, e.g. `my-gcp-id@gmail.com`.",
          "type": "string"
        }
      }
    },
    "Fleet": {
      "type": "object",
      "properties": {
        "membership": {
          "readOnly": true,
          "description": "Output only. The name of the managed fleet Membership resource associated to this cluster. Membership names are formatted as `projects//locations//memberships/`.",
          "type": "string"
        }
      },
      "description": "Fleet related configuration. Fleets are a Google Cloud concept for logically organizing clusters, letting you use and manage multi-cluster capabilities and apply consistent policies across your systems. See [Anthos Fleets](`https://cloud.google.com/anthos/multicluster-management/fleets`) for more details on Anthos multi-cluster capabilities using Fleets. ##"
    },
    "NodeTaint": {
      "properties": {
        "value": {
          "description": "Value associated with the effect.",
          "type"

# --- truncated at 32 KB (38 KB total) ---
# Full source: https://artifacts.apis.io/google-kubernetes-engine/json-schema/google-kubernetes-engine-bare-metal-cluster-schema.json

Work with this as data

Every JSON Schema here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for schemas

4 MCP tools reach this
  • find_json_schemasBrowse and filter every JSON Schema in the catalog.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This JSON Schema
curl "https://apis.io/api/v1/json-schemas/google-kubernetes-engine-bare-metal-cluster"
All schemas
curl "https://apis.io/api/v1/json-schemas?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.