- Resource: Cluster
- JSON representation
- MasterAuth
- ClientCertificateConfig
- AddonsConfig
- HttpLoadBalancing
- HorizontalPodAutoscaling
- KubernetesDashboard
- NetworkPolicyConfig
- CloudRunConfig
- LoadBalancerType
- DnsCacheConfig
- ConfigConnectorConfig
- GcePersistentDiskCsiDriverConfig
- GcpFilestoreCsiDriverConfig
- GkeBackupAgentConfig
- GcsFuseCsiDriverConfig
- StatefulHAConfig
- ParallelstoreCsiDriverConfig
- RayOperatorConfig
- RayClusterLoggingConfig
- RayClusterMonitoringConfig
- LegacyAbac
- NetworkPolicy
- Provider
- IPAllocationPolicy
- StackType
- IPv6AccessType
- AdditionalPodRangesConfig
- RangeInfo
- MasterAuthorizedNetworksConfig
- CidrBlock
- MaintenancePolicy
- MaintenanceWindow
- DailyMaintenanceWindow
- RecurringTimeWindow
- TimeWindow
- MaintenanceExclusionOptions
- Scope
- BinaryAuthorization
- EvaluationMode
- ClusterAutoscaling
- ResourceLimit
- AutoscalingProfile
- AutoprovisioningNodePoolDefaults
- NetworkConfig
- DefaultSnatStatus
- DatapathProvider
- PrivateIPv6GoogleAccess
- DNSConfig
- Provider
- DNSScope
- ServiceExternalIPsConfig
- GatewayAPIConfig
- Channel
- ClusterNetworkPerformanceConfig
- Tier
- InTransitEncryptionConfig
- ResourceUsageExportConfig
- BigQueryDestination
- ConsumptionMeteringConfig
- AuthenticatorGroupsConfig
- PrivateClusterConfig
- PrivateClusterMasterGlobalAccessConfig
- DatabaseEncryption
- State
- CurrentState
- OperationError
- VerticalPodAutoscaling
- ShieldedNodes
- ReleaseChannel
- Channel
- WorkloadIdentityConfig
- MeshCertificates
- CostManagementConfig
- NotificationConfig
- PubSub
- Filter
- EventType
- IdentityServiceConfig
- Status
- Autopilot
- WorkloadPolicyConfig
- ParentProductConfig
- NodePoolDefaults
- NodeConfigDefaults
- LoggingConfig
- LoggingComponentConfig
- Component
- MonitoringConfig
- MonitoringComponentConfig
- Component
- ManagedPrometheusConfig
- AdvancedDatapathObservabilityConfig
- RelayMode
- NodePoolAutoConfig
- NetworkTags
- Fleet
- SecurityPostureConfig
- Mode
- VulnerabilityMode
- ControlPlaneEndpointsConfig
- DNSEndpointConfig
- IPEndpointsConfig
- K8sBetaAPIConfig
- EnterpriseConfig
- ClusterTier
- SecretManagerConfig
- CompliancePostureConfig
- Mode
- ComplianceStandard
- UserManagedKeysConfig
- RBACBindingConfig
- Methods
Resource: Cluster
A Google Kubernetes Engine cluster.
JSON representation |
---|
{ "name": string, "description": string, "initialNodeCount": integer, "nodeConfig": { object ( |
Fields | |
---|---|
name |
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:
|
description |
An optional description of this cluster. |
initialNodeCount |
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 "nodePool" object, since this configuration (along with the "nodeConfig") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a nodePool at the same time. This field is deprecated, use nodePool.initial_node_count instead. |
nodeConfig |
Parameters used in creating the cluster's nodes. For requests, this field should only be used in lieu of a "nodePool" object, since this configuration (along with the "initialNodeCount") will be used to create a "NodePool" object with an auto-generated name. Do not use this and a nodePool 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 If unspecified, the defaults are used. This field is deprecated, use nodePool.config instead. |
masterAuth |
The authentication information for accessing the master endpoint. If unspecified, the defaults are used: For clusters before v1.12, if masterAuth is unspecified, |
loggingService |
The logging service the cluster should use to write logs. Currently available options:
If left as an empty string, |
monitoringService |
The monitoring service the cluster should use to write metrics. Currently available options:
If left as an empty string, |
network |
The name of the Google Compute Engine network to which the cluster is connected. If left unspecified, the |
clusterIpv4Cidr |
The IP address range of the container pods in this cluster, in CIDR notation (e.g. |
addonsConfig |
Configurations for the various addons available to run in the cluster. |
subnetwork |
The name of the Google Compute Engine subnetwork to which the cluster is connected. |
nodePools[] |
The node pools associated with this cluster. This field should not be set if "nodeConfig" or "initialNodeCount" are specified. |
locations[] |
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 |
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. |
resourceLabels |
The resource labels for the cluster to use to annotate any related Google Compute Engine resources. An object containing a list of |
labelFingerprint |
The fingerprint of the set of labels for this cluster. |
legacyAbac |
Configuration for the legacy ABAC authorization mode. |
networkPolicy |
Configuration options for the NetworkPolicy feature. |
ipAllocationPolicy |
Configuration for cluster IP allocation. |
masterAuthorizedNetworksConfig |
The configuration options for master authorized networks feature. Deprecated: Use |
maintenancePolicy |
Configure the maintenance policy for this cluster. |
binaryAuthorization |
Configuration for Binary Authorization. |
autoscaling |
Cluster-level autoscaling configuration. |
networkConfig |
Configuration for cluster networking. |
defaultMaxPodsConstraint |
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 |
Configuration for exporting resource usages. Resource usage export is disabled when this config is unspecified. |
authenticatorGroupsConfig |
Configuration controlling RBAC group membership information. |
privateClusterConfig |
Configuration for private cluster. |
databaseEncryption |
Configuration of etcd encryption. |
verticalPodAutoscaling |
Cluster-level Vertical Pod Autoscaling configuration. |
shieldedNodes |
Shielded Nodes configuration. |
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 |
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. |
meshCertificates |
Configuration for issuance of mTLS keys and certificates to Kubernetes pods. |
costManagementConfig |
Configuration for the fine-grained cost management feature. |
notificationConfig |
Notification configuration of the cluster. |
confidentialNodes |
Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled. |
identityServiceConfig |
Configuration for Identity Service component. |
selfLink |
Output only. Server-defined URL for the resource. |
zone |
Output only. The name of the Google Compute Engine zone in which the cluster resides. This field is deprecated, use location instead. |
endpoint |
Output only. The IP address of this cluster's master endpoint. The endpoint can be accessed from the internet at See the |
initialClusterVersion |
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:
|
currentMasterVersion |
Output only. The current software version of the master endpoint. |
currentNodeVersion |
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 |
Output only. The time the cluster was created, in RFC3339 text format. |
status |
Output only. The current status of this cluster. |
statusMessage |
Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available. |
nodeIpv4CidrSize |
Output only. The size of the address space on each node for hosting containers. This is provisioned from within the |
servicesIpv4Cidr |
Output only. The IP address range of the Kubernetes services in this cluster, in CIDR notation (e.g. |
instanceGroupUrls[] |
Output only. Deprecated. Use nodePools.instance_group_urls. |
currentNodeCount |
Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information. |
expireTime |
Output only. The time the cluster will be automatically deleted in RFC3339 text format. |
location |
Output only. The name of the Google Compute Engine zone or region in which the cluster resides. |
enableTpu |
Enable the ability to use Cloud TPUs in this cluster. |
tpuIpv4CidrBlock |
Output only. The IP address range of the Cloud TPUs in this cluster, in CIDR notation (e.g. |
conditions[] |
Which conditions caused the current cluster state. |
autopilot |
Autopilot configuration for the cluster. |
id |
Output only. Unique id for the cluster. |
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 |
Logging configuration for the cluster. |
monitoringConfig |
Monitoring configuration for the cluster. |
nodePoolAutoConfig |
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. |
etag |
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 |
Fleet information for the cluster. |
securityPostureConfig |
Enable/Disable Security Posture API features for the cluster. |
controlPlaneEndpointsConfig |
Configuration for all cluster's control plane endpoints. |
enableK8sBetaApis |
Beta APIs Config |
enterpriseConfig |
GKE Enterprise Configuration. |
secretManagerConfig |
Secret CSI driver configuration. |
compliancePostureConfig |
Enable/Disable Compliance Posture features for the cluster. |
nodePoolDefaults |
Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. |
satisfiesPzs |
Output only. Reserved for future use. |
satisfiesPzi |
Output only. Reserved for future use. |
userManagedKeysConfig |
The Custom keys configuration for the cluster. |
rbacBindingConfig |
RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. |
MasterAuth
The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates.
JSON representation |
---|
{
"username": string,
"password": string,
"clientCertificateConfig": {
object ( |
Fields | |
---|---|
username |
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 |
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 |
Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued. |
clusterCaCertificate |
Output only. Base64-encoded public certificate that is the root of trust for the cluster. |
clientCertificate |
Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if clientCertificateConfig is set. |
clientKey |
Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint. |
ClientCertificateConfig
Configuration for client certificates on the cluster.
JSON representation |
---|
{ "issueClientCertificate": boolean } |
Fields | |
---|---|
issueClientCertificate |
Issue a client certificate. |
AddonsConfig
Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality.
JSON representation |
---|
{ "httpLoadBalancing": { object ( |
Fields | |
---|---|
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 |
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 |
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 |
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 |
Configuration for the Cloud Run addon, which allows the user to use a managed Knative service. |
dnsCacheConfig |
Configuration for NodeLocalDNS, a dns cache running on cluster nodes |
configConnectorConfig |
Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API |
gcePersistentDiskCsiDriverConfig |
Configuration for the Compute Engine Persistent Disk CSI driver. |
gcpFilestoreCsiDriverConfig |
Configuration for the GCP Filestore CSI driver. |
gkeBackupAgentConfig |
Configuration for the Backup for GKE agent addon. |
gcsFuseCsiDriverConfig |
Configuration for the Cloud Storage Fuse CSI driver. |
statefulHaConfig |
Optional. Configuration for the StatefulHA add-on. |
parallelstoreCsiDriverConfig |
Configuration for the Cloud Storage Parallelstore CSI driver. |
rayOperatorConfig |
Optional. Configuration for Ray Operator addon. |
HttpLoadBalancing
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.
JSON representation |
---|
{ "disabled": boolean } |
Fields | |
---|---|
disabled |
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
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.
JSON representation |
---|
{ "disabled": boolean } |
Fields | |
---|---|
disabled |
Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring. |
KubernetesDashboard
Configuration for the Kubernetes Dashboard.
JSON representation |
---|
{ "disabled": boolean } |
Fields | |
---|---|
disabled |
Whether the Kubernetes Dashboard is enabled for this cluster. |
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.
JSON representation |
---|
{ "disabled": boolean } |
Fields | |
---|---|
disabled |
Whether NetworkPolicy is enabled for this cluster. |
CloudRunConfig
Configuration options for the Cloud Run feature.
JSON representation |
---|
{
"disabled": boolean,
"loadBalancerType": enum ( |
Fields | |
---|---|
disabled |
Whether Cloud Run addon is enabled for this cluster. |
loadBalancerType |
Which load balancer type is installed for Cloud Run. |
LoadBalancerType
Load balancer type of ingress service of Cloud Run.
Enums | |
---|---|
LOAD_BALANCER_TYPE_UNSPECIFIED |
Load balancer type for Cloud Run is unspecified. |
LOAD_BALANCER_TYPE_EXTERNAL |
Install external load balancer for Cloud Run. |
LOAD_BALANCER_TYPE_INTERNAL |
Install internal load balancer for Cloud Run. |
DnsCacheConfig
Configuration for NodeLocal DNSCache
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether NodeLocal DNSCache is enabled for this cluster. |
ConfigConnectorConfig
Configuration options for the Config Connector add-on.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether Cloud Connector is enabled for this cluster. |
GcePersistentDiskCsiDriverConfig
Configuration for the Compute Engine PD CSI driver.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the Compute Engine PD CSI driver is enabled for this cluster. |
GcpFilestoreCsiDriverConfig
Configuration for the GCP Filestore CSI driver.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the GCP Filestore CSI driver is enabled for this cluster. |
GkeBackupAgentConfig
Configuration for the Backup for GKE Agent.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the Backup for GKE agent is enabled for this cluster. |
GcsFuseCsiDriverConfig
Configuration for the Cloud Storage Fuse CSI driver.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the Cloud Storage Fuse CSI driver is enabled for this cluster. |
StatefulHAConfig
Configuration for the Stateful HA add-on.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the Stateful HA add-on is enabled for this cluster. |
ParallelstoreCsiDriverConfig
Configuration for the Cloud Storage Parallelstore CSI driver.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster. |
RayOperatorConfig
Configuration options for the Ray Operator add-on.
JSON representation |
---|
{ "enabled": boolean, "rayClusterLoggingConfig": { object ( |
Fields | |
---|---|
enabled |
Whether the Ray Operator addon is enabled for this cluster. |
rayClusterLoggingConfig |
Optional. Logging configuration for Ray clusters. |
rayClusterMonitoringConfig |
Optional. Monitoring configuration for Ray clusters. |
RayClusterLoggingConfig
RayClusterLoggingConfig specifies configuration of Ray logging.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Enable log collection for Ray clusters. |
RayClusterMonitoringConfig
RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Enable metrics collection for Ray clusters. |
LegacyAbac
Configuration for the legacy Attribute Based Access Control authorization mode.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
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
Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/
JSON representation |
---|
{
"provider": enum ( |
Fields | |
---|---|
provider |
The selected network policy provider. |
enabled |
Whether network policy is enabled on the cluster. |
Provider
Allowed Network Policy providers.
Enums | |
---|---|
PROVIDER_UNSPECIFIED |
Not set |
CALICO |
Tigera (Calico Felix). |
IPAllocationPolicy
Configuration for controlling how IPs are allocated in the cluster.
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 ( |
Fields | |
---|---|
useIpAliases |
Whether alias IPs will be used for pod IPs in the cluster. This is used in conjunction with useRoutes. It cannot be true if useRoutes is true. If both useIpAliases and useRoutes are false, then the server picks the default IP allocation mode |
createSubnetwork |
Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when |
subnetworkName |
A custom subnetwork name to be used if |
clusterIpv4Cidr |
This field is deprecated, use clusterIpv4CidrBlock. |
nodeIpv4Cidr |
This field is deprecated, use nodeIpv4CidrBlock. |
servicesIpv4Cidr |
This field is deprecated, use servicesIpv4CidrBlock. |
clusterSecondaryRangeName |
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 useIpAliases is true and createSubnetwork is false. |
servicesSecondaryRangeName |
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 useIpAliases is true and createSubnetwork is false. |
clusterIpv4CidrBlock |
The IP address range for the cluster pod IPs. If this field is set, then This field is only applicable when Set to blank to have a range chosen with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
nodeIpv4CidrBlock |
The IP address range of the instance IPs in this cluster. This is applicable only if Set to blank to have a range chosen with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
servicesIpv4CidrBlock |
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 Set to blank to have a range chosen with the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
tpuIpv4CidrBlock |
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 If unspecified, the range will use the default size. Set to /netmask (e.g. Set to a CIDR notation (e.g. |
useRoutes |
Whether routes will be used for pod IPs in the cluster. This is used in conjunction with useIpAliases. It cannot be true if useIpAliases is true. If both useIpAliases and useRoutes are false, then the server picks the default IP allocation mode |
stackType |
The IP stack type of the cluster |
ipv6AccessType |
The ipv6 access type (internal or external) when createSubnetwork is true |
podCidrOverprovisionConfig |
[PRIVATE FIELD] Pod CIDR size overprovisioning config for the cluster. Pod CIDR size per node depends on maxPodsPerNode. By default, the value of maxPodsPerNode is doubled and then rounded off to next power of 2 to get the size of pod CIDR block per node. Example: maxPodsPerNode 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: maxPodsPerNode of 30 will result in 32 IPs (/27) when overprovisioning is disabled. |
subnetIpv6CidrBlock |
Output only. The subnet's IPv6 CIDR block used by nodes and pods. |
servicesIpv6CidrBlock |
Output only. The services IPv6 CIDR block for the cluster. |
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 |
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. |
StackType
Possible values for IP stack type
Enums | |
---|---|
STACK_TYPE_UNSPECIFIED |
Default value, will be defaulted as IPV4 only |
IPV4 |
Cluster is IPV4 only |
IPV4_IPV6 |
Cluster can use both IPv4 and IPv6 |
IPv6AccessType
Possible values for IPv6 access type
Enums | |
---|---|
IPV6_ACCESS_TYPE_UNSPECIFIED |
Default value, will be defaulted as type external. |
INTERNAL |
Access type internal (all v6 addresses are internal IPs) |
EXTERNAL |
Access type external (all v6 addresses are external IPs) |
AdditionalPodRangesConfig
AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message.
JSON representation |
---|
{
"podRangeNames": [
string
],
"podRangeInfo": [
{
object ( |
Fields | |
---|---|
podRangeNames[] |
Name for pod secondary ipv4 range which has the actual range defined ahead. |
podRangeInfo[] |
Output only. Information for additional pod range. |
RangeInfo
RangeInfo contains the range name and the range utilization by this cluster.
JSON representation |
---|
{ "rangeName": string, "utilization": number } |
Fields | |
---|---|
rangeName |
Output only. Name of a range. |
utilization |
Output only. The utilization of the range. |
MasterAuthorizedNetworksConfig
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.
JSON representation |
---|
{
"enabled": boolean,
"cidrBlocks": [
{
object ( |
Fields | |
---|---|
enabled |
Whether or not master authorized networks is enabled. |
cidrBlocks[] |
cidrBlocks define up to 50 external networks that could access Kubernetes master through HTTPS. |
gcpPublicCidrsAccessEnabled |
Whether master is accessbile via Google Compute Engine Public IP addresses. |
privateEndpointEnforcementEnabled |
Whether master authorized networks is enforced on private endpoint or not. |
CidrBlock
CidrBlock contains an optional name and one CIDR block.
JSON representation |
---|
{ "displayName": string, "cidrBlock": string } |
Fields | |
---|---|
displayName |
displayName is an optional field for users to identify CIDR blocks. |
cidrBlock |
cidrBlock must be specified in CIDR notation. |
MaintenancePolicy
MaintenancePolicy defines the maintenance policy to be used for the cluster.
JSON representation |
---|
{
"window": {
object ( |
Fields | |
---|---|
window |
Specifies the maintenance window in which maintenance may be performed. |
resourceVersion |
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 |
MaintenanceWindow
MaintenanceWindow defines the maintenance window to be used for the cluster.
JSON representation |
---|
{ "maintenanceExclusions": { string: { object ( |
Fields | |
---|---|
maintenanceExclusions |
Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows. An object containing a list of |
Union field
|
|
dailyMaintenanceWindow |
DailyMaintenanceWindow specifies a daily maintenance operation window. |
recurringWindow |
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
Time window specified for daily maintenance operations.
JSON representation |
---|
{ "startTime": string, "duration": string } |
Fields | |
---|---|
startTime |
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 |
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
Represents an arbitrary window of time that recurs.
JSON representation |
---|
{
"window": {
object ( |
Fields | |
---|---|
window |
The window of the first recurrence. |
recurrence |
An RRULE (https://tools.ietf.org/html/rfc5545#section-3.8.5.3) for how this window reccurs. 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: To repeat some window daily (equivalent to the DailyMaintenanceWindow): For the first weekend of every month: 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:
Windows can span multiple days. Eg, to make the window encompass every weekend from midnight Saturday till the last minute of Sunday UTC:
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
Represents an arbitrary window of time.
JSON representation |
---|
{ "startTime": string, "endTime": string, // Union field |
Fields | |
---|---|
startTime |
The time that the window first starts. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
endTime |
The time that the window ends. The end time should take place after the start time. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
Union field
|
|
maintenanceExclusionOptions |
MaintenanceExclusionOptions provides maintenance exclusion related options. |
MaintenanceExclusionOptions
Represents the Maintenance exclusion option.
JSON representation |
---|
{
"scope": enum ( |
Fields | |
---|---|
scope |
Scope specifies the upgrade scope which upgrades are blocked by the exclusion. |
Scope
Scope of exclusion.
Enums | |
---|---|
NO_UPGRADES |
NO_UPGRADES excludes all upgrades, including patch upgrades and minor upgrades across control planes and nodes. This is the default exclusion behavior. |
NO_MINOR_UPGRADES |
NO_MINOR_UPGRADES excludes all minor upgrades for the cluster, only patches are allowed. |
NO_MINOR_OR_NODE_UPGRADES |
NO_MINOR_OR_NODE_UPGRADES excludes all minor upgrades for the cluster, and also exclude all node pool upgrades. Only control plane patches are allowed. |
BinaryAuthorization
Configuration for Binary Authorization.
JSON representation |
---|
{
"enabled": boolean,
"evaluationMode": enum ( |
Fields | |
---|---|
enabled |
This field is deprecated. Leave this unset and instead configure BinaryAuthorization using evaluationMode. If evaluationMode is set to anything other than EVALUATION_MODE_UNSPECIFIED, this field is ignored. |
evaluationMode |
Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED. |
EvaluationMode
Binary Authorization mode of operation.
Enums | |
---|---|
EVALUATION_MODE_UNSPECIFIED |
Default value |
DISABLED |
Disable BinaryAuthorization |
PROJECT_SINGLETON_POLICY_ENFORCE |
Enforce Kubernetes admission requests with BinaryAuthorization using the project's singleton policy. This is equivalent to setting the enabled boolean to true. |
ClusterAutoscaling
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.
JSON representation |
---|
{ "enableNodeAutoprovisioning": boolean, "resourceLimits": [ { object ( |
Fields | |
---|---|
enableNodeAutoprovisioning |
Enables automatic node pool creation and deletion. |
resourceLimits[] |
Contains global constraints regarding minimum and maximum amount of resources in the cluster. |
autoscalingProfile |
Defines autoscaling behaviour. |
autoprovisioningNodePoolDefaults |
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. |
autoprovisioningLocations[] |
The list of Google Compute Engine zones in which the NodePool's nodes can be created by NAP. |
ResourceLimit
Contains information about amount of some resource in the cluster. For memory, value should be in GB.
JSON representation |
---|
{ "resourceType": string, "minimum": string, "maximum": string } |
Fields | |
---|---|
resourceType |
Resource name "cpu", "memory" or gpu-specific string. |
minimum |
Minimum amount of the resource in the cluster. |
maximum |
Maximum amount of the resource in the cluster. |
AutoscalingProfile
Defines possible options for autoscalingProfile field.
Enums | |
---|---|
PROFILE_UNSPECIFIED |
No change to autoscaling configuration. |
OPTIMIZE_UTILIZATION |
Prioritize optimizing utilization of resources. |
BALANCED |
Use default (balanced) autoscaling configuration. |
AutoprovisioningNodePoolDefaults
AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
JSON representation |
---|
{ "oauthScopes": [ string ], "serviceAccount": string, "upgradeSettings": { object ( |
Fields | |
---|---|
oauthScopes[] |
Scopes that are used by NAP when creating node pools. |
serviceAccount |
The Google Cloud Platform Service Account to be used by the node VMs. |
upgradeSettings |
Specifies the upgrade settings for NAP created node pools |
management |
Specifies the node management options for NAP created node-pools. |
minCpuPlatform |
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, minCpuPlatform should be specified using |
diskSizeGb |
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 |
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 |
Shielded Instance options. |
bootDiskKmsKey |
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 |
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. |
insecureKubeletReadonlyPortEnabled |
Enable or disable Kubelet read only port. |
NetworkConfig
NetworkConfig reports the relative names of network & subnetwork.
JSON representation |
---|
{ "network": string, "subnetwork": string, "enableIntraNodeVisibility": boolean, "defaultSnatStatus": { object ( |
Fields | |
---|---|
network |
Output only. The relative name of the Google Compute Engine |
subnetwork |
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 |
Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network. |
defaultSnatStatus |
Whether the cluster disables default in-node sNAT rules. In-node sNAT rules will be disabled when defaultSnatStatus 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 |
Whether L4ILB Subsetting is enabled for this cluster. |
datapathProvider |
The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation. |
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 |
DNSConfig contains clusterDNS config for this cluster. |
serviceExternalIpsConfig |
ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not. |
gatewayApiConfig |
GatewayAPIConfig contains the desired config of Gateway API on this cluster. |
enableMultiNetworking |
Whether multi-networking is enabled for this cluster. |
networkPerformanceConfig |
Network bandwidth tier configuration. |
enableFqdnNetworkPolicy |
Whether FQDN Network Policy is enabled on this cluster. |
inTransitEncryptionConfig |
Specify the details of in-transit encryption. Now named inter-node transparent encryption. |
enableCiliumClusterwideNetworkPolicy |
Whether CiliumClusterwideNetworkPolicy is enabled on this cluster. |
defaultEnablePrivateNodes |
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 |
DefaultSnatStatus
DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster.
JSON representation |
---|
{ "disabled": boolean } |
Fields | |
---|---|
disabled |
Disables cluster default sNAT rules. |
DatapathProvider
The datapath provider selects the implementation of the Kubernetes networking model for service resolution and network policy enforcement.
Enums | |
---|---|
DATAPATH_PROVIDER_UNSPECIFIED |
Default value. |
LEGACY_DATAPATH |
Use the IPTables implementation based on kube-proxy. |
ADVANCED_DATAPATH |
Use the eBPF based GKE Dataplane V2 with additional features. See the GKE Dataplane V2 documentation for more. |
PrivateIPv6GoogleAccess
PrivateIPv6GoogleAccess controls whether and how the pods can communicate with Google Services through gRPC over IPv6.
Enums | |
---|---|
PRIVATE_IPV6_GOOGLE_ACCESS_UNSPECIFIED |
Default value. Same as DISABLED |
PRIVATE_IPV6_GOOGLE_ACCESS_DISABLED |
No private access to or from Google Services |
PRIVATE_IPV6_GOOGLE_ACCESS_TO_GOOGLE |
Enables private IPv6 access to Google Services from GKE |
PRIVATE_IPV6_GOOGLE_ACCESS_BIDIRECTIONAL |
Enables private IPv6 access to and from Google Services |
DNSConfig
DNSConfig contains the desired set of options for configuring clusterDNS.
JSON representation |
---|
{ "clusterDns": enum ( |
Fields | |
---|---|
clusterDns |
clusterDns indicates which in-cluster DNS provider should be used. |
clusterDnsScope |
clusterDnsScope indicates the scope of access to cluster DNS records. |
clusterDnsDomain |
clusterDnsDomain is the suffix used for all cluster service records. |
additiveVpcScopeDnsDomain |
Optional. The domain used in Additive VPC scope. |
Provider
Provider lists the various in-cluster DNS providers.
Enums | |
---|---|
PROVIDER_UNSPECIFIED |
Default value |
PLATFORM_DEFAULT |
Use GKE default DNS provider(kube-dns) for DNS resolution. |
CLOUD_DNS |
Use CloudDNS for DNS resolution. |
KUBE_DNS |
Use KubeDNS for DNS resolution. |
DNSScope
DNSScope lists the various scopes of access to cluster DNS records.
Enums | |
---|---|
DNS_SCOPE_UNSPECIFIED |
Default value, will be inferred as cluster scope. |
CLUSTER_SCOPE |
DNS records are accessible from within the cluster. |
VPC_SCOPE |
DNS records are accessible from within the VPC. |
ServiceExternalIPsConfig
Config to block services with externalIPs field.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether Services with ExternalIPs field are allowed or not. |
GatewayAPIConfig
GatewayAPIConfig contains the desired config of Gateway API on this cluster.
JSON representation |
---|
{
"channel": enum ( |
Fields | |
---|---|
channel |
The Gateway API release channel to use for Gateway API. |
Channel
Channel describes if/how Gateway API should be installed and implemented in a cluster.
Enums | |
---|---|
CHANNEL_UNSPECIFIED |
Default value. |
CHANNEL_DISABLED |
Gateway API support is disabled |
CHANNEL_EXPERIMENTAL |
Deprecated: use CHANNEL_STANDARD instead. Gateway API support is enabled, experimental CRDs are installed |
CHANNEL_STANDARD |
Gateway API support is enabled, standard CRDs are installed |
ClusterNetworkPerformanceConfig
Configuration of network bandwidth tiers
JSON representation |
---|
{
"totalEgressBandwidthTier": enum ( |
Fields | |
---|---|
totalEgressBandwidthTier |
Specifies the total network bandwidth tier for NodePools in the cluster. |
Tier
Node network tier
Enums | |
---|---|
TIER_UNSPECIFIED |
Default value |
TIER_1 |
Higher bandwidth, actual values based on VM size. |
InTransitEncryptionConfig
Options for in-transit encryption.
Enums | |
---|---|
IN_TRANSIT_ENCRYPTION_CONFIG_UNSPECIFIED |
Unspecified, will be inferred as default - IN_TRANSIT_ENCRYPTION_UNSPECIFIED. |
IN_TRANSIT_ENCRYPTION_DISABLED |
In-transit encryption is disabled. |
IN_TRANSIT_ENCRYPTION_INTER_NODE_TRANSPARENT |
Data in-transit is encrypted using inter-node transparent encryption. |
ResourceUsageExportConfig
Configuration for exporting cluster resource usages.
JSON representation |
---|
{ "bigqueryDestination": { object ( |
Fields | |
---|---|
bigqueryDestination |
Configuration to use BigQuery as usage export destination. |
enableNetworkEgressMetering |
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 |
Configuration to enable resource consumption metering. |
BigQueryDestination
Parameters for using BigQuery as the destination of resource usage export.
JSON representation |
---|
{ "datasetId": string } |
Fields | |
---|---|
datasetId |
The ID of a BigQuery Dataset. |
ConsumptionMeteringConfig
Parameters for controlling consumption metering.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records. |
AuthenticatorGroupsConfig
Configuration for returning group information from authenticators.
JSON representation |
---|
{ "enabled": boolean, "securityGroup": string } |
Fields | |
---|---|
enabled |
Whether this cluster should return group membership lookups during authentication using a group of security groups. |
securityGroup |
The name of the security group-of-groups to be used. Only relevant if enabled = true. |
PrivateClusterConfig
Configuration options for private clusters.
JSON representation |
---|
{
"enablePrivateNodes": boolean,
"enablePrivateEndpoint": boolean,
"masterIpv4CidrBlock": string,
"privateEndpoint": string,
"publicEndpoint": string,
"peeringName": string,
"masterGlobalAccessConfig": {
object ( |
Fields | |
---|---|
enablePrivateNodes |
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 |
enablePrivateEndpoint |
Whether the master's internal IP address is used as the cluster endpoint. Deprecated: Use |
masterIpv4CidrBlock |
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 |
Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use |
publicEndpoint |
Output only. The external IP address of this cluster's master endpoint. Deprecated:Use |
peeringName |
Output only. The peering name in the customer VPC used by this cluster. |
masterGlobalAccessConfig |
Controls master global access settings. Deprecated: Use [ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access][] instead. |
privateEndpointSubnetwork |
Subnet to provision the master's private endpoint during cluster creation. Specified in projects/*/regions/*/subnetworks/* format. Deprecated: Use |
PrivateClusterMasterGlobalAccessConfig
Configuration for controlling master global access settings.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whenever master is accessible globally or not. |
DatabaseEncryption
Configuration of etcd encryption.
JSON representation |
---|
{ "keyName": string, "state": enum ( |
Fields | |
---|---|
keyName |
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 |
The desired state of etcd encryption. |
decryptionKeys[] |
Output only. Keys in use by the cluster for decrypting existing objects, in addition to the key in Each item is a CloudKMS key resource. |
lastOperationErrors[] |
Output only. Records errors seen during DatabaseEncryption update operations. |
currentState |
Output only. The current state of etcd encryption. |
State
State of etcd encryption.
Enums | |
---|---|
UNKNOWN |
Should never be set |
ENCRYPTED |
Secrets in etcd are encrypted. |
DECRYPTED |
Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption. |
CurrentState
Current State of etcd encryption.
Enums | |
---|---|
CURRENT_STATE_UNSPECIFIED |
Should never be set |
CURRENT_STATE_ENCRYPTED |
Secrets in etcd are encrypted. |
CURRENT_STATE_DECRYPTED |
Secrets in etcd are stored in plain text (at etcd level) - this is unrelated to Compute Engine level full disk encryption. |
CURRENT_STATE_ENCRYPTION_PENDING |
Encryption (or re-encryption with a different CloudKMS key) of Secrets is in progress. |
CURRENT_STATE_ENCRYPTION_ERROR |
Encryption (or re-encryption with a different CloudKMS key) of Secrets in etcd encountered an error. |
CURRENT_STATE_DECRYPTION_PENDING |
De-crypting Secrets to plain text in etcd is in progress. |
CURRENT_STATE_DECRYPTION_ERROR |
De-crypting Secrets to plain text in etcd encountered an error. |
OperationError
OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.
JSON representation |
---|
{ "keyName": string, "errorMessage": string, "timestamp": string } |
Fields | |
---|---|
keyName |
CloudKMS key resource that had the error. |
errorMessage |
Description of the error seen during the operation. |
timestamp |
Time when the CloudKMS error was seen. A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: |
VerticalPodAutoscaling
VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Enables vertical pod autoscaling. |
ShieldedNodes
Configuration of Shielded Nodes feature.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether Shielded Nodes features are enabled on all nodes in this cluster. |
ReleaseChannel
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.
JSON representation |
---|
{
"channel": enum ( |
Fields | |
---|---|
channel |
channel specifies which release channel the cluster is subscribed to. |
Channel
Possible values for 'channel'.
Enums | |
---|---|
UNSPECIFIED |
No channel specified. |
RAPID |
RAPID channel is offered on an early access basis for customers who want to test new releases. WARNING: Versions available in the RAPID Channel may be subject to unresolved issues with no known workaround and are not subject to any SLAs. |
REGULAR |
Clusters subscribed to REGULAR receive versions that are considered GA quality. REGULAR is intended for production users who want to take advantage of new features. |
STABLE |
Clusters subscribed to STABLE receive versions that are known to be stable and reliable in production. |
EXTENDED |
Clusters subscribed to EXTENDED receive extended support and availability for versions which are known to be stable and reliable in production. |
WorkloadIdentityConfig
Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
JSON representation |
---|
{ "workloadPool": string } |
Fields | |
---|---|
workloadPool |
The workload pool to attach all Kubernetes service accounts to. |
MeshCertificates
Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
JSON representation |
---|
{ "enableCertificates": boolean } |
Fields | |
---|---|
enableCertificates |
enableCertificates 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 ( |
CostManagementConfig
Configuration for fine-grained cost management feature.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether the feature is enabled or not. |
NotificationConfig
NotificationConfig is the configuration of notifications.
JSON representation |
---|
{
"pubsub": {
object ( |
Fields | |
---|---|
pubsub |
Notification config for Pub/Sub. |
PubSub
Pub/Sub specific notification config.
JSON representation |
---|
{
"enabled": boolean,
"topic": string,
"filter": {
object ( |
Fields | |
---|---|
enabled |
Enable notifications for Pub/Sub. |
topic |
The desired Pub/Sub topic to which notifications will be sent by GKE. Format is |
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
Allows filtering to one or more specific event types. If event types are present, those and only those event types will be transmitted to the cluster. Other types will be skipped. If no filter is specified, or no event types are present, all event types will be sent
JSON representation |
---|
{
"eventType": [
enum ( |
Fields | |
---|---|
eventType[] |
Event types to allowlist. |
EventType
Types of notifications currently supported. Can be used to filter what notifications are sent.
Enums | |
---|---|
EVENT_TYPE_UNSPECIFIED |
Not set, will be ignored. |
UPGRADE_AVAILABLE_EVENT |
Corresponds with UpgradeAvailableEvent. |
UPGRADE_EVENT |
Corresponds with UpgradeEvent. |
SECURITY_BULLETIN_EVENT |
Corresponds with SecurityBulletinEvent. |
IdentityServiceConfig
IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Whether to enable the Identity Service component |
Status
The current status of the cluster.
Enums | |
---|---|
STATUS_UNSPECIFIED |
Not set. |
PROVISIONING |
The PROVISIONING state indicates the cluster is being created. |
RUNNING |
The RUNNING state indicates the cluster has been created and is fully usable. |
RECONCILING |
The RECONCILING state indicates that some work is actively being done on the cluster, such as upgrading the master or node software. Details can be found in the statusMessage field. |
STOPPING |
The STOPPING state indicates the cluster is being deleted. |
ERROR |
The ERROR state indicates the cluster is unusable. It will be automatically deleted. Details can be found in the statusMessage field. |
DEGRADED |
The DEGRADED state indicates the cluster requires user action to restore full functionality. Details can be found in the statusMessage field. |
Autopilot
Autopilot is the configuration for Autopilot settings on the cluster.
JSON representation |
---|
{
"enabled": boolean,
"workloadPolicyConfig": {
object ( |
Fields | |
---|---|
enabled |
Enable Autopilot |
workloadPolicyConfig |
Workload policy configuration for Autopilot. |
WorkloadPolicyConfig
WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters.
JSON representation |
---|
{ "allowNetAdmin": boolean } |
Fields | |
---|---|
allowNetAdmin |
If true, workloads can use NET_ADMIN capability. |
ParentProductConfig
ParentProductConfig is the configuration of the parent product of the cluster. This field is used by Google internal products that are built on top of a GKE cluster and take the ownership of the cluster.
JSON representation |
---|
{ "productName": string, "labels": { string: string, ... } } |
Fields | |
---|---|
productName |
Name of the parent product associated with the cluster. |
labels |
Labels contain the configuration of the parent product. An object containing a list of |
NodePoolDefaults
Subset of Nodepool message that has defaults.
JSON representation |
---|
{
"nodeConfigDefaults": {
object ( |
Fields | |
---|---|
nodeConfigDefaults |
Subset of NodeConfig message that has defaults. |
NodeConfigDefaults
Subset of NodeConfig message that has defaults.
JSON representation |
---|
{ "gcfsConfig": { object ( |
Fields | |
---|---|
gcfsConfig |
GCFS (Google Container File System, also known as Riptide) options. |
loggingConfig |
Logging configuration for node pools. |
containerdConfig |
Parameters for containerd customization. |
nodeKubeletConfig |
NodeKubeletConfig controls the defaults for new node-pools. Currently only |
LoggingConfig
LoggingConfig is cluster logging configuration.
JSON representation |
---|
{
"componentConfig": {
object ( |
Fields | |
---|---|
componentConfig |
Logging components configuration |
LoggingComponentConfig
LoggingComponentConfig is cluster logging component configuration.
JSON representation |
---|
{
"enableComponents": [
enum ( |
Fields | |
---|---|
enableComponents[] |
Select components to collect logs. An empty set would disable all logging. |
Component
GKE components exposing logs
Enums | |
---|---|
COMPONENT_UNSPECIFIED |
Default value. This shouldn't be used. |
SYSTEM_COMPONENTS |
system components |
WORKLOADS |
workloads |
APISERVER |
kube-apiserver |
SCHEDULER |
kube-scheduler |
CONTROLLER_MANAGER |
kube-controller-manager |
KCP_SSHD |
kcp-sshd |
KCP_CONNECTION |
kcp connection logs |
MonitoringConfig
MonitoringConfig is cluster monitoring configuration.
JSON representation |
---|
{ "componentConfig": { object ( |
Fields | |
---|---|
componentConfig |
Monitoring components configuration |
managedPrometheusConfig |
Enable Google Cloud Managed Service for Prometheus in the cluster. |
advancedDatapathObservabilityConfig |
Configuration of Advanced Datapath Observability features. |
MonitoringComponentConfig
MonitoringComponentConfig is cluster monitoring component configuration.
JSON representation |
---|
{
"enableComponents": [
enum ( |
Fields | |
---|---|
enableComponents[] |
Select components to collect metrics. An empty set would disable all monitoring. |
Component
GKE components exposing metrics
Enums | |
---|---|
COMPONENT_UNSPECIFIED |
Default value. This shouldn't be used. |
SYSTEM_COMPONENTS |
system components |
APISERVER |
kube-apiserver |
SCHEDULER |
kube-scheduler |
CONTROLLER_MANAGER |
kube-controller-manager |
STORAGE |
Storage |
HPA |
Horizontal Pod Autoscaling |
POD |
Pod |
DAEMONSET |
DaemonSet |
DEPLOYMENT |
Deployment |
STATEFULSET |
Statefulset |
CADVISOR |
CADVISOR |
KUBELET |
KUBELET |
DCGM |
NVIDIA Data Center GPU Manager (DCGM) |
ManagedPrometheusConfig
ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Enable Managed Collection. |
AdvancedDatapathObservabilityConfig
AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath.
JSON representation |
---|
{
"enableMetrics": boolean,
"relayMode": enum ( |
Fields | |
---|---|
enableMetrics |
Expose flow metrics on nodes |
relayMode |
Method used to make Relay available |
enableRelay |
Enable Relay component |
RelayMode
Supported Relay modes
Enums | |
---|---|
RELAY_MODE_UNSPECIFIED |
Default value. This shouldn't be used. |
DISABLED |
disabled |
INTERNAL_VPC_LB |
exposed via internal load balancer |
EXTERNAL_LB |
exposed via external load balancer |
NodePoolAutoConfig
Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
JSON representation |
---|
{ "networkTags": { object ( |
Fields | |
---|---|
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 |
Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. |
nodeKubeletConfig |
NodeKubeletConfig controls the defaults for autoprovisioned node-pools. Currently only |
NetworkTags
Collection of Compute Engine network tags that can be applied to a node's underlying VM instance.
JSON representation |
---|
{ "tags": [ string ] } |
Fields | |
---|---|
tags[] |
List of network tags. |
Fleet
Fleet is the fleet configuration for the cluster.
JSON representation |
---|
{ "project": string, "membership": string, "preRegistered": boolean } |
Fields | |
---|---|
project |
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 |
Output only. The full resource name of the registered fleet membership of the cluster, in the format |
preRegistered |
Output only. Whether the cluster has been registered through the fleet API. |
SecurityPostureConfig
SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API.
JSON representation |
---|
{ "mode": enum ( |
Fields | |
---|---|
mode |
Sets which mode to use for Security Posture features. |
vulnerabilityMode |
Sets which mode to use for vulnerability scanning. |
Mode
Mode defines enablement mode for GKE Security posture features.
Enums | |
---|---|
MODE_UNSPECIFIED |
Default value not specified. |
DISABLED |
Disables Security Posture features on the cluster. |
BASIC |
Applies Security Posture features on the cluster. |
ENTERPRISE |
Applies the Security Posture off cluster Enterprise level features. |
VulnerabilityMode
VulnerabilityMode defines enablement mode for vulnerability scanning.
Enums | |
---|---|
VULNERABILITY_MODE_UNSPECIFIED |
Default value not specified. |
VULNERABILITY_DISABLED |
Disables vulnerability scanning on the cluster. |
VULNERABILITY_BASIC |
Applies basic vulnerability scanning on the cluster. |
VULNERABILITY_ENTERPRISE |
Applies the Security Posture's vulnerability on cluster Enterprise level features. |
ControlPlaneEndpointsConfig
Configuration for all of the cluster's control plane endpoints.
JSON representation |
---|
{ "dnsEndpointConfig": { object ( |
Fields | |
---|---|
dnsEndpointConfig |
DNS endpoint configuration. |
ipEndpointsConfig |
IP endpoints configuration. |
DNSEndpointConfig
Describes the configuration of a DNS endpoint.
JSON representation |
---|
{ "endpoint": string, "allowExternalTraffic": boolean } |
Fields | |
---|---|
endpoint |
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 |
allowExternalTraffic |
Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false. |
IPEndpointsConfig
IP endpoints configuration.
JSON representation |
---|
{
"authorizedNetworksConfig": {
object ( |
Fields | |
---|---|
authorizedNetworksConfig |
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 |
Output only. The external IP address of this cluster's control plane. Only populated if enabled. |
privateEndpoint |
Output only. The internal IP address of this cluster's control plane. Only populated if enabled. |
privateEndpointSubnetwork |
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. |
enabled |
Controls whether to allow direct IP access. |
enablePublicEndpoint |
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. |
globalAccess |
Controls whether the control plane's private endpoint is accessible from sources in other regions. It is invalid to specify both |
K8sBetaAPIConfig
K8sBetaAPIConfig , configuration for beta APIs
JSON representation |
---|
{ "enabledApis": [ string ] } |
Fields | |
---|---|
enabledApis[] |
Enabled k8s beta APIs. |
EnterpriseConfig
EnterpriseConfig is the cluster enterprise configuration.
JSON representation |
---|
{
"clusterTier": enum ( |
Fields | |
---|---|
clusterTier |
Output only. clusterTier indicates the effective tier of the cluster. |
ClusterTier
Premium tiers for GKE Cluster.
Enums | |
---|---|
CLUSTER_TIER_UNSPECIFIED |
CLUSTER_TIER_UNSPECIFIED is when clusterTier is not set. |
STANDARD |
STANDARD indicates a standard GKE cluster. |
ENTERPRISE |
ENTERPRISE indicates a GKE Enterprise cluster. |
SecretManagerConfig
SecretManagerConfig is config for secret manager enablement.
JSON representation |
---|
{ "enabled": boolean } |
Fields | |
---|---|
enabled |
Enable/Disable Secret Manager Config. |
CompliancePostureConfig
CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture.
JSON representation |
---|
{ "complianceStandards": [ { object ( |
Fields | |
---|---|
complianceStandards[] |
List of enabled compliance standards. |
mode |
Defines the enablement mode for Compliance Posture. |
Mode
Mode defines enablement mode for Compliance Posture.
Enums | |
---|---|
MODE_UNSPECIFIED |
Default value not specified. |
DISABLED |
Disables Compliance Posture features on the cluster. |
ENABLED |
Enables Compliance Posture features on the cluster. |
ComplianceStandard
Defines the details of a compliance standard.
JSON representation |
---|
{ "standard": string } |
Fields | |
---|---|
standard |
Name of the compliance standard. |
UserManagedKeysConfig
UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster.
JSON representation |
---|
{ "clusterCa": string, "etcdApiCa": string, "etcdPeerCa": string, "serviceAccountSigningKeys": [ string ], "serviceAccountVerificationKeys": [ string ], "aggregationCa": string, "controlPlaneDiskEncryptionKey": string, "gkeopsEtcdBackupEncryptionKey": string } |
Fields | |
---|---|
clusterCa |
The Certificate Authority Service caPool to use for the cluster CA in this cluster. |
etcdApiCa |
Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster. |
etcdPeerCa |
Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster. |
serviceAccountSigningKeys[] |
The Cloud KMS cryptoKeyVersions to use for signing service account JWTs issued by this cluster. Format: |
serviceAccountVerificationKeys[] |
The Cloud KMS cryptoKeyVersions to use for verifying service account JWTs issued by this cluster. Format: |
aggregationCa |
The Certificate Authority Service caPool to use for the aggregation CA in this cluster. |
controlPlaneDiskEncryptionKey |
The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes. |
gkeopsEtcdBackupEncryptionKey |
Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups. |
RBACBindingConfig
RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
JSON representation |
---|
{ "enableInsecureBindingSystemUnauthenticated": boolean, "enableInsecureBindingSystemAuthenticated": boolean } |
Fields | |
---|---|
enableInsecureBindingSystemUnauthenticated |
Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated. |
enableInsecureBindingSystemAuthenticated |
Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated. |
Methods |
|
---|---|
|
Checks the cluster compatibility with Autopilot mode, and returns a list of compatibility issues. |
|
Completes master IP rotation. |
|
Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. |
|
Deletes the cluster, including the Kubernetes endpoint and all worker nodes. |
|
Gets the details of a specific cluster. |
|
Gets the public component of the cluster signing keys in JSON Web Key format. |
|
Lists all clusters owned by a project in either the specified zone or all zones. |
|
Sets the addons for a specific cluster. |
|
Enables or disables the ABAC authorization mechanism on a cluster. |
(deprecated) |
Sets the locations for a specific cluster. |
|
Sets the logging service for a specific cluster. |
|
Sets the maintenance policy for a cluster. |
|
Sets master auth materials. |
|
Sets the monitoring service for a specific cluster. |
|
Enables or disables Network Policy for a cluster. |
|
Sets labels on a cluster. |
|
Starts master IP rotation. |
|
Updates the settings of a specific cluster. |
|
Updates the master for a specific cluster. |