MCP Tools Reference: container.googleapis.com

Tool: get_cluster

Gets the details of a specific GKE cluster.

The following sample demonstrate how to use curl to invoke the get_cluster MCP tool.

Curl Request
curl --location 'https://container.googleapis.com/mcp' \ --header 'content-type: application/json' \ --header 'accept: application/json, text/event-stream' \ --data '{ "method": "tools/call", "params": { "name": "get_cluster", "arguments": { // provide these details according to the tool's MCP specification } }, "jsonrpc": "2.0", "id": 1 }'

Input Schema

MCPGetClusterRequest gets the settings of a cluster.

MCPGetClusterRequest

JSON representation
{ "name": string }

Fields
name	string Required. The name (project, location, cluster) of the cluster to retrieve. Specified in the format projects/*/locations/*/clusters/*.

Output Schema

A Google Kubernetes Engine cluster.

Cluster

JSON representation

{ "name": string, "description": string, "initialNodeCount": integer, "nodeConfig": { object (NodeConfig) }, "masterAuth": { object (MasterAuth) }, "loggingService": string, "monitoringService": string, "network": string, "clusterIpv4Cidr": string, "addonsConfig": { object (AddonsConfig) }, "subnetwork": string, "nodePools": [ { object (NodePool) } ], "locations": [ string ], "enableKubernetesAlpha": boolean, "alphaClusterFeatureGates": [ string ], "resourceLabels": { string: string, ... }, "labelFingerprint": string, "legacyAbac": { object (LegacyAbac) }, "networkPolicy": { object (NetworkPolicy) }, "ipAllocationPolicy": { object (IPAllocationPolicy) }, "masterAuthorizedNetworksConfig": { object (MasterAuthorizedNetworksConfig) }, "maintenancePolicy": { object (MaintenancePolicy) }, "binaryAuthorization": { object (BinaryAuthorization) }, "autoscaling": { object (ClusterAutoscaling) }, "networkConfig": { object (NetworkConfig) }, "defaultMaxPodsConstraint": { object (MaxPodsConstraint) }, "resourceUsageExportConfig": { object (ResourceUsageExportConfig) }, "authenticatorGroupsConfig": { object (AuthenticatorGroupsConfig) }, "privateClusterConfig": { object (PrivateClusterConfig) }, "databaseEncryption": { object (DatabaseEncryption) }, "verticalPodAutoscaling": { object (VerticalPodAutoscaling) }, "shieldedNodes": { object (ShieldedNodes) }, "releaseChannel": { object (ReleaseChannel) }, "workloadIdentityConfig": { object (WorkloadIdentityConfig) }, "meshCertificates": { object (MeshCertificates) }, "costManagementConfig": { object (CostManagementConfig) }, "notificationConfig": { object (NotificationConfig) }, "confidentialNodes": { object (ConfidentialNodes) }, "identityServiceConfig": { object (IdentityServiceConfig) }, "selfLink": string, "zone": string, "endpoint": string, "initialClusterVersion": string, "currentMasterVersion": string, "currentNodeVersion": string, "createTime": string, "status": enum (Status), "statusMessage": string, "nodeIpv4CidrSize": integer, "servicesIpv4Cidr": string, "instanceGroupUrls": [ string ], "currentNodeCount": integer, "expireTime": string, "location": string, "enableTpu": boolean, "tpuIpv4CidrBlock": string, "conditions": [ { object (StatusCondition) } ], "autopilot": { object (Autopilot) }, "id": string, "parentProductConfig": { object (ParentProductConfig) }, "loggingConfig": { object (LoggingConfig) }, "monitoringConfig": { object (MonitoringConfig) }, "nodePoolAutoConfig": { object (NodePoolAutoConfig) }, "podAutoscaling": { object (PodAutoscaling) }, "etag": string, "fleet": { object (Fleet) }, "securityPostureConfig": { object (SecurityPostureConfig) }, "controlPlaneEndpointsConfig": { object (ControlPlaneEndpointsConfig) }, "enableK8sBetaApis": { object (K8sBetaAPIConfig) }, "enterpriseConfig": { object (EnterpriseConfig) }, "secretManagerConfig": { object (SecretManagerConfig) }, "compliancePostureConfig": { object (CompliancePostureConfig) }, "gkeAutoUpgradeConfig": { object (GkeAutoUpgradeConfig) }, "anonymousAuthenticationConfig": { object (AnonymousAuthenticationConfig) }, "managedOpentelemetryConfig": { object (ManagedOpenTelemetryConfig) }, // Union field _node_pool_defaults can be only one of the following: "nodePoolDefaults": { object (NodePoolDefaults) } // End of list of possible types for union field _node_pool_defaults. // Union field _satisfies_pzs can be only one of the following: "satisfiesPzs": boolean // End of list of possible types for union field _satisfies_pzs. // Union field _satisfies_pzi can be only one of the following: "satisfiesPzi": boolean // End of list of possible types for union field _satisfies_pzi. // Union field _user_managed_keys_config can be only one of the following: "userManagedKeysConfig": { object (UserManagedKeysConfig) } // End of list of possible types for union field _user_managed_keys_config. // Union field _rbac_binding_config can be only one of the following: "rbacBindingConfig": { object (RBACBindingConfig) } // End of list of possible types for union field _rbac_binding_config. }

Fields
name	string The name of this cluster. The name must be unique within this project and location (e.g. zone or region), and can be up to 40 characters with the following restrictions: Lowercase letters, numbers, and hyphens only. Must start with a letter. Must end with a number or a letter.
description	string An optional description of this cluster.
initialNodeCount (deprecated)	integer This item is deprecated! The number of nodes to create in this cluster. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "node_config") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. This field is deprecated, use node_pool.initial_node_count instead.
nodeConfig (deprecated)	object (NodeConfig) This item is deprecated! Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "node_pool" object, since this configuration (along with the "initial_node_count") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a node_pool at the same time. For responses, this field will be populated with the node configuration of the first node pool. (For configuration of each node pool, see node_pool.config) If unspecified, the defaults are used. This field is deprecated, use node_pool.config instead.
masterAuth	object (MasterAuth) The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if master_auth is unspecified, username will be set to "admin", a random password will be generated, and a client certificate will be issued.
loggingService	string The logging service the cluster should use to write logs. Currently available options: logging.googleapis.com/kubernetes - The Cloud Logging service with a Kubernetes-native resource model logging.googleapis.com - The legacy Cloud Logging service (no longer available as of GKE 1.15). none - no logs will be exported from the cluster. If left as an empty string,logging.googleapis.com/kubernetes will be used for GKE 1.14+ or logging.googleapis.com for earlier versions.
monitoringService	string The monitoring service the cluster should use to write metrics. Currently available options: monitoring.googleapis.com/kubernetes - The Cloud Monitoring service with a Kubernetes-native resource model monitoring.googleapis.com - The legacy Cloud Monitoring service (no longer available as of GKE 1.15). none - No metrics will be exported from the cluster. If left as an empty string,monitoring.googleapis.com/kubernetes will be used for GKE 1.14+ or monitoring.googleapis.com for earlier versions.
network	string The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the default network will be used.
clusterIpv4Cidr	string The IP address range of the container pods in this cluster, in CIDR notation (e.g. 10.96.0.0/14). Leave blank to have one automatically chosen or specify a /14 block in 10.0.0.0/8.
addonsConfig	object (AddonsConfig) Configurations for the various addons available to run in the cluster.
subnetwork	string The name of the Google Compute Engine subnetwork to which the cluster is connected.
nodePools[]	object (NodePool) The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
locations[]	string The list of Google Compute Engine zones in which the cluster's nodes should be located. This field provides a default value if NodePool.Locations are not specified during node pool creation. Warning: changing cluster locations will update the NodePool.Locations of all node pools and will result in nodes being added and/or removed.
enableKubernetesAlpha	boolean Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1alpha1) and features that may not be production ready in the kubernetes version of the master and nodes. The cluster has no SLA for uptime and master/node upgrades are disabled. Alpha enabled clusters are automatically deleted thirty days after creation.
alphaClusterFeatureGates[]	string The list of user specified Kubernetes feature gates. Each string represents the activation status of a feature gate (e.g. "featureX=true" or "featureX=false")
resourceLabels	map (key: string, value: string) The resource labels for the cluster to use to annotate any related Google Compute Engine resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
labelFingerprint	string The fingerprint of the set of labels for this cluster.
legacyAbac	object (LegacyAbac) Configuration for the legacy ABAC authorization mode.
networkPolicy	object (NetworkPolicy) Configuration options for the NetworkPolicy feature.
ipAllocationPolicy	object (IPAllocationPolicy) Configuration for cluster IP allocation.
masterAuthorizedNetworksConfig (deprecated)	object (MasterAuthorizedNetworksConfig) This item is deprecated! The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
maintenancePolicy	object (MaintenancePolicy) Configure the maintenance policy for this cluster.
binaryAuthorization	object (BinaryAuthorization) Configuration for Binary Authorization.
autoscaling	object (ClusterAutoscaling) Cluster-level autoscaling configuration.
networkConfig	object (NetworkConfig) Configuration for cluster networking.
defaultMaxPodsConstraint	object (MaxPodsConstraint) The default constraint on the maximum number of pods that can be run simultaneously on a node in the node pool of this cluster. Only honored if cluster created with IP Alias support.
resourceUsageExportConfig	object (ResourceUsageExportConfig) Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified.
authenticatorGroupsConfig	object (AuthenticatorGroupsConfig) Configuration controlling RBAC group membership information.
privateClusterConfig	object (PrivateClusterConfig) Configuration for private cluster.
databaseEncryption	object (DatabaseEncryption) Configuration of etcd encryption.
verticalPodAutoscaling	object (VerticalPodAutoscaling) Cluster-level Vertical Pod Autoscaling configuration.
shieldedNodes	object (ShieldedNodes) Shielded Nodes configuration.
releaseChannel	object (ReleaseChannel) Release channel configuration. If left unspecified on cluster creation and a version is specified, the cluster is enrolled in the most mature release channel where the version is available (first checking STABLE, then REGULAR, and finally RAPID). Otherwise, if no release channel configuration and no version is specified, the cluster is enrolled in the REGULAR channel with its default version.
workloadIdentityConfig	object (WorkloadIdentityConfig) Configuration for the use of Kubernetes Service Accounts in IAM policies.
meshCertificates	object (MeshCertificates) Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
costManagementConfig	object (CostManagementConfig) Configuration for the fine-grained cost management feature.
notificationConfig	object (NotificationConfig) Notification configuration of the cluster.
confidentialNodes	object (ConfidentialNodes) Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
identityServiceConfig	object (IdentityServiceConfig) Configuration for Identity Service component.
selfLink	string Output only. Server-defined URL for the resource.
zone (deprecated)	string This item is deprecated! Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead.
endpoint	string Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at https://username:password@endpoint/. See the masterAuth property of this resource for username and password information.
initialClusterVersion	string The initial Kubernetes version for this cluster. Valid versions are those found in validMasterVersions returned by getServerConfig. The version can be upgraded over time; such upgrades are reflected in currentMasterVersion and currentNodeVersion. Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: "latest": picks the highest valid Kubernetes version "1.X": picks the highest valid patch+gke.N patch in the 1.X version "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version "1.X.Y-gke.N": picks an explicit Kubernetes version "","-": picks the default Kubernetes version
currentMasterVersion	string Output only. The current software version of the master endpoint.
currentNodeVersion (deprecated)	string This item is deprecated! Output only. Deprecated, use NodePools.version instead. The current version of the node software components. If they are currently at multiple versions because they're in the process of being upgraded, this reflects the minimum version of all nodes.
createTime	string Output only. The time the cluster was created, in RFC3339 text format.
status	enum (Status) Output only. The current status of this cluster.
statusMessage (deprecated)	string This item is deprecated! Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
nodeIpv4CidrSize	integer Output only. The size of the address space on each node for hosting containers. This is provisioned from within the container_ipv4_cidr range. This field will only be set when cluster is in route-based network mode.
servicesIpv4Cidr	string Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. 1.2.3.4/29). Service addresses are typically put in the last /16 from the container CIDR.
instanceGroupUrls[] (deprecated)	string This item is deprecated! Output only. Deprecated. Use node_pools.instance_group_urls.
currentNodeCount (deprecated)	integer This item is deprecated! Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
expireTime	string Output only. The time the cluster will be automatically deleted in RFC3339 text format.
location	string Output only. The name of the Google Compute Engine zone or region in which the cluster resides.
enableTpu (deprecated)	boolean This item is deprecated! Enable the ability to use Cloud TPUs in this cluster. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
tpuIpv4CidrBlock (deprecated)	string This item is deprecated! Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. 1.2.3.4/29). This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
conditions[]	object (StatusCondition) Which conditions caused the current cluster state.
autopilot	object (Autopilot) Autopilot configuration for the cluster.
id	string Output only. Unique id for the cluster.
parentProductConfig	object (ParentProductConfig) The configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of the GKE cluster and take the ownership of the cluster.
loggingConfig	object (LoggingConfig) Logging configuration for the cluster.
monitoringConfig	object (MonitoringConfig) Monitoring configuration for the cluster.
nodePoolAutoConfig	object (NodePoolAutoConfig) Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
podAutoscaling	object (PodAutoscaling) The config for pod autoscaling.
etag	string This checksum is computed by the server based on the value of cluster fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
fleet	object (Fleet) Fleet information for the cluster.
securityPostureConfig	object (SecurityPostureConfig) Enable/Disable Security Posture API features for the cluster.
controlPlaneEndpointsConfig	object (ControlPlaneEndpointsConfig) Configuration for all cluster's control plane endpoints.
enableK8sBetaApis	object (K8sBetaAPIConfig) Beta APIs Config
enterpriseConfig (deprecated)	object (EnterpriseConfig) This item is deprecated! GKE Enterprise Configuration. Deprecated: GKE Enterprise features are now available without an Enterprise tier.
secretManagerConfig	object (SecretManagerConfig) Secret CSI driver configuration.
compliancePostureConfig	object (CompliancePostureConfig) Enable/Disable Compliance Posture features for the cluster.
gkeAutoUpgradeConfig	object (GkeAutoUpgradeConfig) Configuration for GKE auto upgrades.
anonymousAuthenticationConfig	object (AnonymousAuthenticationConfig) Configuration for limiting anonymous access to all endpoints except the health checks.
managedOpentelemetryConfig	object (ManagedOpenTelemetryConfig) Configuration for Managed OpenTelemetry pipeline.
Union field _node_pool_defaults. _node_pool_defaults can be only one of the following:
nodePoolDefaults	object (NodePoolDefaults) Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
Union field _satisfies_pzs. _satisfies_pzs can be only one of the following:
satisfiesPzs	boolean Output only. Reserved for future use.
Union field _satisfies_pzi. _satisfies_pzi can be only one of the following:
satisfiesPzi	boolean Output only. Reserved for future use.
Union field _user_managed_keys_config. _user_managed_keys_config can be only one of the following:
userManagedKeysConfig	object (UserManagedKeysConfig) The Custom keys configuration for the cluster.
Union field _rbac_binding_config. _rbac_binding_config can be only one of the following:
rbacBindingConfig	object (RBACBindingConfig) RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.

NodeConfig

JSON representation

{ "machineType": string, "diskSizeGb": integer, "oauthScopes": [ string ], "serviceAccount": string, "metadata": { string: string, ... }, "imageType": string, "labels": { string: string, ... }, "localSsdCount": integer, "tags": [ string ], "preemptible": boolean, "accelerators": [ { object (AcceleratorConfig) } ], "diskType": string, "minCpuPlatform": string, "workloadMetadataConfig": { object (WorkloadMetadataConfig) }, "taints": [ { object (NodeTaint) } ], "sandboxConfig": { object (SandboxConfig) }, "nodeGroup": string, "reservationAffinity": { object (ReservationAffinity) }, "shieldedInstanceConfig": { object (ShieldedInstanceConfig) }, "linuxNodeConfig": { object (LinuxNodeConfig) }, "kubeletConfig": { object (NodeKubeletConfig) }, "bootDiskKmsKey": string, "gcfsConfig": { object (GcfsConfig) }, "advancedMachineFeatures": { object (AdvancedMachineFeatures) }, "gvnic": { object (VirtualNIC) }, "spot": boolean, "confidentialNodes": { object (ConfidentialNodes) }, "resourceLabels": { string: string, ... }, "loggingConfig": { object (NodePoolLoggingConfig) }, "windowsNodeConfig": { object (WindowsNodeConfig) }, "localNvmeSsdBlockConfig": { object (LocalNvmeSsdBlockConfig) }, "ephemeralStorageLocalSsdConfig": { object (EphemeralStorageLocalSsdConfig) }, "soleTenantConfig": { object (SoleTenantConfig) }, "containerdConfig": { object (ContainerdConfig) }, "resourceManagerTags": { object (ResourceManagerTags) }, "enableConfidentialStorage": boolean, "secondaryBootDisks": [ { object (SecondaryBootDisk) } ], "storagePools": [ string ], "maxRunDuration": string, "effectiveCgroupMode": enum (EffectiveCgroupMode), "bootDisk": { object (BootDisk) }, // Union field _fast_socket can be only one of the following: "fastSocket": { object (FastSocket) } // End of list of possible types for union field _fast_socket. // Union field _secondary_boot_disk_update_strategy can be only one of the // following: "secondaryBootDiskUpdateStrategy": { object (SecondaryBootDiskUpdateStrategy) } // End of list of possible types for union field // _secondary_boot_disk_update_strategy. // Union field _local_ssd_encryption_mode can be only one of the following: "localSsdEncryptionMode": enum (LocalSsdEncryptionMode) // End of list of possible types for union field _local_ssd_encryption_mode. // Union field _flex_start can be only one of the following: "flexStart": boolean // End of list of possible types for union field _flex_start. }

Fields
machineType	string The name of a Google Compute Engine machine type If unspecified, the default machine type is e2-medium.
diskSizeGb	integer Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
oauthScopes[]	string The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes. https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Artifact Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
serviceAccount	string The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
metadata	map (key: string, value: string) The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: "cluster-location" "cluster-name" "cluster-uid" "configure-sh" "containerd-configure-sh" "enable-os-login" "gci-ensure-gke-docker" "gci-metrics-enabled" "gci-update-strategy" "instance-template" "kube-env" "startup-script" "user-data" "disable-address-manager" "windows-startup-script-ps1" "common-psm1" "k8s-node-setup-psm1" "install-ssh-psm1" "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
imageType	string The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
labels	map (key: string, value: string) The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
localSsdCount	integer The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
tags[]	string The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
preemptible	boolean Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
accelerators[]	object (AcceleratorConfig) A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
diskType	string Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
minCpuPlatform	string Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform
workloadMetadataConfig	object (WorkloadMetadataConfig) The workload metadata configuration for this node.
taints[]	object (NodeTaint) List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
sandboxConfig	object (SandboxConfig) Sandbox configuration for this node.
nodeGroup	string Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.
reservationAffinity	object (ReservationAffinity) The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
shieldedInstanceConfig	object (ShieldedInstanceConfig) Shielded Instance options.
linuxNodeConfig	object (LinuxNodeConfig) Parameters that can be configured on Linux nodes.
kubeletConfig	object (NodeKubeletConfig) Node kubelet configs.
bootDiskKmsKey	string The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
gcfsConfig	object (GcfsConfig) Google Container File System (image streaming) configs.
advancedMachineFeatures	object (AdvancedMachineFeatures) Advanced features for the Compute Engine VM.
gvnic	object (VirtualNIC) Enable or disable gvnic in the node pool.
spot	boolean Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
confidentialNodes	object (ConfidentialNodes) Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
resourceLabels	map (key: string, value: string) The resource labels for the node pool to use to annotate any related Google Compute Engine resources. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
loggingConfig	object (NodePoolLoggingConfig) Logging configuration.
windowsNodeConfig	object (WindowsNodeConfig) Parameters that can be configured on Windows nodes.
localNvmeSsdBlockConfig	object (LocalNvmeSsdBlockConfig) Parameters for using raw-block Local NVMe SSDs.
ephemeralStorageLocalSsdConfig	object (EphemeralStorageLocalSsdConfig) Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
soleTenantConfig	object (SoleTenantConfig) Parameters for node pools to be backed by shared sole tenant node groups.
containerdConfig	object (ContainerdConfig) Parameters for containerd customization.
resourceManagerTags	object (ResourceManagerTags) A map of resource manager tag keys and values to be attached to the nodes.
enableConfidentialStorage	boolean Optional. Reserved for future use.
secondaryBootDisks[]	object (SecondaryBootDisk) List of secondary boot disks attached to the nodes.
storagePools[]	string List of Storage Pools where boot disks are provisioned.
maxRunDuration	string (Duration format) The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".
effectiveCgroupMode	enum (EffectiveCgroupMode) Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.
bootDisk	object (BootDisk) The boot disk configuration for the node pool.
Union field _fast_socket. _fast_socket can be only one of the following:
fastSocket	object (FastSocket) Enable or disable NCCL fast socket for the node pool.
Union field _secondary_boot_disk_update_strategy. _secondary_boot_disk_update_strategy can be only one of the following:
secondaryBootDiskUpdateStrategy	object (SecondaryBootDiskUpdateStrategy) Secondary boot disk update strategy.
Union field _local_ssd_encryption_mode. _local_ssd_encryption_mode can be only one of the following:
localSsdEncryptionMode	enum (LocalSsdEncryptionMode) Specifies which method should be used for encrypting the Local SSDs attached to the node.
Union field _flex_start. _flex_start can be only one of the following:
flexStart	boolean Flex Start flag for enabling Flex Start VM.

MetadataEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

LabelsEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

AcceleratorConfig

JSON representation

{ "acceleratorCount": string, "acceleratorType": string, "gpuPartitionSize": string, // Union field _gpu_sharing_config can be only one of the following: "gpuSharingConfig": { object (GPUSharingConfig) } // End of list of possible types for union field _gpu_sharing_config. // Union field _gpu_driver_installation_config can be only one of the // following: "gpuDriverInstallationConfig": { object (GPUDriverInstallationConfig) } // End of list of possible types for union field // _gpu_driver_installation_config. }

Fields
acceleratorCount	string (int64 format) The number of the accelerator cards exposed to an instance.
acceleratorType	string The accelerator type resource name. List of supported accelerators here
gpuPartitionSize	string Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide.
Union field _gpu_sharing_config. _gpu_sharing_config can be only one of the following:
gpuSharingConfig	object (GPUSharingConfig) The configuration for GPU sharing options.
Union field _gpu_driver_installation_config. _gpu_driver_installation_config can be only one of the following:
gpuDriverInstallationConfig	object (GPUDriverInstallationConfig) The configuration for auto installation of GPU driver.

GPUSharingConfig

JSON representation
{ "maxSharedClientsPerGpu": string, // Union field _gpu_sharing_strategy can be only one of the following: "gpuSharingStrategy": enum (GPUSharingStrategy) // End of list of possible types for union field _gpu_sharing_strategy. }

Fields
maxSharedClientsPerGpu	string (int64 format) The max number of containers that can share a physical GPU.
Union field _gpu_sharing_strategy. _gpu_sharing_strategy can be only one of the following:
gpuSharingStrategy	enum (GPUSharingStrategy) The type of GPU sharing strategy to enable on the GPU node.

GPUDriverInstallationConfig

JSON representation
{ // Union field _gpu_driver_version can be only one of the following: "gpuDriverVersion": enum (GPUDriverVersion) // End of list of possible types for union field _gpu_driver_version. }

Fields
Union field _gpu_driver_version. _gpu_driver_version can be only one of the following:
gpuDriverVersion	enum (GPUDriverVersion) Mode for how the GPU driver is installed.

WorkloadMetadataConfig

JSON representation
{ "mode": enum (Mode) }

Fields
mode	enum (Mode) Mode is the configuration for how to expose metadata to workloads running on the node pool.

NodeTaint

JSON representation
{ "key": string, "value": string, "effect": enum (Effect) }

Fields
key	string Key for taint.
value	string Value for taint.
effect	enum (Effect) Effect for taint.

SandboxConfig

JSON representation
{ "type": enum (Type) }

Fields
type	enum (Type) Type of the sandbox to use for the node.

ReservationAffinity

JSON representation
{ "consumeReservationType": enum (Type), "key": string, "values": [ string ] }

Fields
consumeReservationType	enum (Type) Corresponds to the type of reservation consumption.
key	string Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
values[]	string Corresponds to the label value(s) of reservation resource(s).

ShieldedInstanceConfig

JSON representation
{ "enableSecureBoot": boolean, "enableIntegrityMonitoring": boolean }

Fields
enableSecureBoot	boolean Defines whether the instance has Secure Boot enabled. Secure Boot helps ensure that the system only runs authentic software by verifying the digital signature of all boot components, and halting the boot process if signature verification fails.
enableIntegrityMonitoring	boolean Defines whether the instance has integrity monitoring enabled. Enables monitoring and attestation of the boot integrity of the instance. The attestation is performed against the integrity policy baseline. This baseline is initially derived from the implicitly trusted boot image when the instance is created.

LinuxNodeConfig

JSON representation

{ "sysctls": { string: string, ... }, "cgroupMode": enum (CgroupMode), "transparentHugepageEnabled": enum (TransparentHugepageEnabled), "transparentHugepageDefrag": enum (TransparentHugepageDefrag), "nodeKernelModuleLoading": { object (NodeKernelModuleLoading) }, // Union field _hugepages can be only one of the following: "hugepages": { object (HugepagesConfig) } // End of list of possible types for union field _hugepages. }

Fields
sysctls	map (key: string, value: string) The Linux kernel parameters to be applied to the nodes and all pods running on the nodes. The following parameters are supported. net.core.busy_poll net.core.busy_read net.core.netdev_max_backlog net.core.rmem_max net.core.rmem_default net.core.wmem_default net.core.wmem_max net.core.optmem_max net.core.somaxconn net.ipv4.tcp_rmem net.ipv4.tcp_wmem net.ipv4.tcp_tw_reuse net.ipv4.tcp_mtu_probing net.ipv4.tcp_max_orphans net.ipv4.tcp_max_tw_buckets net.ipv4.tcp_syn_retries net.ipv4.tcp_ecn net.ipv4.tcp_congestion_control net.netfilter.nf_conntrack_max net.netfilter.nf_conntrack_buckets net.netfilter.nf_conntrack_tcp_timeout_close_wait net.netfilter.nf_conntrack_tcp_timeout_time_wait net.netfilter.nf_conntrack_tcp_timeout_established net.netfilter.nf_conntrack_acct kernel.shmmni kernel.shmmax kernel.shmall kernel.perf_event_paranoid kernel.sched_rt_runtime_us kernel.softlockup_panic kernel.yama.ptrace_scope kernel.kptr_restrict kernel.dmesg_restrict kernel.sysrq fs.aio-max-nr fs.file-max fs.inotify.max_user_instances fs.inotify.max_user_watches fs.nr_open vm.dirty_background_ratio vm.dirty_background_bytes vm.dirty_expire_centisecs vm.dirty_ratio vm.dirty_bytes vm.dirty_writeback_centisecs vm.max_map_count vm.overcommit_memory vm.overcommit_ratio vm.vfs_cache_pressure vm.swappiness vm.watermark_scale_factor vm.min_free_kbytes An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
cgroupMode	enum (CgroupMode) cgroup_mode specifies the cgroup mode to be used on the node.
transparentHugepageEnabled	enum (TransparentHugepageEnabled) Optional. Transparent hugepage support for anonymous memory can be entirely disabled (mostly for debugging purposes) or only enabled inside MADV_HUGEPAGE regions (to avoid the risk of consuming more memory resources) or enabled system wide. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
transparentHugepageDefrag	enum (TransparentHugepageDefrag) Optional. Defines the transparent hugepage defrag configuration on the node. VM hugepage allocation can be managed by either limiting defragmentation for delayed allocation or skipping it entirely for immediate allocation only. See https://docs.kernel.org/admin-guide/mm/transhuge.html for more details.
nodeKernelModuleLoading	object (NodeKernelModuleLoading) Optional. Configuration for kernel module loading on nodes. When enabled, the node pool will be provisioned with a Container-Optimized OS image that enforces kernel module signature verification.
Union field _hugepages. _hugepages can be only one of the following:
hugepages	object (HugepagesConfig) Optional. Amounts for 2M and 1G hugepages

SysctlsEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

HugepagesConfig

JSON representation
{ // Union field _hugepage_size2m can be only one of the following: "hugepageSize2m": integer // End of list of possible types for union field _hugepage_size2m. // Union field _hugepage_size1g can be only one of the following: "hugepageSize1g": integer // End of list of possible types for union field _hugepage_size1g. }

Fields
Union field _hugepage_size2m. _hugepage_size2m can be only one of the following:
hugepageSize2m	integer Optional. Amount of 2M hugepages
Union field _hugepage_size1g. _hugepage_size1g can be only one of the following:
hugepageSize1g	integer Optional. Amount of 1G hugepages

NodeKernelModuleLoading

JSON representation
{ "policy": enum (Policy) }

Fields
policy	enum (Policy) Set the node module loading policy for nodes in the node pool.

NodeKubeletConfig

JSON representation

{ "cpuManagerPolicy": string, "topologyManager": { object (TopologyManager) }, "memoryManager": { object (MemoryManager) }, "cpuCfsQuota": boolean, "cpuCfsQuotaPeriod": string, "podPidsLimit": string, "imageGcLowThresholdPercent": integer, "imageGcHighThresholdPercent": integer, "imageMinimumGcAge": string, "imageMaximumGcAge": string, "containerLogMaxSize": string, "containerLogMaxFiles": integer, "allowedUnsafeSysctls": [ string ], "evictionSoft": { object (EvictionSignals) }, "evictionSoftGracePeriod": { object (EvictionGracePeriod) }, "evictionMinimumReclaim": { object (EvictionMinimumReclaim) }, "evictionMaxPodGracePeriodSeconds": integer, "maxParallelImagePulls": integer, // Union field _insecure_kubelet_readonly_port_enabled can be only one of the // following: "insecureKubeletReadonlyPortEnabled": boolean // End of list of possible types for union field // _insecure_kubelet_readonly_port_enabled. // Union field _single_process_oom_kill can be only one of the following: "singleProcessOomKill": boolean // End of list of possible types for union field _single_process_oom_kill. }

Fields
cpuManagerPolicy	string Control the CPU management policy on the node. See https://kubernetes.io/docs/tasks/administer-cluster/cpu-management-policies/ The following values are allowed. * "none": the default, which represents the existing scheduling behavior. * "static": allows pods with certain resource characteristics to be granted increased CPU affinity and exclusivity on the node. The default value is 'none' if unspecified.
topologyManager	object (TopologyManager) Optional. Controls Topology Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/
memoryManager	object (MemoryManager) Optional. Controls NUMA-aware Memory Manager configuration on the node. For more information, see: https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/
cpuCfsQuota	boolean Enable CPU CFS quota enforcement for containers that specify CPU limits. This option is enabled by default which makes kubelet use CFS quota (https://www.kernel.org/doc/Documentation/scheduler/sched-bwc.txt) to enforce container CPU limits. Otherwise, CPU limits will not be enforced at all. Disable this option to mitigate CPU throttling problems while still having your pods to be in Guaranteed QoS class by specifying the CPU limits. The default value is 'true' if unspecified.
cpuCfsQuotaPeriod	string Set the CPU CFS quota period value 'cpu.cfs_period_us'. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300ms". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration between 1ms and 1 second, inclusive.
podPidsLimit	string (int64 format) Set the Pod PID limits. See https://kubernetes.io/docs/concepts/policy/pid-limiting/#pod-pid-limits Controls the maximum number of processes allowed to run in a pod. The value must be greater than or equal to 1024 and less than 4194304.
imageGcLowThresholdPercent	integer Optional. Defines the percent of disk usage before which image garbage collection is never run. Lowest disk usage to garbage collect to. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and smaller than image_gc_high_threshold_percent. The default value is 80 if unspecified.
imageGcHighThresholdPercent	integer Optional. Defines the percent of disk usage after which image garbage collection is always run. The percent is calculated as this field value out of 100. The value must be between 10 and 85, inclusive and greater than image_gc_low_threshold_percent. The default value is 85 if unspecified.
imageMinimumGcAge	string Optional. Defines the minimum age for an unused image before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration less than or equal to 2 minutes. The default value is "2m0s" if unspecified.
imageMaximumGcAge	string Optional. Defines the maximum age an image can be unused before it is garbage collected. The string must be a sequence of decimal numbers, each with optional fraction and a unit suffix, such as "300s", "1.5h", and "2h45m". Valid time units are "ns", "us" (or "µs"), "ms", "s", "m", "h". The value must be a positive duration greater than image_minimum_gc_age or "0s". The default value is "0s" if unspecified, which disables this field, meaning images won't be garbage collected based on being unused for too long.
containerLogMaxSize	string Optional. Defines the maximum size of the container log file before it is rotated. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation Valid format is positive number + unit, e.g. 100Ki, 10Mi. Valid units are Ki, Mi, Gi. The value must be between 10Mi and 500Mi, inclusive. Note that the total container log size (container_log_max_size * container_log_max_files) cannot exceed 1% of the total storage of the node, to avoid disk pressure caused by log files. The default value is 10Mi if unspecified.
containerLogMaxFiles	integer Optional. Defines the maximum number of container log files that can be present for a container. See https://kubernetes.io/docs/concepts/cluster-administration/logging/#log-rotation The value must be an integer between 2 and 10, inclusive. The default value is 5 if unspecified.
allowedUnsafeSysctls[]	string Optional. Defines a comma-separated allowlist of unsafe sysctls or sysctl patterns (ending in *). The unsafe namespaced sysctl groups are kernel.shm*, kernel.msg*, kernel.sem, fs.mqueue.*, and net.*. Leaving this allowlist empty means they cannot be set on Pods. To allow certain sysctls or sysctl patterns to be set on Pods, list them separated by commas. For example: kernel.msg*,net.ipv4.route.min_pmtu. See https://kubernetes.io/docs/tasks/administer-cluster/sysctl-cluster/ for more details.
evictionSoft	object (EvictionSignals) Optional. eviction_soft is a map of signal names to quantities that defines soft eviction thresholds. Each signal is compared to its corresponding threshold to determine if a pod eviction should occur.
evictionSoftGracePeriod	object (EvictionGracePeriod) Optional. eviction_soft_grace_period is a map of signal names to quantities that defines grace periods for each soft eviction signal. The grace period is the amount of time that a pod must be under pressure before an eviction occurs.
evictionMinimumReclaim	object (EvictionMinimumReclaim) Optional. eviction_minimum_reclaim is a map of signal names to quantities that defines minimum reclaims, which describe the minimum amount of a given resource the kubelet will reclaim when performing a pod eviction while that resource is under pressure.
evictionMaxPodGracePeriodSeconds	integer Optional. eviction_max_pod_grace_period_seconds is the maximum allowed grace period (in seconds) to use when terminating pods in response to a soft eviction threshold being met. This value effectively caps the Pod's terminationGracePeriodSeconds value during soft evictions. Default: 0. Range: [0, 300].
maxParallelImagePulls	integer Optional. Defines the maximum number of image pulls in parallel. The range is 2 to 5, inclusive. The default value is 2 or 3 depending on the disk type. See https://kubernetes.io/docs/concepts/containers/images/#maximum-parallel-image-pulls for more details.
Union field _insecure_kubelet_readonly_port_enabled. _insecure_kubelet_readonly_port_enabled can be only one of the following:
insecureKubeletReadonlyPortEnabled	boolean Enable or disable Kubelet read only port.
Union field _single_process_oom_kill. _single_process_oom_kill can be only one of the following:
singleProcessOomKill	boolean Optional. Defines whether to enable single process OOM killer. If true, will prevent the memory.oom.group flag from being set for container cgroups in cgroups v2. This causes processes in the container to be OOM killed individually instead of as a group.

TopologyManager

JSON representation
{ "policy": string, "scope": string }

Fields
policy	string Configures the strategy for resource alignment. Allowed values are: none: the default policy, and does not perform any topology alignment. restricted: the topology manager stores the preferred NUMA node affinity for the container, and will reject the pod if the affinity if not preferred. best-effort: the topology manager stores the preferred NUMA node affinity for the container. If the affinity is not preferred, the topology manager will admit the pod to the node anyway. single-numa-node: the topology manager determines if the single NUMA node affinity is possible. If it is, Topology Manager will store this and the Hint Providers can then use this information when making the resource allocation decision. If, however, this is not possible then the Topology Manager will reject the pod from the node. This will result in a pod in a Terminated state with a pod admission failure. The default policy value is 'none' if unspecified. Details about each strategy can be found here.
scope	string The Topology Manager aligns resources in following scopes: container pod The default scope is 'container' if unspecified. See https://kubernetes.io/docs/tasks/administer-cluster/topology-manager/#topology-manager-scopes

MemoryManager

JSON representation
{ "policy": string }

Fields
policy	string Controls the memory management policy on the Node. See https://kubernetes.io/docs/tasks/administer-cluster/memory-manager/#policies The following values are allowed. * "none" * "static" The default value is 'none' if unspecified.

BoolValue

JSON representation
{ "value": boolean }

Fields
value	boolean The bool value.

EvictionSignals

JSON representation
{ "memoryAvailable": string, "nodefsAvailable": string, "nodefsInodesFree": string, "imagefsAvailable": string, "imagefsInodesFree": string, "pidAvailable": string }

Fields
memoryAvailable	string Optional. Memory available (i.e. capacity - workingSet), in bytes. Defines the amount of "memory.available" signal in kubelet. Default is unset, if not specified in the kubelet config. Format: positive number + unit, e.g. 100Ki, 10Mi, 5Gi. Valid units are Ki, Mi, Gi. Must be >= 100Mi and <= 50% of the node's memory. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
nodefsAvailable	string Optional. Amount of storage available on filesystem that kubelet uses for volumes, daemon logs, etc. Defines the amount of "nodefs.available" signal in kubelet. Default is unset, if not specified in the kubelet config. It takses percentage value for now. Sample format: "30%". Must be >= 10% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
nodefsInodesFree	string Optional. Amount of inodes available on filesystem that kubelet uses for volumes, daemon logs, etc. Defines the amount of "nodefs.inodesFree" signal in kubelet. Default is unset, if not specified in the kubelet config. Linux only. It takses percentage value for now. Sample format: "30%". Must be >= 5% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
imagefsAvailable	string Optional. Amount of storage available on filesystem that container runtime uses for storing images layers. If the container filesystem and image filesystem are not separate, then imagefs can store both image layers and writeable layers. Defines the amount of "imagefs.available" signal in kubelet. Default is unset, if not specified in the kubelet config. It takses percentage value for now. Sample format: "30%". Must be >= 15% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
imagefsInodesFree	string Optional. Amount of inodes available on filesystem that container runtime uses for storing images layers. Defines the amount of "imagefs.inodesFree" signal in kubelet. Default is unset, if not specified in the kubelet config. Linux only. It takses percentage value for now. Sample format: "30%". Must be >= 5% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
pidAvailable	string Optional. Amount of PID available for pod allocation. Defines the amount of "pid.available" signal in kubelet. Default is unset, if not specified in the kubelet config. It takses percentage value for now. Sample format: "30%". Must be >= 10% and <= 50%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals

EvictionGracePeriod

JSON representation
{ "memoryAvailable": string, "nodefsAvailable": string, "nodefsInodesFree": string, "imagefsAvailable": string, "imagefsInodesFree": string, "pidAvailable": string }

Fields
memoryAvailable	string Optional. Grace period for eviction due to memory available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
nodefsAvailable	string Optional. Grace period for eviction due to nodefs available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
nodefsInodesFree	string Optional. Grace period for eviction due to nodefs inodes free signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
imagefsAvailable	string Optional. Grace period for eviction due to imagefs available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
imagefsInodesFree	string Optional. Grace period for eviction due to imagefs inodes free signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
pidAvailable	string Optional. Grace period for eviction due to pid available signal. Sample format: "10s". Must be >= 0. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals

EvictionMinimumReclaim

JSON representation
{ "memoryAvailable": string, "nodefsAvailable": string, "nodefsInodesFree": string, "imagefsAvailable": string, "imagefsInodesFree": string, "pidAvailable": string }

Fields
memoryAvailable	string Optional. Minimum reclaim for eviction due to memory available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
nodefsAvailable	string Optional. Minimum reclaim for eviction due to nodefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
nodefsInodesFree	string Optional. Minimum reclaim for eviction due to nodefs inodes free signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
imagefsAvailable	string Optional. Minimum reclaim for eviction due to imagefs available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
imagefsInodesFree	string Optional. Minimum reclaim for eviction due to imagefs inodes free signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals
pidAvailable	string Optional. Minimum reclaim for eviction due to pid available signal. Only take percentage value for now. Sample format: "10%". Must be <=10%. See https://kubernetes.io/docs/concepts/scheduling-eviction/node-pressure-eviction/#eviction-signals

GcfsConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether to use GCFS.

AdvancedMachineFeatures

JSON representation

{ // Union field _threads_per_core can be only one of the following: "threadsPerCore": string // End of list of possible types for union field _threads_per_core. // Union field _enable_nested_virtualization can be only one of the following: "enableNestedVirtualization": boolean // End of list of possible types for union field _enable_nested_virtualization. // Union field _performance_monitoring_unit can be only one of the following: "performanceMonitoringUnit": enum (PerformanceMonitoringUnit) // End of list of possible types for union field _performance_monitoring_unit. }

Fields
Union field _threads_per_core. _threads_per_core can be only one of the following:
threadsPerCore	string (int64 format) The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
Union field _enable_nested_virtualization. _enable_nested_virtualization can be only one of the following:
enableNestedVirtualization	boolean Whether or not to enable nested virtualization (defaults to false).
Union field _performance_monitoring_unit. _performance_monitoring_unit can be only one of the following:
performanceMonitoringUnit	enum (PerformanceMonitoringUnit) Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node.

VirtualNIC

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether gVNIC features are enabled in the node pool.

ConfidentialNodes

JSON representation
{ "enabled": boolean, "confidentialInstanceType": enum (ConfidentialInstanceType) }

Fields
enabled	boolean Whether Confidential Nodes feature is enabled.
confidentialInstanceType	enum (ConfidentialInstanceType) Defines the type of technology used by the confidential node.

FastSocket

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether Fast Socket features are enabled in the node pool.

ResourceLabelsEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

NodePoolLoggingConfig

JSON representation
{ "variantConfig": { object (LoggingVariantConfig) } }

Fields
variantConfig	object (LoggingVariantConfig) Logging variant configuration.

LoggingVariantConfig

JSON representation
{ "variant": enum (Variant) }

Fields
variant	enum (Variant) Logging variant deployed on nodes.

WindowsNodeConfig

JSON representation
{ "osVersion": enum (OSVersion) }

Fields
osVersion	enum (OSVersion) OSVersion specifies the Windows node config to be used on the node.

LocalNvmeSsdBlockConfig

JSON representation
{ "localSsdCount": integer }

Fields

localSsdCount

integer Number of local NVMe SSDs to use. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.

EphemeralStorageLocalSsdConfig

JSON representation
{ "localSsdCount": integer, "dataCacheCount": integer }

Fields
localSsdCount	integer Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://cloud.google.com/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
dataCacheCount	integer Number of local SSDs to use for GKE Data Cache.

SoleTenantConfig

JSON representation
{ "nodeAffinities": [ { object (NodeAffinity) } ], // Union field _min_node_cpus can be only one of the following: "minNodeCpus": integer // End of list of possible types for union field _min_node_cpus. }

Fields
nodeAffinities[]	object (NodeAffinity) NodeAffinities used to match to a shared sole tenant node group.
Union field _min_node_cpus. _min_node_cpus can be only one of the following:
minNodeCpus	integer Optional. The minimum number of virtual CPUs this instance will consume when running on a sole-tenant node. This field can only be set if the node pool is created in a shared sole-tenant node group.

NodeAffinity

JSON representation
{ "key": string, "operator": enum (Operator), "values": [ string ] }

Fields
key	string Key for NodeAffinity.
operator	enum (Operator) Operator for NodeAffinity.
values[]	string Values for NodeAffinity.

ContainerdConfig

JSON representation
{ "privateRegistryAccessConfig": { object (PrivateRegistryAccessConfig) }, "writableCgroups": { object (WritableCgroups) }, "registryHosts": [ { object (RegistryHostConfig) } ] }

Fields
privateRegistryAccessConfig	object (PrivateRegistryAccessConfig) PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
writableCgroups	object (WritableCgroups) Optional. WritableCgroups defines writable cgroups configuration for the node pool.
registryHosts[]	object (RegistryHostConfig) RegistryHostConfig configures containerd registry host configuration. Each registry_hosts represents a hosts.toml file. At most 25 registry_hosts are allowed.

PrivateRegistryAccessConfig

JSON representation
{ "enabled": boolean, "certificateAuthorityDomainConfig": [ { object (CertificateAuthorityDomainConfig) } ] }

Fields
enabled	boolean Private registry access is enabled.
certificateAuthorityDomainConfig[]	object (CertificateAuthorityDomainConfig) Private registry access configuration.

CertificateAuthorityDomainConfig

JSON representation
{ "fqdns": [ string ], // Union field certificate_config can be only one of the following: "gcpSecretManagerCertificateConfig": { object (GCPSecretManagerCertificateConfig) } // End of list of possible types for union field certificate_config. }

Fields
fqdns[]	string List of fully qualified domain names (FQDN). Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
Union field certificate_config. Certificate access config. The following are supported: - GCPSecretManagerCertificateConfig certificate_config can be only one of the following:
gcpSecretManagerCertificateConfig	object (GCPSecretManagerCertificateConfig) Secret Manager certificate configuration.

GCPSecretManagerCertificateConfig

JSON representation
{ "secretUri": string }

Fields
secretUri	string Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"

WritableCgroups

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Optional. Whether writable cgroups is enabled.

RegistryHostConfig

JSON representation
{ "server": string, "hosts": [ { object (HostConfig) } ] }

Fields
server	string Defines the host name of the registry server, which will be used to create configuration file as /etc/containerd/hosts.d//hosts.toml. It supports fully qualified domain names (FQDN) and IP addresses: Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
hosts[]	object (HostConfig) HostConfig configures a list of host-specific configurations for the server. Each server can have at most 10 host configurations.

HostConfig

JSON representation
{ "host": string, "capabilities": [ enum (HostCapability) ], "overridePath": boolean, "header": [ { object (RegistryHeader) } ], "ca": [ { object (CertificateConfig) } ], "client": [ { object (CertificateConfigPair) } ], "dialTimeout": string }

Fields
host	string Host configures the registry host/mirror. It supports fully qualified domain names (FQDN) and IP addresses: Specifying port is supported. Wildcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
capabilities[]	enum (HostCapability) Capabilities represent the capabilities of the registry host, specifying what operations a host is capable of performing. If not set, containerd enables all capabilities by default.
overridePath	boolean OverridePath is used to indicate the host's API root endpoint is defined in the URL path rather than by the API specification. This may be used with non-compliant OCI registries which are missing the /v2 prefix. If not set, containerd sets default false.
header[]	object (RegistryHeader) Header configures the registry host headers.
ca[]	object (CertificateConfig) CA configures the registry host certificate.
client[]	object (CertificateConfigPair) Client configures the registry host client certificate and key.
dialTimeout	string (Duration format) Specifies the maximum duration allowed for a connection attempt to complete. A shorter timeout helps reduce delays when falling back to the original registry if the mirror is unreachable. Maximum allowed value is 180s. If not set, containerd sets default 30s. The value should be a decimal number of seconds with an s suffix. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

RegistryHeader

JSON representation
{ "key": string, "value": [ string ] }

Fields
key	string Key configures the header key.
value[]	string Value configures the header value.

CertificateConfig

JSON representation
{ // Union field certificate can be only one of the following: "gcpSecretManagerSecretUri": string // End of list of possible types for union field certificate. }

Fields
Union field certificate. One of the methods to configure the certificate. certificate can be only one of the following:
gcpSecretManagerSecretUri	string The URI configures a secret from Secret Manager in the format "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION" for global secret or "projects/$PROJECT_ID/locations/$REGION/secrets/$SECRET_NAME/versions/$VERSION" for regional secret. Version can be fixed (e.g. "2") or "latest"

CertificateConfigPair

JSON representation
{ "cert": { object (CertificateConfig) }, "key": { object (CertificateConfig) } }

Fields
cert	object (CertificateConfig) Cert configures the client certificate.
key	object (CertificateConfig) Key configures the client private key. Optional.

Duration

JSON representation
{ "seconds": string, "nanos": integer }

Fields
seconds	string (int64 format) Signed seconds of the span of time. Must be from -315,576,000,000 to +315,576,000,000 inclusive. Note: these bounds are computed from: 60 sec/min * 60 min/hr * 24 hr/day * 365.25 days/year * 10000 years
nanos	integer Signed fractions of a second at nanosecond resolution of the span of time. Durations less than one second are represented with a 0 seconds field and a positive or negative nanos field. For durations of one second or more, a non-zero value for the nanos field must be of the same sign as the seconds field. Must be from -999,999,999 to +999,999,999 inclusive.

ResourceManagerTags

JSON representation
{ "tags": { string: string, ... } }

Fields
tags	map (key: string, value: string) TagKeyValue must be in one of the following formats ([KEY]=[VALUE]) 1. tagKeys/{tag_key_id}=tagValues/{tag_value_id} 2. {org_id}/{tag_key_name}={tag_value_name} 3. {project_id}/{tag_key_name}={tag_value_name} An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

TagsEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

SecondaryBootDisk

JSON representation
{ "mode": enum (Mode), "diskImage": string }

Fields
mode	enum (Mode) Disk mode (container image cache, etc.)
diskImage	string Fully-qualified resource ID for an existing disk image.

BootDisk

JSON representation
{ "diskType": string, "sizeGb": string, "provisionedIops": string, "provisionedThroughput": string }

Fields
diskType	string Disk type of the boot disk. (i.e. Hyperdisk-Balanced, PD-Balanced, etc.)
sizeGb	string (int64 format) Disk size in GB. Replaces NodeConfig.disk_size_gb
provisionedIops	string (int64 format) For Hyperdisk-Balanced only, the provisioned IOPS config value.
provisionedThroughput	string (int64 format) For Hyperdisk-Balanced only, the provisioned throughput config value.

MasterAuth

JSON representation
{ "username": string, "password": string, "clientCertificateConfig": { object (ClientCertificateConfig) }, "clusterCaCertificate": string, "clientCertificate": string, "clientKey": string }

Fields
username (deprecated)	string This item is deprecated! The username to use for HTTP basic authentication to the master endpoint. For clusters v1.6.0 and later, basic authentication can be disabled by leaving username unspecified (or setting it to the empty string). Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
password (deprecated)	string This item is deprecated! The password to use for HTTP basic authentication to the master endpoint. Because the master endpoint is open to the Internet, you should create a strong password. If a password is provided for cluster creation, username must be non-empty. Warning: basic authentication is deprecated, and will be removed in GKE control plane versions 1.19 and newer. For a list of recommended authentication methods, see: https://cloud.google.com/kubernetes-engine/docs/how-to/api-server-authentication
clientCertificateConfig	object (ClientCertificateConfig) Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
clusterCaCertificate	string Output only. Base64-encoded public certificate that is the root of trust for the cluster.
clientCertificate	string Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
clientKey	string Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.

ClientCertificateConfig

JSON representation
{ "issueClientCertificate": boolean }

Fields
issueClientCertificate	boolean Issue a client certificate.

AddonsConfig

JSON representation

{ "httpLoadBalancing": { object (HttpLoadBalancing) }, "horizontalPodAutoscaling": { object (HorizontalPodAutoscaling) }, "kubernetesDashboard": { object (KubernetesDashboard) }, "networkPolicyConfig": { object (NetworkPolicyConfig) }, "cloudRunConfig": { object (CloudRunConfig) }, "dnsCacheConfig": { object (DnsCacheConfig) }, "configConnectorConfig": { object (ConfigConnectorConfig) }, "gcePersistentDiskCsiDriverConfig": { object (GcePersistentDiskCsiDriverConfig) }, "gcpFilestoreCsiDriverConfig": { object (GcpFilestoreCsiDriverConfig) }, "gkeBackupAgentConfig": { object (GkeBackupAgentConfig) }, "gcsFuseCsiDriverConfig": { object (GcsFuseCsiDriverConfig) }, "statefulHaConfig": { object (StatefulHAConfig) }, "parallelstoreCsiDriverConfig": { object (ParallelstoreCsiDriverConfig) }, "rayOperatorConfig": { object (RayOperatorConfig) }, "highScaleCheckpointingConfig": { object (HighScaleCheckpointingConfig) }, "lustreCsiDriverConfig": { object (LustreCsiDriverConfig) } }

Fields
httpLoadBalancing	object (HttpLoadBalancing) Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
horizontalPodAutoscaling	object (HorizontalPodAutoscaling) Configuration for the horizontal pod autoscaling feature, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods.
kubernetesDashboard (deprecated)	object (KubernetesDashboard) This item is deprecated! Configuration for the Kubernetes Dashboard. This addon is deprecated, and will be disabled in 1.15. It is recommended to use the Cloud Console to manage and monitor your Kubernetes clusters, workloads and applications. For more information, see: https://cloud.google.com/kubernetes-engine/docs/concepts/dashboards
networkPolicyConfig	object (NetworkPolicyConfig) Configuration for NetworkPolicy. This only tracks whether the addon is enabled or not on the Master, it does not track whether network policy is enabled for the nodes.
cloudRunConfig	object (CloudRunConfig) Configuration for the Cloud Run addon, which allows the user to use a managed Knative service.
dnsCacheConfig	object (DnsCacheConfig) Configuration for NodeLocalDNS, a dns cache running on cluster nodes
configConnectorConfig	object (ConfigConnectorConfig) Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted Google Cloud services through the Kubernetes API.
gcePersistentDiskCsiDriverConfig	object (GcePersistentDiskCsiDriverConfig) Configuration for the Compute Engine Persistent Disk CSI driver.
gcpFilestoreCsiDriverConfig	object (GcpFilestoreCsiDriverConfig) Configuration for the Filestore CSI driver.
gkeBackupAgentConfig	object (GkeBackupAgentConfig) Configuration for the Backup for GKE agent addon.
gcsFuseCsiDriverConfig	object (GcsFuseCsiDriverConfig) Configuration for the Cloud Storage Fuse CSI driver.
statefulHaConfig	object (StatefulHAConfig) Optional. Configuration for the StatefulHA add-on.
parallelstoreCsiDriverConfig	object (ParallelstoreCsiDriverConfig) Configuration for the Cloud Storage Parallelstore CSI driver.
rayOperatorConfig	object (RayOperatorConfig) Optional. Configuration for Ray Operator addon.
highScaleCheckpointingConfig	object (HighScaleCheckpointingConfig) Configuration for the High Scale Checkpointing add-on.
lustreCsiDriverConfig	object (LustreCsiDriverConfig) Configuration for the Lustre CSI driver.

HttpLoadBalancing

JSON representation
{ "disabled": boolean }

Fields
disabled	boolean Whether the HTTP Load Balancing controller is enabled in the cluster. When enabled, it runs a small pod in the cluster that manages the load balancers.

HorizontalPodAutoscaling

JSON representation
{ "disabled": boolean }

Fields
disabled	boolean Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.

KubernetesDashboard

JSON representation
{ "disabled": boolean }

Fields
disabled	boolean Whether the Kubernetes Dashboard is enabled for this cluster.

NetworkPolicyConfig

JSON representation
{ "disabled": boolean }

Fields
disabled	boolean Whether NetworkPolicy is enabled for this cluster.

CloudRunConfig

JSON representation
{ "disabled": boolean, "loadBalancerType": enum (LoadBalancerType) }

Fields
disabled	boolean Whether Cloud Run addon is enabled for this cluster.
loadBalancerType	enum (LoadBalancerType) Which load balancer type is installed for Cloud Run.

DnsCacheConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether NodeLocal DNSCache is enabled for this cluster.

ConfigConnectorConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether Cloud Connector is enabled for this cluster.

GcePersistentDiskCsiDriverConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the Compute Engine PD CSI driver is enabled for this cluster.

GcpFilestoreCsiDriverConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the Filestore CSI driver is enabled for this cluster.

GkeBackupAgentConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the Backup for GKE agent is enabled for this cluster.

GcsFuseCsiDriverConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.

StatefulHAConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the Stateful HA add-on is enabled for this cluster.

ParallelstoreCsiDriverConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.

RayOperatorConfig

JSON representation
{ "enabled": boolean, "rayClusterLoggingConfig": { object (RayClusterLoggingConfig) }, "rayClusterMonitoringConfig": { object (RayClusterMonitoringConfig) } }

Fields
enabled	boolean Whether the Ray Operator addon is enabled for this cluster.
rayClusterLoggingConfig	object (RayClusterLoggingConfig) Optional. Logging configuration for Ray clusters.
rayClusterMonitoringConfig	object (RayClusterMonitoringConfig) Optional. Monitoring configuration for Ray clusters.

RayClusterLoggingConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Enable log collection for Ray clusters.

RayClusterMonitoringConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Enable metrics collection for Ray clusters.

HighScaleCheckpointingConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the High Scale Checkpointing is enabled for this cluster.

LustreCsiDriverConfig

JSON representation
{ "enabled": boolean, "enableLegacyLustrePort": boolean }

Fields
enabled	boolean Whether the Lustre CSI driver is enabled for this cluster.
enableLegacyLustrePort (deprecated)	boolean This item is deprecated! If set to true, the Lustre CSI driver will install Lustre kernel modules using port 6988. This serves as a workaround for a port conflict with the gke-metadata-server. This field is required ONLY under the following conditions: 1. The GKE node version is older than 1.33.2-gke.4655000. 2. You're connecting to a Lustre instance that has the 'gke-support-enabled' flag. Deprecated: This flag is no longer required as of GKE node version 1.33.2-gke.4655000, unless you are connecting to a Lustre instance that has the gke-support-enabled flag.

NodePool

JSON representation

{ "name": string, "config": { object (NodeConfig) }, "initialNodeCount": integer, "locations": [ string ], "networkConfig": { object (NodeNetworkConfig) }, "selfLink": string, "version": string, "instanceGroupUrls": [ string ], "status": enum (Status), "statusMessage": string, "autoscaling": { object (NodePoolAutoscaling) }, "management": { object (NodeManagement) }, "maxPodsConstraint": { object (MaxPodsConstraint) }, "conditions": [ { object (StatusCondition) } ], "podIpv4CidrSize": integer, "upgradeSettings": { object (UpgradeSettings) }, "placementPolicy": { object (PlacementPolicy) }, "updateInfo": { object (UpdateInfo) }, "etag": string, "queuedProvisioning": { object (QueuedProvisioning) }, "bestEffortProvisioning": { object (BestEffortProvisioning) }, "autopilotConfig": { object (AutopilotConfig) }, "nodeDrainConfig": { object (NodeDrainConfig) } }

Fields
name	string The name of the node pool.
config	object (NodeConfig) The node configuration of the pool.
initialNodeCount	integer The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota.
locations[]	string The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
networkConfig	object (NodeNetworkConfig) Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
selfLink	string Output only. Server-defined URL for the resource.
version	string The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.
instanceGroupUrls[]	string Output only. The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
status	enum (Status) Output only. The status of the nodes in this pool instance.
statusMessage (deprecated)	string This item is deprecated! Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
autoscaling	object (NodePoolAutoscaling) Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
management	object (NodeManagement) NodeManagement configuration for this NodePool.
maxPodsConstraint	object (MaxPodsConstraint) The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
conditions[]	object (StatusCondition) Which conditions caused the current node pool state.
podIpv4CidrSize	integer Output only. The pod CIDR block size per node in this node pool.
upgradeSettings	object (UpgradeSettings) Upgrade settings control disruption and speed of the upgrade.
placementPolicy	object (PlacementPolicy) Specifies the node placement policy.
updateInfo	object (UpdateInfo) Output only. Update info contains relevant information during a node pool update.
etag	string This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.
queuedProvisioning	object (QueuedProvisioning) Specifies the configuration of queued provisioning.
bestEffortProvisioning	object (BestEffortProvisioning) Enable best effort provisioning for nodes
autopilotConfig	object (AutopilotConfig) Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler.
nodeDrainConfig	object (NodeDrainConfig) Specifies the node drain configuration for this node pool.

NodeNetworkConfig

JSON representation

{ "createPodRange": boolean, "podRange": string, "podIpv4CidrBlock": string, "podCidrOverprovisionConfig": { object (PodCIDROverprovisionConfig) }, "additionalNodeNetworkConfigs": [ { object (AdditionalNodeNetworkConfig) } ], "additionalPodNetworkConfigs": [ { object (AdditionalPodNetworkConfig) } ], "podIpv4RangeUtilization": number, "subnetwork": string, "networkTierConfig": { object (NetworkTierConfig) }, // Union field _enable_private_nodes can be only one of the following: "enablePrivateNodes": boolean // End of list of possible types for union field _enable_private_nodes. // Union field _network_performance_config can be only one of the following: "networkPerformanceConfig": { object (NetworkPerformanceConfig) } // End of list of possible types for union field _network_performance_config. }

Fields
createPodRange	boolean Input only. Whether to create a new range for pod IPs in this node pool. Defaults are provided for pod_range and pod_ipv4_cidr_block if they are not specified. If neither create_pod_range or pod_range are specified, the cluster-level default (ip_allocation_policy.cluster_ipv4_cidr_block) is used. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.
podRange	string The ID of the secondary range for pod IPs. If create_pod_range is true, this ID is used for the new range. If create_pod_range is false, uses an existing secondary range with this ID. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.
podIpv4CidrBlock	string The IP address range for pod IPs in this node pool. Only applicable if create_pod_range is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use. Only applicable if ip_allocation_policy.use_ip_aliases is true. This field cannot be changed after the node pool has been created.
podCidrOverprovisionConfig	object (PodCIDROverprovisionConfig) [PRIVATE FIELD] Pod CIDR size overprovisioning config for the nodepool. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is rounded off to next power of 2 and we then double that to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
additionalNodeNetworkConfigs[]	object (AdditionalNodeNetworkConfig) We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
additionalPodNetworkConfigs[]	object (AdditionalPodNetworkConfig) We specify the additional pod networks for this node pool using this list. Each pod network corresponds to an additional alias IP range for the node
podIpv4RangeUtilization	number Output only. The utilization of the IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
subnetwork	string The subnetwork path for the node pool. Format: projects/{project}/regions/{region}/subnetworks/{subnetwork} If the cluster is associated with multiple subnetworks, the subnetwork for the node pool is picked based on the IP utilization during node pool creation and is immutable.
networkTierConfig	object (NetworkTierConfig) Output only. The network tier configuration for the node pool inherits from the cluster-level configuration and remains immutable throughout the node pool's lifecycle, including during upgrades.
Union field _enable_private_nodes. _enable_private_nodes can be only one of the following:
enablePrivateNodes	boolean Whether nodes have internal IP addresses only. If enable_private_nodes is not specified, then the value is derived from [Cluster.NetworkConfig.default_enable_private_nodes][]
Union field _network_performance_config. _network_performance_config can be only one of the following:
networkPerformanceConfig	object (NetworkPerformanceConfig) Network bandwidth tier configuration.

NetworkPerformanceConfig

JSON representation
{ // Union field _total_egress_bandwidth_tier can be only one of the following: "totalEgressBandwidthTier": enum (Tier) // End of list of possible types for union field _total_egress_bandwidth_tier. }

Fields
Union field _total_egress_bandwidth_tier. _total_egress_bandwidth_tier can be only one of the following:
totalEgressBandwidthTier	enum (Tier) Specifies the total network bandwidth tier for the NodePool.

PodCIDROverprovisionConfig

JSON representation
{ "disable": boolean }

Fields
disable	boolean Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.

AdditionalNodeNetworkConfig

JSON representation
{ "network": string, "subnetwork": string }

Fields
network	string Name of the VPC where the additional interface belongs
subnetwork	string Name of the subnetwork where the additional interface belongs

AdditionalPodNetworkConfig

JSON representation
{ "subnetwork": string, "secondaryPodRange": string, "networkAttachment": string, // Union field _max_pods_per_node can be only one of the following: "maxPodsPerNode": { object (MaxPodsConstraint) } // End of list of possible types for union field _max_pods_per_node. }

Fields
subnetwork	string Name of the subnetwork where the additional pod network belongs.
secondaryPodRange	string The name of the secondary range on the subnet which provides IP address for this pod range.
networkAttachment	string The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
Union field _max_pods_per_node. _max_pods_per_node can be only one of the following:
maxPodsPerNode	object (MaxPodsConstraint) The maximum number of pods per node which use this pod network.

MaxPodsConstraint

JSON representation
{ "maxPodsPerNode": string }

Fields
maxPodsPerNode	string (int64 format) Constraint enforced on the max num of pods per node.

NetworkTierConfig

JSON representation
{ "networkTier": enum (NetworkTier) }

Fields
networkTier	enum (NetworkTier) Network tier configuration.

NodePoolAutoscaling

JSON representation
{ "enabled": boolean, "minNodeCount": integer, "maxNodeCount": integer, "autoprovisioned": boolean, "locationPolicy": enum (LocationPolicy), "totalMinNodeCount": integer, "totalMaxNodeCount": integer }

Fields
enabled	boolean Is autoscaling enabled for this node pool.
minNodeCount	integer Minimum number of nodes for one location in the node pool. Must be greater than or equal to 0 and less than or equal to max_node_count.
maxNodeCount	integer Maximum number of nodes for one location in the node pool. Must be >= min_node_count. There has to be enough quota to scale up the cluster.
autoprovisioned	boolean Can this node pool be deleted automatically.
locationPolicy	enum (LocationPolicy) Location policy used when scaling up a nodepool.
totalMinNodeCount	integer Minimum number of nodes in the node pool. Must be greater than or equal to 0 and less than or equal to total_max_node_count. The total_*_node_count fields are mutually exclusive with the *_node_count fields.
totalMaxNodeCount	integer Maximum number of nodes in the node pool. Must be greater than or equal to total_min_node_count. There has to be enough quota to scale up the cluster. The total_*_node_count fields are mutually exclusive with the *_node_count fields.

NodeManagement

JSON representation
{ "autoUpgrade": boolean, "autoRepair": boolean, "upgradeOptions": { object (AutoUpgradeOptions) } }

Fields
autoUpgrade	boolean A flag that specifies whether node auto-upgrade is enabled for the node pool. If enabled, node auto-upgrade helps keep the nodes in your node pool up to date with the latest release version of Kubernetes.
autoRepair	boolean A flag that specifies whether the node auto-repair is enabled for the node pool. If enabled, the nodes in this node pool will be monitored and, if they fail health checks too many times, an automatic repair action will be triggered.
upgradeOptions	object (AutoUpgradeOptions) Specifies the Auto Upgrade knobs for the node pool.

AutoUpgradeOptions

JSON representation
{ "autoUpgradeStartTime": string, "description": string }

Fields
autoUpgradeStartTime	string Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in RFC3339 text format.
description	string Output only. This field is set when upgrades are about to commence with the description of the upgrade.

StatusCondition

JSON representation
{ "code": enum (Code), "message": string, "canonicalCode": enum (google.rpc.Code) }

Fields
code (deprecated)	enum (Code) This item is deprecated! Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
message	string Human-friendly representation of the condition
canonicalCode	enum (google.rpc.Code) Canonical code of the condition.

UpgradeSettings

JSON representation

{ "maxSurge": integer, "maxUnavailable": integer, // Union field _strategy can be only one of the following: "strategy": enum (NodePoolUpdateStrategy) // End of list of possible types for union field _strategy. // Union field _blue_green_settings can be only one of the following: "blueGreenSettings": { object (BlueGreenSettings) } // End of list of possible types for union field _blue_green_settings. }

Fields
maxSurge	integer The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
maxUnavailable	integer The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
Union field _strategy. _strategy can be only one of the following:
strategy	enum (NodePoolUpdateStrategy) Update strategy of the node pool.
Union field _blue_green_settings. _blue_green_settings can be only one of the following:
blueGreenSettings	object (BlueGreenSettings) Settings for blue-green upgrade strategy.

BlueGreenSettings

JSON representation

{ // Union field rollout_policy can be only one of the following: "standardRolloutPolicy": { object (StandardRolloutPolicy) }, "autoscaledRolloutPolicy": { object (AutoscaledRolloutPolicy) } // End of list of possible types for union field rollout_policy. // Union field _node_pool_soak_duration can be only one of the following: "nodePoolSoakDuration": string // End of list of possible types for union field _node_pool_soak_duration. }

Fields
Union field rollout_policy. The rollout policy controls the general rollout progress of blue-green. rollout_policy can be only one of the following:
standardRolloutPolicy	object (StandardRolloutPolicy) Standard policy for the blue-green upgrade.
autoscaledRolloutPolicy	object (AutoscaledRolloutPolicy) Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
Union field _node_pool_soak_duration. _node_pool_soak_duration can be only one of the following:
nodePoolSoakDuration	string (Duration format) Time needed after draining entire blue pool. After this period, blue pool will be cleaned up. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

StandardRolloutPolicy

JSON representation
{ // Union field update_batch_size can be only one of the following: "batchPercentage": number, "batchNodeCount": integer // End of list of possible types for union field update_batch_size. // Union field _batch_soak_duration can be only one of the following: "batchSoakDuration": string // End of list of possible types for union field _batch_soak_duration. }

Fields
Union field update_batch_size. Blue pool size to drain in a batch. update_batch_size can be only one of the following:
batchPercentage	number Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
batchNodeCount	integer Number of blue nodes to drain in a batch.
Union field _batch_soak_duration. _batch_soak_duration can be only one of the following:
batchSoakDuration	string (Duration format) Soak time after each batch gets drained. Default to zero. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

AutoscaledRolloutPolicy

JSON representation
{ "waitForDrainDuration": string }

Fields
waitForDrainDuration	string (Duration format) Optional. Time to wait after cordoning the blue pool before draining the nodes. Defaults to 3 days. The value can be set between 0 and 7 days, inclusive. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

PlacementPolicy

JSON representation
{ "type": enum (Type), "tpuTopology": string, "policyName": string }

Fields
type	enum (Type) The type of placement.
tpuTopology	string Optional. TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
policyName	string If set, refers to the name of a custom resource policy supplied by the user. The resource policy must be in the same project and region as the node pool. If not found, InvalidArgument error is returned.

UpdateInfo

JSON representation
{ "blueGreenInfo": { object (BlueGreenInfo) } }

Fields
blueGreenInfo	object (BlueGreenInfo) Information of a blue-green upgrade.

BlueGreenInfo

JSON representation
{ "phase": enum (Phase), "blueInstanceGroupUrls": [ string ], "greenInstanceGroupUrls": [ string ], "bluePoolDeletionStartTime": string, "greenPoolVersion": string }

Fields
phase	enum (Phase) Current blue-green upgrade phase.
blueInstanceGroupUrls[]	string The resource URLs of the managed instance groups associated with blue pool.
greenInstanceGroupUrls[]	string The resource URLs of the managed instance groups associated with green pool.
bluePoolDeletionStartTime	string Time to start deleting blue pool to complete blue-green upgrade, in RFC3339 text format.
greenPoolVersion	string Version of green pool.

QueuedProvisioning

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.

BestEffortProvisioning

JSON representation
{ "enabled": boolean, "minProvisionNodes": integer }

Fields
enabled	boolean When this is enabled, cluster/node pool creations will ignore non-fatal errors like stockout to best provision as many nodes as possible right now and eventually bring up all target number of nodes
minProvisionNodes	integer Minimum number of nodes to be provisioned to be considered as succeeded, and the rest of nodes will be provisioned gradually and eventually when stockout issue has been resolved.

AutopilotConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Denotes that nodes belonging to this node pool are Autopilot nodes.

NodeDrainConfig

JSON representation
{ // Union field _respect_pdb_during_node_pool_deletion can be only one of the // following: "respectPdbDuringNodePoolDeletion": boolean // End of list of possible types for union field // _respect_pdb_during_node_pool_deletion. }

Fields
Union field _respect_pdb_during_node_pool_deletion. _respect_pdb_during_node_pool_deletion can be only one of the following:
respectPdbDuringNodePoolDeletion	boolean Whether to respect PDB during node pool deletion.

ResourceLabelsEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

LegacyAbac

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the ABAC authorizer is enabled for this cluster. When enabled, identities in the system, including service accounts, nodes, and controllers, will have statically granted permissions beyond those provided by the RBAC configuration or IAM.

NetworkPolicy

JSON representation
{ "provider": enum (Provider), "enabled": boolean }

Fields
provider	enum (Provider) The selected network policy provider.
enabled	boolean Whether network policy is enabled on the cluster.

IPAllocationPolicy

JSON representation

{ "useIpAliases": boolean, "createSubnetwork": boolean, "subnetworkName": string, "clusterIpv4Cidr": string, "nodeIpv4Cidr": string, "servicesIpv4Cidr": string, "clusterSecondaryRangeName": string, "servicesSecondaryRangeName": string, "clusterIpv4CidrBlock": string, "nodeIpv4CidrBlock": string, "servicesIpv4CidrBlock": string, "tpuIpv4CidrBlock": string, "useRoutes": boolean, "stackType": enum (StackType), "ipv6AccessType": enum (IPv6AccessType), "podCidrOverprovisionConfig": { object (PodCIDROverprovisionConfig) }, "subnetIpv6CidrBlock": string, "servicesIpv6CidrBlock": string, "additionalPodRangesConfig": { object (AdditionalPodRangesConfig) }, "defaultPodIpv4RangeUtilization": number, "additionalIpRangesConfigs": [ { object (AdditionalIPRangesConfig) } ], "autoIpamConfig": { object (AutoIpamConfig) }, "networkTierConfig": { object (NetworkTierConfig) } }

Fields
useIpAliases	boolean Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with use_routes. It cannot be true if use_routes is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
createSubnetwork	boolean Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when use_ip_aliases is true.
subnetworkName	string A custom subnetwork name to be used if create_subnetwork is true. If this field is empty, then an automatic name will be chosen for the new subnetwork.
clusterIpv4Cidr (deprecated)	string This item is deprecated! This field is deprecated, use cluster_ipv4_cidr_block.
nodeIpv4Cidr (deprecated)	string This item is deprecated! This field is deprecated, use node_ipv4_cidr_block.
servicesIpv4Cidr (deprecated)	string This item is deprecated! This field is deprecated, use services_ipv4_cidr_block.
clusterSecondaryRangeName	string The name of the secondary range to be used for the cluster CIDR block. The secondary range will be used for pod IP addresses. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
servicesSecondaryRangeName	string The name of the secondary range to be used as for the services CIDR block. The secondary range will be used for service ClusterIPs. This must be an existing secondary range associated with the cluster subnetwork. This field is only applicable with use_ip_aliases is true and create_subnetwork is false.
clusterIpv4CidrBlock	string The IP address range for the cluster pod IPs. If this field is set, then cluster.cluster_ipv4_cidr must be left blank. This field is only applicable when use_ip_aliases is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
nodeIpv4CidrBlock	string The IP address range of the instance IPs in this cluster. This is applicable only if create_subnetwork is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
servicesIpv4CidrBlock	string The IP address range of the services IPs in this cluster. If blank, a range will be automatically chosen with the default size. This field is only applicable when use_ip_aliases is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use.
tpuIpv4CidrBlock (deprecated)	string This item is deprecated! The IP address range of the Cloud TPUs in this cluster. If unspecified, a range will be automatically chosen with the default size. This field is only applicable when use_ip_aliases is true. If unspecified, the range will use the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) from the RFC-1918 private networks (e.g. 10.0.0.0/8, 172.16.0.0/12, 192.168.0.0/16) to pick a specific range to use. This field is deprecated due to the deprecation of 2VM TPU. The end of life date for 2VM TPU is 2025-04-25.
useRoutes	boolean Whether routes will be used for pod IPs in the cluster. This is used in conjunction with use_ip_aliases. It cannot be true if use_ip_aliases is true. If both use_ip_aliases and use_routes are false, then the server picks the default IP allocation mode
stackType	enum (StackType) The IP stack type of the cluster
ipv6AccessType	enum (IPv6AccessType) The ipv6 access type (internal or external) when create_subnetwork is true
podCidrOverprovisionConfig	object (PodCIDROverprovisionConfig) [PRIVATE FIELD] Pod CIDR size overprovisioning config for the cluster. Pod CIDR size per node depends on max_pods_per_node. By default, the value of max_pods_per_node is doubled and then rounded off to next power of 2 to get the size of pod CIDR block per node. Example: max_pods_per_node of 30 would result in 64 IPs (/26). This config can disable the doubling of IPs (we still round off to next power of 2) Example: max_pods_per_node of 30 will result in 32 IPs (/27) when overprovisioning is disabled.
subnetIpv6CidrBlock	string Output only. The subnet's IPv6 CIDR block used by nodes and pods.
servicesIpv6CidrBlock	string Output only. The services IPv6 CIDR block for the cluster.
additionalPodRangesConfig	object (AdditionalPodRangesConfig) Output only. The additional pod ranges that are added to the cluster. These pod ranges can be used by new node pools to allocate pod IPs automatically. Once the range is removed it will not show up in IPAllocationPolicy.
defaultPodIpv4RangeUtilization	number Output only. The utilization of the cluster default IPv4 range for the pod. The ratio is Usage/[Total number of IPs in the secondary range], Usage=numNodes*numZones*podIPsPerNode.
additionalIpRangesConfigs[]	object (AdditionalIPRangesConfig) Output only. The additional IP ranges that are added to the cluster. These IP ranges can be used by new node pools to allocate node and pod IPs automatically. Each AdditionalIPRangesConfig corresponds to a single subnetwork. Once a range is removed it will not show up in IPAllocationPolicy.
autoIpamConfig	object (AutoIpamConfig) Optional. AutoIpamConfig contains all information related to Auto IPAM
networkTierConfig	object (NetworkTierConfig) Cluster-level network tier configuration is used to determine the default network tier for external IP addresses on cluster resources, such as node pools and load balancers.

AdditionalPodRangesConfig

JSON representation
{ "podRangeNames": [ string ], "podRangeInfo": [ { object (RangeInfo) } ] }

Fields
podRangeNames[]	string Name for pod secondary ipv4 range which has the actual range defined ahead.
podRangeInfo[]	object (RangeInfo) Output only. Information for additional pod range.

RangeInfo

JSON representation
{ "rangeName": string, "utilization": number }

Fields
rangeName	string Output only. Name of a range.
utilization	number Output only. The utilization of the range.

AdditionalIPRangesConfig

JSON representation
{ "subnetwork": string, "podIpv4RangeNames": [ string ] }

Fields
subnetwork	string Name of the subnetwork. This can be the full path of the subnetwork or just the name. Example1: my-subnet Example2: projects/gke-project/regions/us-central1/subnetworks/my-subnet
podIpv4RangeNames[]	string List of secondary ranges names within this subnetwork that can be used for pod IPs. Example1: gke-pod-range1 Example2: gke-pod-range1,gke-pod-range2

AutoIpamConfig

JSON representation
{ // Union field _enabled can be only one of the following: "enabled": boolean // End of list of possible types for union field _enabled. }

Fields
Union field _enabled. _enabled can be only one of the following:
enabled	boolean The flag that enables Auto IPAM on this cluster

MasterAuthorizedNetworksConfig

JSON representation

{ "enabled": boolean, "cidrBlocks": [ { object (CidrBlock) } ], // Union field _gcp_public_cidrs_access_enabled can be only one of the // following: "gcpPublicCidrsAccessEnabled": boolean // End of list of possible types for union field // _gcp_public_cidrs_access_enabled. // Union field _private_endpoint_enforcement_enabled can be only one of the // following: "privateEndpointEnforcementEnabled": boolean // End of list of possible types for union field // _private_endpoint_enforcement_enabled. }

Fields
enabled	boolean Whether or not master authorized networks is enabled.
cidrBlocks[]	object (CidrBlock) cidr_blocks define up to 50 external networks that could access Kubernetes master through HTTPS.
Union field _gcp_public_cidrs_access_enabled. _gcp_public_cidrs_access_enabled can be only one of the following:
gcpPublicCidrsAccessEnabled	boolean Whether master is accessible via Google Compute Engine Public IP addresses.
Union field _private_endpoint_enforcement_enabled. _private_endpoint_enforcement_enabled can be only one of the following:
privateEndpointEnforcementEnabled	boolean Whether master authorized networks is enforced on private endpoint or not.

CidrBlock

JSON representation
{ "displayName": string, "cidrBlock": string }

Fields
displayName	string display_name is an optional field for users to identify CIDR blocks.
cidrBlock	string cidr_block must be specified in CIDR notation.

MaintenancePolicy

JSON representation
{ "window": { object (MaintenanceWindow) }, "resourceVersion": string }

Fields
window	object (MaintenanceWindow) Specifies the maintenance window in which maintenance may be performed.
resourceVersion	string A hash identifying the version of this policy, so that updates to fields of the policy won't accidentally undo intermediate changes (and so that users of the API unaware of some fields won't accidentally remove other fields). Make a get() request to the cluster to get the current resource version and include it with requests to set the policy.

MaintenanceWindow

JSON representation
{ "maintenanceExclusions": { string: { object (TimeWindow) }, ... }, // Union field policy can be only one of the following: "dailyMaintenanceWindow": { object (DailyMaintenanceWindow) }, "recurringWindow": { object (RecurringTimeWindow) } // End of list of possible types for union field policy. }

Fields
maintenanceExclusions	map (key: string, value: object (TimeWindow)) Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.
Union field policy. policy can be only one of the following:
dailyMaintenanceWindow	object (DailyMaintenanceWindow) DailyMaintenanceWindow specifies a daily maintenance operation window.
recurringWindow	object (RecurringTimeWindow) RecurringWindow specifies some number of recurring time periods for maintenance to occur. The time windows may be overlapping. If no maintenance windows are set, maintenance can occur at any time.

DailyMaintenanceWindow

JSON representation
{ "startTime": string, "duration": string }

Fields
startTime	string Time within the maintenance window to start the maintenance operations. Time format should be in RFC3339 format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
duration	string Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario. Duration will be in RFC3339 format "PTnHnMnS".

RecurringTimeWindow

JSON representation
{ "window": { object (TimeWindow) }, "recurrence": string }

Fields
window	object (TimeWindow) The window of the first recurrence.
recurrence	string An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window recurs. They go on for the span of time between the start and end time. For example, to have something repeat every weekday, you'd use: FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR To repeat some window daily (equivalent to the DailyMaintenanceWindow): FREQ=DAILY For the first weekend of every month: FREQ=MONTHLY;BYSETPOS=1;BYDAY=SA,SU This specifies how frequently the window starts. Eg, if you wanted to have a 9-5 UTC-4 window every weekday, you'd use something like: start time = 2019-01-01T09:00:00-0400 end time = 2019-01-01T17:00:00-0400 recurrence = FREQ=WEEKLY;BYDAY=MO,TU,WE,TH,FR Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC: start time = 2019-01-05T00:00:00Z end time = 2019-01-07T23:59:00Z recurrence = FREQ=WEEKLY;BYDAY=SA Note the start and end time's specific dates are largely arbitrary except to specify duration of the window and when it first starts. The FREQ values of HOURLY, MINUTELY, and SECONDLY are not supported.

TimeWindow

JSON representation
{ "startTime": string, "endTime": string, // Union field options can be only one of the following: "maintenanceExclusionOptions": { object (MaintenanceExclusionOptions) } // End of list of possible types for union field options. }

Fields
startTime	string (Timestamp format) The time that the window first starts. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
endTime	string (Timestamp format) The time that the window ends. The end time should take place after the start time. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".
Union field options. options can be only one of the following:
maintenanceExclusionOptions	object (MaintenanceExclusionOptions) MaintenanceExclusionOptions provides maintenance exclusion related options.

MaintenanceExclusionOptions

JSON representation
{ "scope": enum (Scope), "endTimeBehavior": enum (EndTimeBehavior) }

Fields
scope	enum (Scope) Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
endTimeBehavior	enum (EndTimeBehavior) EndTimeBehavior specifies the behavior of the exclusion end time.

Timestamp

JSON representation
{ "seconds": string, "nanos": integer }

Fields
seconds	string (int64 format) Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be between -62135596800 and 253402300799 inclusive (which corresponds to 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z).
nanos	integer Non-negative fractions of a second at nanosecond resolution. This field is the nanosecond portion of the duration, not an alternative to seconds. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be between 0 and 999,999,999 inclusive.

MaintenanceExclusionsEntry

JSON representation
{ "key": string, "value": { object (TimeWindow) } }

Fields
key	string
value	object (TimeWindow)

BinaryAuthorization

JSON representation
{ "enabled": boolean, "evaluationMode": enum (EvaluationMode) }

Fields
enabled (deprecated)	boolean This item is deprecated! This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluation_mode. If evaluation_mode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored.
evaluationMode	enum (EvaluationMode) Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.

ClusterAutoscaling

JSON representation
{ "enableNodeAutoprovisioning": boolean, "resourceLimits": [ { object (ResourceLimit) } ], "autoscalingProfile": enum (AutoscalingProfile), "autoprovisioningNodePoolDefaults": { object (AutoprovisioningNodePoolDefaults) }, "autoprovisioningLocations": [ string ], "defaultComputeClassConfig": { object (DefaultComputeClassConfig) } }

Fields
enableNodeAutoprovisioning	boolean Enables automatic node pool creation and deletion.
resourceLimits[]	object (ResourceLimit) Contains global constraints regarding minimum and maximum amount of resources in the cluster.
autoscalingProfile	enum (AutoscalingProfile) Defines autoscaling behaviour.
autoprovisioningNodePoolDefaults	object (AutoprovisioningNodePoolDefaults) AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
autoprovisioningLocations[]	string The list of Google Compute Engine zones in which the NodePool's nodes can be created by NAP.
defaultComputeClassConfig	object (DefaultComputeClassConfig) Default compute class is a configuration for default compute class.

ResourceLimit

JSON representation
{ "resourceType": string, "minimum": string, "maximum": string }

Fields
resourceType	string Resource name "cpu", "memory" or gpu-specific string.
minimum	string (int64 format) Minimum amount of the resource in the cluster.
maximum	string (int64 format) Maximum amount of the resource in the cluster.

AutoprovisioningNodePoolDefaults

JSON representation

{ "oauthScopes": [ string ], "serviceAccount": string, "upgradeSettings": { object (UpgradeSettings) }, "management": { object (NodeManagement) }, "minCpuPlatform": string, "diskSizeGb": integer, "diskType": string, "shieldedInstanceConfig": { object (ShieldedInstanceConfig) }, "bootDiskKmsKey": string, "imageType": string, // Union field _insecure_kubelet_readonly_port_enabled can be only one of the // following: "insecureKubeletReadonlyPortEnabled": boolean // End of list of possible types for union field // _insecure_kubelet_readonly_port_enabled. }

Fields
oauthScopes[]	string Scopes that are used by NAP when creating node pools.
serviceAccount	string The Google Cloud Platform Service Account to be used by the node VMs.
upgradeSettings	object (UpgradeSettings) Specifies the upgrade settings for NAP created node pools
management	object (NodeManagement) Specifies the node management options for NAP created node-pools.
minCpuPlatform (deprecated)	string This item is deprecated! Deprecated. Minimum CPU platform to be used for NAP created node pools. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: Intel Haswell or minCpuPlatform: Intel Sandy Bridge. For more information, read how to specify min CPU platform. This field is deprecated, min_cpu_platform should be specified using cloud.google.com/requested-min-cpu-platform label selector on the pod. To unset the min cpu platform field pass "automatic" as field value.
diskSizeGb	integer Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
diskType	string Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
shieldedInstanceConfig	object (ShieldedInstanceConfig) Shielded Instance options.
bootDiskKmsKey	string The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/[KEY_PROJECT_ID]/locations/[LOCATION]/keyRings/[RING_NAME]/cryptoKeys/[KEY_NAME]. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
imageType	string The image type to use for NAP created node. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
Union field _insecure_kubelet_readonly_port_enabled. _insecure_kubelet_readonly_port_enabled can be only one of the following:
insecureKubeletReadonlyPortEnabled	boolean DEPRECATED. Use NodePoolAutoConfig.NodeKubeletConfig instead.

DefaultComputeClassConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Enables default compute class.

NetworkConfig

JSON representation

{ "network": string, "subnetwork": string, "enableIntraNodeVisibility": boolean, "defaultSnatStatus": { object (DefaultSnatStatus) }, "enableL4ilbSubsetting": boolean, "datapathProvider": enum (DatapathProvider), "privateIpv6GoogleAccess": enum (PrivateIPv6GoogleAccess), "dnsConfig": { object (DNSConfig) }, "serviceExternalIpsConfig": { object (ServiceExternalIPsConfig) }, "gatewayApiConfig": { object (GatewayAPIConfig) }, "enableMultiNetworking": boolean, "networkPerformanceConfig": { object (ClusterNetworkPerformanceConfig) }, // Union field _enable_fqdn_network_policy can be only one of the following: "enableFqdnNetworkPolicy": boolean // End of list of possible types for union field _enable_fqdn_network_policy. // Union field _in_transit_encryption_config can be only one of the following: "inTransitEncryptionConfig": enum (InTransitEncryptionConfig) // End of list of possible types for union field _in_transit_encryption_config. // Union field _enable_cilium_clusterwide_network_policy can be only one of the // following: "enableCiliumClusterwideNetworkPolicy": boolean // End of list of possible types for union field // _enable_cilium_clusterwide_network_policy. // Union field _default_enable_private_nodes can be only one of the following: "defaultEnablePrivateNodes": boolean // End of list of possible types for union field _default_enable_private_nodes. // Union field _disable_l4_lb_firewall_reconciliation can be only one of the // following: "disableL4LbFirewallReconciliation": boolean // End of list of possible types for union field // _disable_l4_lb_firewall_reconciliation. }

Fields
network	string Output only. The relative name of the Google Compute Engine network to which the cluster is connected. Example: projects/my-project/global/networks/my-network
subnetwork	string Output only. The relative name of the Google Compute Engine subnetwork to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
enableIntraNodeVisibility	boolean Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
defaultSnatStatus	object (DefaultSnatStatus) Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when default_snat_status is disabled. When disabled is set to false, default IP masquerade rules will be applied to the nodes to prevent sNAT on cluster internal traffic.
enableL4ilbSubsetting	boolean Whether L4ILB Subsetting is enabled for this cluster.
datapathProvider	enum (DatapathProvider) The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
privateIpv6GoogleAccess	enum (PrivateIPv6GoogleAccess) The desired state of IPv6 connectivity to Google Services. By default, no private IPv6 access to or from Google Services (all access will be via IPv4)
dnsConfig	object (DNSConfig) DNSConfig contains clusterDNS config for this cluster.
serviceExternalIpsConfig	object (ServiceExternalIPsConfig) ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
gatewayApiConfig	object (GatewayAPIConfig) GatewayAPIConfig contains the desired config of Gateway API on this cluster.
enableMultiNetworking	boolean Whether multi-networking is enabled for this cluster.
networkPerformanceConfig	object (ClusterNetworkPerformanceConfig) Network bandwidth tier configuration.
Union field _enable_fqdn_network_policy. _enable_fqdn_network_policy can be only one of the following:
enableFqdnNetworkPolicy	boolean Whether FQDN Network Policy is enabled on this cluster.
Union field _in_transit_encryption_config. _in_transit_encryption_config can be only one of the following:
inTransitEncryptionConfig	enum (InTransitEncryptionConfig) Specify the details of in-transit encryption. Now named inter-node transparent encryption.
Union field _enable_cilium_clusterwide_network_policy. _enable_cilium_clusterwide_network_policy can be only one of the following:
enableCiliumClusterwideNetworkPolicy	boolean Whether CiliumClusterwideNetworkPolicy is enabled on this cluster.
Union field _default_enable_private_nodes. _default_enable_private_nodes can be only one of the following:
defaultEnablePrivateNodes	boolean Controls whether by default nodes have private IP addresses only. It is invalid to specify both [PrivateClusterConfig.enablePrivateNodes][] and this field at the same time. To update the default setting, use ClusterUpdate.desired_default_enable_private_nodes
Union field _disable_l4_lb_firewall_reconciliation. _disable_l4_lb_firewall_reconciliation can be only one of the following:
disableL4LbFirewallReconciliation	boolean Disable L4 load balancer VPC firewalls to enable firewall policies.

DefaultSnatStatus

JSON representation
{ "disabled": boolean }

Fields
disabled	boolean Disables cluster default sNAT rules.

DNSConfig

JSON representation
{ "clusterDns": enum (Provider), "clusterDnsScope": enum (DNSScope), "clusterDnsDomain": string, "additiveVpcScopeDnsDomain": string }

Fields
clusterDns	enum (Provider) cluster_dns indicates which in-cluster DNS provider should be used.
clusterDnsScope	enum (DNSScope) cluster_dns_scope indicates the scope of access to cluster DNS records.
clusterDnsDomain	string cluster_dns_domain is the suffix used for all cluster service records.
additiveVpcScopeDnsDomain	string Optional. The domain used in Additive VPC scope.

ServiceExternalIPsConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether Services with ExternalIPs field are allowed or not.

GatewayAPIConfig

JSON representation
{ "channel": enum (Channel) }

Fields
channel	enum (Channel) The Gateway API release channel to use for Gateway API.

ClusterNetworkPerformanceConfig

JSON representation
{ // Union field _total_egress_bandwidth_tier can be only one of the following: "totalEgressBandwidthTier": enum (Tier) // End of list of possible types for union field _total_egress_bandwidth_tier. }

Fields
Union field _total_egress_bandwidth_tier. _total_egress_bandwidth_tier can be only one of the following:
totalEgressBandwidthTier	enum (Tier) Specifies the total network bandwidth tier for NodePools in the cluster.

ResourceUsageExportConfig

JSON representation
{ "bigqueryDestination": { object (BigQueryDestination) }, "enableNetworkEgressMetering": boolean, "consumptionMeteringConfig": { object (ConsumptionMeteringConfig) } }

Fields
bigqueryDestination	object (BigQueryDestination) Configuration to use BigQuery as usage export destination.
enableNetworkEgressMetering	boolean Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
consumptionMeteringConfig	object (ConsumptionMeteringConfig) Configuration to enable resource consumption metering.

BigQueryDestination

JSON representation
{ "datasetId": string }

Fields
datasetId	string The ID of a BigQuery Dataset.

ConsumptionMeteringConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.

AuthenticatorGroupsConfig

JSON representation
{ "enabled": boolean, "securityGroup": string }

Fields
enabled	boolean Whether this cluster should return group membership lookups during authentication using a group of security groups.
securityGroup	string The name of the security group-of-groups to be used. Only relevant if enabled = true.

PrivateClusterConfig

JSON representation
{ "enablePrivateNodes": boolean, "enablePrivateEndpoint": boolean, "masterIpv4CidrBlock": string, "privateEndpoint": string, "publicEndpoint": string, "peeringName": string, "masterGlobalAccessConfig": { object (PrivateClusterMasterGlobalAccessConfig) }, "privateEndpointSubnetwork": string }

Fields
enablePrivateNodes (deprecated)	boolean This item is deprecated! Whether nodes have internal IP addresses only. If enabled, all nodes are given only RFC 1918 private addresses and communicate with the master via private networking. Deprecated: Use NetworkConfig.default_enable_private_nodes instead.
enablePrivateEndpoint (deprecated)	boolean This item is deprecated! Whether the master's internal IP address is used as the cluster endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_public_endpoint instead. Note that the value of enable_public_endpoint is reversed: if enable_private_endpoint is false, then enable_public_endpoint will be true.
masterIpv4CidrBlock	string The IP range in CIDR notation to use for the hosted master network. This range will be used for assigning internal IP addresses to the master or set of masters, as well as the ILB VIP. This range must not overlap with any other ranges in use within the cluster's network.
privateEndpoint (deprecated)	string This item is deprecated! Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint instead.
publicEndpoint (deprecated)	string This item is deprecated! Output only. The external IP address of this cluster's master endpoint. Deprecated:Use ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint instead.
peeringName	string Output only. The peering name in the customer VPC used by this cluster.
masterGlobalAccessConfig (deprecated)	object (PrivateClusterMasterGlobalAccessConfig) This item is deprecated! Controls master global access settings. Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] instead.
privateEndpointSubnetwork (deprecated)	string This item is deprecated! Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint_subnetwork instead.

PrivateClusterMasterGlobalAccessConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whenever master is accessible globally or not.

DatabaseEncryption

JSON representation
{ "keyName": string, "state": enum (State), "decryptionKeys": [ string ], "lastOperationErrors": [ { object (OperationError) } ], // Union field _current_state can be only one of the following: "currentState": enum (CurrentState) // End of list of possible types for union field _current_state. }

Fields
keyName	string Name of CloudKMS key to use for the encryption of secrets in etcd. Ex. projects/my-project/locations/global/keyRings/my-ring/cryptoKeys/my-key
state	enum (State) The desired state of etcd encryption.
decryptionKeys[]	string Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in key_name. Each item is a CloudKMS key resource.
lastOperationErrors[]	object (OperationError) Output only. Records errors seen during DatabaseEncryption update operations.
Union field _current_state. _current_state can be only one of the following:
currentState	enum (CurrentState) Output only. The current state of etcd encryption.

OperationError

JSON representation
{ "keyName": string, "errorMessage": string, "timestamp": string }

Fields
keyName	string CloudKMS key resource that had the error.
errorMessage	string Description of the error seen during the operation.
timestamp	string (Timestamp format) Time when the CloudKMS error was seen. Uses RFC 3339, where generated output will always be Z-normalized and use 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

VerticalPodAutoscaling

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Enables vertical pod autoscaling.

ShieldedNodes

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether Shielded Nodes features are enabled on all nodes in this cluster.

ReleaseChannel

JSON representation
{ "channel": enum (Channel) }

Fields
channel	enum (Channel) channel specifies which release channel the cluster is subscribed to.

WorkloadIdentityConfig

JSON representation
{ "workloadPool": string }

Fields
workloadPool	string The workload pool to attach all Kubernetes service accounts to.

MeshCertificates

JSON representation
{ "enableCertificates": boolean }

Fields
enableCertificates	boolean enable_certificates controls issuance of workload mTLS certificates. If set, the GKE Workload Identity Certificates controller and node agent will be deployed in the cluster, which can then be configured by creating a WorkloadCertificateConfig Custom Resource. Requires Workload Identity (workload_pool must be non-empty).

CostManagementConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether the feature is enabled or not.

NotificationConfig

JSON representation
{ "pubsub": { object (PubSub) } }

Fields
pubsub	object (PubSub) Notification config for Pub/Sub.

PubSub

JSON representation
{ "enabled": boolean, "topic": string, "filter": { object (Filter) } }

Fields
enabled	boolean Enable notifications for Pub/Sub.
topic	string The desired Pub/Sub topic to which notifications will be sent by GKE. Format is projects/{project}/topics/{topic}.
filter	object (Filter) Allows filtering to one or more specific event types. If no filter is specified, or if a filter is specified with no event types, all event types will be sent

Filter

JSON representation
{ "eventType": [ enum (EventType) ] }

Fields
eventType[]	enum (EventType) Event types to allowlist.

IdentityServiceConfig

JSON representation
{ "enabled": boolean }

Fields
enabled	boolean Whether to enable the Identity Service component

Autopilot

JSON representation
{ "enabled": boolean, "workloadPolicyConfig": { object (WorkloadPolicyConfig) }, "privilegedAdmissionConfig": { object (PrivilegedAdmissionConfig) } }

Fields
enabled	boolean Enable Autopilot
workloadPolicyConfig	object (WorkloadPolicyConfig) WorkloadPolicyConfig is the configuration related to GCW workload policy
privilegedAdmissionConfig	object (PrivilegedAdmissionConfig) PrivilegedAdmissionConfig is the configuration related to privileged admission control.

WorkloadPolicyConfig

JSON representation
{ // Union field _allow_net_admin can be only one of the following: "allowNetAdmin": boolean // End of list of possible types for union field _allow_net_admin. // Union field _autopilot_compatibility_auditing_enabled can be only one of the // following: "autopilotCompatibilityAuditingEnabled": boolean // End of list of possible types for union field // _autopilot_compatibility_auditing_enabled. }

Fields
Union field _allow_net_admin. _allow_net_admin can be only one of the following:
allowNetAdmin	boolean If true, workloads can use NET_ADMIN capability.
Union field _autopilot_compatibility_auditing_enabled. _autopilot_compatibility_auditing_enabled can be only one of the following:
autopilotCompatibilityAuditingEnabled	boolean If true, enables the GCW Auditor that audits workloads on standard clusters.

PrivilegedAdmissionConfig

JSON representation
{ "allowlistPaths": [ string ] }

Fields

allowlistPaths[]

string The customer allowlist Cloud Storage paths for the cluster. These paths are used with the --autopilot-privileged-admission flag to authorize privileged workloads in Autopilot clusters. Paths can be GKE-owned, in the format gke://<partner_name>/<app_name>/<allowlist_path>, or customer-owned, in the format gs://<bucket_name>/<allowlist_path>. Wildcards (*) are supported to authorize all allowlists under specific paths or directories. Example: gs://my-bucket/* will authorize all allowlists under the my-bucket bucket.

ParentProductConfig

JSON representation
{ "productName": string, "labels": { string: string, ... } }

Fields
productName	string Name of the parent product associated with the cluster.
labels	map (key: string, value: string) Labels contain the configuration of the parent product. An object containing a list of "key": value pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }.

LabelsEntry

JSON representation
{ "key": string, "value": string }

Fields
key	string
value	string

NodePoolDefaults

JSON representation
{ "nodeConfigDefaults": { object (NodeConfigDefaults) } }

Fields
nodeConfigDefaults	object (NodeConfigDefaults) Subset of NodeConfig message that has defaults.

NodeConfigDefaults

JSON representation
{ "gcfsConfig": { object (GcfsConfig) }, "loggingConfig": { object (NodePoolLoggingConfig) }, "containerdConfig": { object (ContainerdConfig) }, "nodeKubeletConfig": { object (NodeKubeletConfig) } }

Fields
gcfsConfig	object (GcfsConfig) GCFS (Google Container File System, also known as Riptide) options.
loggingConfig	object (NodePoolLoggingConfig) Logging configuration for node pools.
containerdConfig	object (ContainerdConfig) Parameters for containerd customization.
nodeKubeletConfig	object (NodeKubeletConfig) NodeKubeletConfig controls the defaults for new node-pools. Currently only insecure_kubelet_readonly_port_enabled can be set here.

LoggingConfig

JSON representation
{ "componentConfig": { object (LoggingComponentConfig) } }

Fields
componentConfig	object (LoggingComponentConfig) Logging components configuration

LoggingComponentConfig

JSON representation
{ "enableComponents": [ enum (Component) ] }

Fields
enableComponents[]	enum (Component) Select components to collect logs. An empty set would disable all logging.

MonitoringConfig

JSON representation
{ "componentConfig": { object (MonitoringComponentConfig) }, "managedPrometheusConfig": { object (ManagedPrometheusConfig) }, "advancedDatapathObservabilityConfig": { object (AdvancedDatapathObservabilityConfig) } }

Fields
componentConfig	object (MonitoringComponentConfig) Monitoring components configuration
managedPrometheusConfig	object (ManagedPrometheusConfig) Enable Google Cloud Managed Service for Prometheus in the cluster.
advancedDatapathObservabilityConfig	object (AdvancedDatapathObservabilityConfig) Configuration of Advanced Datapath Observability features.

MonitoringComponentConfig

JSON representation
{ "enableComponents": [ enum (Component) ] }

Fields
enableComponents[]	enum (Component) Select components to collect metrics. An empty set would disable all monitoring.

ManagedPrometheusConfig

JSON representation
{ "enabled": boolean, "autoMonitoringConfig": { object (AutoMonitoringConfig) } }

Fields
enabled	boolean Enable Managed Collection.
autoMonitoringConfig	object (AutoMonitoringConfig) GKE Workload Auto-Monitoring Configuration.

AutoMonitoringConfig

JSON representation
{ "scope": enum (Scope) }

Fields
scope	enum (Scope) Scope for GKE Workload Auto-Monitoring.

AdvancedDatapathObservabilityConfig

JSON representation
{ "enableMetrics": boolean, "relayMode": enum (RelayMode), // Union field _enable_relay can be only one of the following: "enableRelay": boolean // End of list of possible types for union field _enable_relay. }

Fields
enableMetrics	boolean Expose flow metrics on nodes
relayMode	enum (RelayMode) Method used to make Relay available
Union field _enable_relay. _enable_relay can be only one of the following:
enableRelay	boolean Enable Relay component

NodePoolAutoConfig

JSON representation
{ "networkTags": { object (NetworkTags) }, "resourceManagerTags": { object (ResourceManagerTags) }, "nodeKubeletConfig": { object (NodeKubeletConfig) }, "linuxNodeConfig": { object (LinuxNodeConfig) } }

Fields
networkTags	object (NetworkTags) The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster creation. Each tag within the list must comply with RFC1035.
resourceManagerTags	object (ResourceManagerTags) Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
nodeKubeletConfig	object (NodeKubeletConfig) NodeKubeletConfig controls the defaults for autoprovisioned node-pools. Currently only insecure_kubelet_readonly_port_enabled can be set here.
linuxNodeConfig	object (LinuxNodeConfig) Output only. Configuration options for Linux nodes.

NetworkTags

JSON representation
{ "tags": [ string ] }

Fields
tags[]	string List of network tags.

PodAutoscaling

JSON representation
{ // Union field _hpa_profile can be only one of the following: "hpaProfile": enum (HPAProfile) // End of list of possible types for union field _hpa_profile. }

Fields
Union field _hpa_profile. _hpa_profile can be only one of the following:
hpaProfile	enum (HPAProfile) Selected Horizontal Pod Autoscaling profile.

Fleet

JSON representation
{ "project": string, "membership": string, "preRegistered": boolean, "membershipType": enum (MembershipType) }

Fields
project	string The Fleet host project(project ID or project number) where this cluster will be registered to. This field cannot be changed after the cluster has been registered.
membership	string Output only. The full resource name of the registered fleet membership of the cluster, in the format //gkehub.googleapis.com/projects/*/locations/*/memberships/*.
preRegistered	boolean Output only. Whether the cluster has been registered through the fleet API.
membershipType	enum (MembershipType) The type of the cluster's fleet membership.

SecurityPostureConfig

JSON representation
{ // Union field _mode can be only one of the following: "mode": enum (Mode) // End of list of possible types for union field _mode. // Union field _vulnerability_mode can be only one of the following: "vulnerabilityMode": enum (VulnerabilityMode) // End of list of possible types for union field _vulnerability_mode. }

Fields
Union field _mode. _mode can be only one of the following:
mode	enum (Mode) Sets which mode to use for Security Posture features.
Union field _vulnerability_mode. _vulnerability_mode can be only one of the following:
vulnerabilityMode	enum (VulnerabilityMode) Sets which mode to use for vulnerability scanning.

ControlPlaneEndpointsConfig

JSON representation
{ "dnsEndpointConfig": { object (DNSEndpointConfig) }, "ipEndpointsConfig": { object (IPEndpointsConfig) } }

Fields
dnsEndpointConfig	object (DNSEndpointConfig) DNS endpoint configuration.
ipEndpointsConfig	object (IPEndpointsConfig) IP endpoints configuration.

DNSEndpointConfig

JSON representation

{ "endpoint": string, // Union field _allow_external_traffic can be only one of the following: "allowExternalTraffic": boolean // End of list of possible types for union field _allow_external_traffic. // Union field _enable_k8s_tokens_via_dns can be only one of the following: "enableK8sTokensViaDns": boolean // End of list of possible types for union field _enable_k8s_tokens_via_dns. // Union field _enable_k8s_certs_via_dns can be only one of the following: "enableK8sCertsViaDns": boolean // End of list of possible types for union field _enable_k8s_certs_via_dns. }

Fields
endpoint	string Output only. The cluster's DNS endpoint configuration. A DNS format address. This is accessible from the public internet. Ex: uid.us-central1.gke.goog. Always present, but the behavior may change according to the value of DNSEndpointConfig.allow_external_traffic.
Union field _allow_external_traffic. _allow_external_traffic can be only one of the following:
allowExternalTraffic	boolean Controls whether user traffic is allowed over this endpoint. Note that Google-managed services may still use the endpoint even if this is false.
Union field _enable_k8s_tokens_via_dns. _enable_k8s_tokens_via_dns can be only one of the following:
enableK8sTokensViaDns	boolean Controls whether the k8s token auth is allowed via DNS.
Union field _enable_k8s_certs_via_dns. _enable_k8s_certs_via_dns can be only one of the following:
enableK8sCertsViaDns	boolean Controls whether the k8s certs auth is allowed via DNS.

IPEndpointsConfig

JSON representation

{ "authorizedNetworksConfig": { object (MasterAuthorizedNetworksConfig) }, "publicEndpoint": string, "privateEndpoint": string, "privateEndpointSubnetwork": string, // Union field _enabled can be only one of the following: "enabled": boolean // End of list of possible types for union field _enabled. // Union field _enable_public_endpoint can be only one of the following: "enablePublicEndpoint": boolean // End of list of possible types for union field _enable_public_endpoint. // Union field _global_access can be only one of the following: "globalAccess": boolean // End of list of possible types for union field _global_access. }

Fields
authorizedNetworksConfig	object (MasterAuthorizedNetworksConfig) Configuration of authorized networks. If enabled, restricts access to the control plane based on source IP. It is invalid to specify both [Cluster.masterAuthorizedNetworksConfig][] and this field at the same time.
publicEndpoint	string Output only. The external IP address of this cluster's control plane. Only populated if enabled.
privateEndpoint	string Output only. The internal IP address of this cluster's control plane. Only populated if enabled.
privateEndpointSubnetwork	string Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. It is invalid to specify both [PrivateClusterConfig.privateEndpointSubnetwork][] and this field at the same time.
Union field _enabled. _enabled can be only one of the following:
enabled	boolean Controls whether to allow direct IP access.
Union field _enable_public_endpoint. _enable_public_endpoint can be only one of the following:
enablePublicEndpoint	boolean Controls whether the control plane allows access through a public IP. It is invalid to specify both [PrivateClusterConfig.enablePrivateEndpoint][] and this field at the same time.
Union field _global_access. _global_access can be only one of the following:
globalAccess	boolean Controls whether the control plane's private endpoint is accessible from sources in other regions. It is invalid to specify both PrivateClusterMasterGlobalAccessConfig.enabled and this field at the same time.

K8sBetaAPIConfig

JSON representation
{ "enabledApis": [ string ] }

Fields
enabledApis[]	string Enabled k8s beta APIs.

EnterpriseConfig

JSON representation
{ "clusterTier": enum (ClusterTier), "desiredTier": enum (ClusterTier) }

Fields
clusterTier	enum (ClusterTier) Output only. cluster_tier indicates the effective tier of the cluster.
desiredTier	enum (ClusterTier) desired_tier specifies the desired tier of the cluster.

SecretManagerConfig

JSON representation
{ // Union field _enabled can be only one of the following: "enabled": boolean // End of list of possible types for union field _enabled. // Union field _rotation_config can be only one of the following: "rotationConfig": { object (RotationConfig) } // End of list of possible types for union field _rotation_config. }

Fields
Union field _enabled. _enabled can be only one of the following:
enabled	boolean Enable/Disable Secret Manager Config.
Union field _rotation_config. _rotation_config can be only one of the following:
rotationConfig	object (RotationConfig) Rotation config for secret manager.

RotationConfig

JSON representation
{ // Union field _enabled can be only one of the following: "enabled": boolean // End of list of possible types for union field _enabled. // Union field _rotation_interval can be only one of the following: "rotationInterval": string // End of list of possible types for union field _rotation_interval. }

Fields
Union field _enabled. _enabled can be only one of the following:
enabled	boolean Whether the rotation is enabled.
Union field _rotation_interval. _rotation_interval can be only one of the following:
rotationInterval	string (Duration format) The interval between two consecutive rotations. Default rotation interval is 2 minutes. A duration in seconds with up to nine fractional digits, ending with 's'. Example: "3.5s".

CompliancePostureConfig

JSON representation
{ "complianceStandards": [ { object (ComplianceStandard) } ], // Union field _mode can be only one of the following: "mode": enum (Mode) // End of list of possible types for union field _mode. }

Fields
complianceStandards[]	object (ComplianceStandard) List of enabled compliance standards.
Union field _mode. _mode can be only one of the following:
mode	enum (Mode) Defines the enablement mode for Compliance Posture.

ComplianceStandard

JSON representation
{ // Union field _standard can be only one of the following: "standard": string // End of list of possible types for union field _standard. }

Fields
Union field _standard. _standard can be only one of the following:
standard	string Name of the compliance standard.

UserManagedKeysConfig

JSON representation
{ "clusterCa": string, "etcdApiCa": string, "etcdPeerCa": string, "serviceAccountSigningKeys": [ string ], "serviceAccountVerificationKeys": [ string ], "aggregationCa": string, "controlPlaneDiskEncryptionKey": string, "controlPlaneDiskEncryptionKeyVersions": [ string ], "gkeopsEtcdBackupEncryptionKey": string }

Fields
clusterCa	string The Certificate Authority Service caPool to use for the cluster CA in this cluster.
etcdApiCa	string Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.
etcdPeerCa	string Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.
serviceAccountSigningKeys[]	string The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
serviceAccountVerificationKeys[]	string The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: projects/{project}/locations/{location}/keyRings/{keyring}/cryptoKeys/{cryptoKey}/cryptoKeyVersions/{cryptoKeyVersion}
aggregationCa	string The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
controlPlaneDiskEncryptionKey	string The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.
controlPlaneDiskEncryptionKeyVersions[]	string Output only. All of the versions of the Cloud KMS cryptoKey that are used by Confidential Hyperdisks on the control plane nodes.
gkeopsEtcdBackupEncryptionKey	string Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.

RBACBindingConfig

JSON representation

{ // Union field _enable_insecure_binding_system_unauthenticated can be only one // of the following: "enableInsecureBindingSystemUnauthenticated": boolean // End of list of possible types for union field // _enable_insecure_binding_system_unauthenticated. // Union field _enable_insecure_binding_system_authenticated can be only one of // the following: "enableInsecureBindingSystemAuthenticated": boolean // End of list of possible types for union field // _enable_insecure_binding_system_authenticated. }

Fields
Union field _enable_insecure_binding_system_unauthenticated. _enable_insecure_binding_system_unauthenticated can be only one of the following:
enableInsecureBindingSystemUnauthenticated	boolean Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.
Union field _enable_insecure_binding_system_authenticated. _enable_insecure_binding_system_authenticated can be only one of the following:
enableInsecureBindingSystemAuthenticated	boolean Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.

GkeAutoUpgradeConfig

JSON representation
{ "patchMode": enum (PatchMode) }

Fields
patchMode	enum (PatchMode) PatchMode specifies how auto upgrade patch builds should be selected.

AnonymousAuthenticationConfig

JSON representation
{ "mode": enum (Mode) }

Fields
mode	enum (Mode) Defines the mode of limiting anonymous access in the cluster.

ManagedOpenTelemetryConfig

JSON representation
{ // Union field _scope can be only one of the following: "scope": enum (Scope) // End of list of possible types for union field _scope. }

Fields
Union field _scope. _scope can be only one of the following:
scope	enum (Scope) Scope of the Managed OpenTelemetry pipeline.

Tool Annotations

Destructive Hint: ❌ | Idempotent Hint: ✅ | Read Only Hint: ✅ | Open World Hint: ❌