API documentation for
AcceleratorConfig represents a Hardware Accelerator request.
Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
Specifies options for controlling advanced machine features.
Configuration for returning group information from authenticators.
AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed.
Autopilot is the configuration for Autopilot settings on the cluster.
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
Configuration for Binary Authorization.
CancelOperationRequest cancels a single operation.
Configuration for client certificates on the cluster.
Configuration options for the Cloud Run feature.
A Google Kubernetes Engine cluster.
ClusterAutoscaling contains global, per-cluster information required by Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs.
Telemetry integration for the cluster.
ClusterUpdate describes an update to the cluster. Exactly one update can be applied to a cluster with each request, so at most one field can be provided.
CompleteIPRotationRequest moves the cluster master back into single-IP mode.
ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs.
Configuration options for the Config Connector add-on.
CreateClusterRequest creates a cluster.
CreateNodePoolRequest creates a node pool for a cluster.
DNSConfig contains the desired set of options for configuring clusterDNS.
Time window specified for daily maintenance operations.
Configuration of etcd encryption.
The datapath provider selects the implementation of the Kubernetes networking // model for service resolution and network policy enforcement.
DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
DeleteClusterRequest deletes a cluster.
DeleteNodePoolRequest deletes a node pool for a cluster.
Configuration for NodeLocal DNSCache
EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.
Configuration for the Compute Engine PD CSI driver.
GcfsConfig contains configurations of Google Container File System.
Configuration for the GCP Filestore CSI driver.
GetClusterRequest gets the settings of a cluster.
GetJSONWebKeysRequest gets the public component of the keys used by the cluster to sign token requests. This will be the jwks_uri for the discover document returned by getOpenIDConfig. See the OpenID Connect Discovery 1.0 specification for details.
GetJSONWebKeysResponse is a valid JSON Web Key Set as specififed in rfc 7517
GetNodePoolRequest retrieves a node pool for a cluster.
GetOpenIDConfigRequest gets the OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
GetOpenIDConfigResponse is an OIDC discovery document for the cluster. See the OpenID Connect Discovery 1.0 specification for details.
GetOperationRequest gets a single operation.
Gets the current Kubernetes Engine service configuration.
Configuration for the Backup for GKE Agent.
Configuration options 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.
Configuration options for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster.
Configuration for controlling how IPs are allocated in the cluster.
IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API
IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster.
Configuration options for Istio addon.
Jwk is a JSON Web Key as specified in RFC 7517
Configuration options for the KALM addon.
Configuration for the Kubernetes Dashboard.
Configuration for the legacy Attribute Based Access Control authorization mode.
Parameters that can be configured on Linux nodes.
ListClustersRequest lists clusters.
ListClustersResponse is the result of ListClustersRequest.
ListLocationsRequest is used to request the locations that offer GKE.
ListLocationsResponse returns the list of all GKE locations and their recommendation state.
ListNodePoolsRequest lists the node pool(s) for a cluster.
ListNodePoolsResponse is the result of ListNodePoolsRequest.
ListOperationsRequest lists operations.
ListOperationsResponse is the result of ListOperationsRequest.
ListUsableSubnetworksRequest requests the list of usable subnetworks. available to a user for creating clusters.
ListUsableSubnetworksResponse is the response of ListUsableSubnetworksRequest.
Location returns the location name, and if the location is recommended for GKE cluster scheduling.
LoggingComponentConfig is cluster logging component configuration.
LoggingConfig is cluster logging configuration.
Represents the Maintenance exclusion option.
MaintenancePolicy defines the maintenance policy to be used for the cluster.
MaintenanceWindow defines the maintenance window to be used for the cluster.
This message has
oneof_ fields (mutually exclusive fields).
For each oneof, at most one member field can be set at the same time.
Setting any member of the oneof automatically clears all other
ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.
Master is the configuration for components on master.
The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.
Configuration options for the master authorized networks feature. Enabled master authorized networks will disallow all external traffic to access Kubernetes master through HTTPS except traffic from the given CIDR blocks, Google Compute Engine Public IPs and Google Prod IPs.
Constraints applied to pods.
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
MonitoringComponentConfig is cluster monitoring component configuration.
MonitoringConfig is cluster monitoring configuration.
NetworkConfig reports the relative names of network & subnetwork.
Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
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.
Collection of Compute Engine network tags that can be applied to a
node's underlying VM instance. (See
tags field in
Parameters that describe the nodes in a cluster.
Subset of NodeConfig message that has defaults.
Node kubelet configs.
Collection of node-level
NodeManagement defines the set of node management services turned on for the node pool.
Parameters for node pool-level network config.
NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload. These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade.
maxUnavailable controls the number of nodes that can be simultaneously unavailable.
maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes.
(maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time).
Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.)
Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional (upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available.
NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage.
Subset of Nodepool message that has defaults.
Kubernetes taint is comprised of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
for more information, including usage and the valid values.
Collection of Kubernetes
NotificationConfig is the configuration of notifications.
This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
Information about operation (or operation stage) progress.
Configuration for the PodSecurityPolicy feature.
Configuration options for private clusters.
Configuration for controlling master global access settings.
PrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.
Represents an arbitrary window of time that recurs.
ReleaseChannel indicates which release channel a cluster is subscribed to. Release channels are arranged in order of risk. When a cluster is subscribed to a release channel, Google maintains both the master version and the node version. Node auto-upgrade defaults to true and cannot be disabled.
is the configuration of desired reservation which instances could
take capacity from.
Contains information about amount of some resource in the cluster. For memory, value should be in GB.
Configuration for exporting cluster resource usages.
RollbackNodePoolUpgradeRequest rollbacks the previously Aborted or Failed NodePool upgrade. This will be an no-op if the last upgrade successfully completed.
SandboxConfig contains configurations of the sandbox to use for the node.
SecurityBulletinEvent is a notification sent to customers when a security bulletin has been posted that they are vulnerable to.
Kubernetes Engine service configuration.
Config to block services with externalIPs field.
SetAddonsRequest sets the addons associated with the cluster.
SetLabelsRequest sets the Google Cloud Platform labels on a Google Container Engine cluster, which will in turn set them for Google Compute Engine resources used by that cluster
SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
SetLocationsRequest sets the locations of the cluster.
SetLoggingServiceRequest sets the logging service of a cluster.
SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
SetMasterAuthRequest updates the admin password of a cluster.
SetMonitoringServiceRequest sets the monitoring service of a cluster.
SetNetworkPolicyRequest enables/disables network policy for a cluster.
SetNodePoolAutoscalingRequest sets the autoscaler settings of a node pool.
SetNodePoolManagementRequest sets the node management properties of a node pool.
SetNodePoolSizeRequest sets the size of a node pool.
A set of Shielded Instance options.
Configuration of Shielded Nodes feature.
StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
Represents an arbitrary window of time.
Configuration for Cloud TPU.
UpdateClusterRequest updates the settings of a cluster.
UpdateMasterRequest updates the master of the cluster.
SetNodePoolVersionRequest updates the version of a node pool.
UpgradeAvailableEvent is a notification sent to customers when a new available version is released.
UpgradeEvent is a notification sent to customers by the cluster server when a resource is upgrading.
UpgradeResourceType is the resource type that is upgrading. It is used in upgrade notifications.
UsableSubnetwork resource returns the subnetwork name, its associated network and the primary CIDR range.
Secondary IP range of a usable subnetwork.
VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.
Configuration of gVNIC feature.
Windows server versions.
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.