Creates a cluster, consisting of the specified number and type of Google Compute Engine instances. By default, the cluster is created in the project's [default network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks). One firewall is added for the cluster. After cluster creation, the Kubelet creates routes for each node to allow the containers on that node to communicate with all other instances in the cluster. Finally, an entry is added to the project's global metadata indicating which CIDR range the cluster is using.

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

Lists all clusters owned by a project in either the specified zone or all zones.

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Method Details

addons(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the addons for a specific cluster.

Args:
projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
body: object, The request body.
The object takes the form of:

{ # SetAddonsRequest sets the addons associated with the cluster.
"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Required. The desired configurations for the various addons available to run in the cluster.
"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.
},
"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.
},
"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
},
"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.
"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.
},
"gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver.
"enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster.
},
"gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver.
"enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.
},
"gkeBackupAgentConfig": { # Configuration for the Backup for GKE Agent. # Configuration for the Backup for GKE agent addon.
"enabled": True or False, # Whether the Backup for GKE agent is enabled for this cluster.
},
"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. # 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.
"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
},
"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. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
"disabled": True or False, # 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.
},
"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.
"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.
"disabled": True or False, # Whether Istio is enabled for this cluster.
},
"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
"enabled": True or False, # Whether KALM is enabled for this cluster.
},
"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # 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
"disabled": True or False, # 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. # 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.
"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
},
"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver.
"enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.
},
"rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon.
"enabled": True or False, # Whether the Ray addon is enabled for this cluster.
"rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters.
"enabled": True or False, # Enable log collection for Ray clusters.
},
"rayClusterMonitoringConfig": { # RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. # Optional. Monitoring configuration for Ray clusters.
"enabled": True or False, # Enable metrics collection for Ray clusters.
},
},
"statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on.
"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster.
},
},
"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
"name": "A String", # The name (project, location, cluster) of the cluster to set addons. Specified in the format `projects/*/locations/*/clusters/*`.
"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
"clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"detail": "A String", # Output only. Detailed operation progress, if available.
"endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"name": "A String", # Output only. The server-assigned ID for the operation.
"nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"operationType": "A String", # Output only. The operation type.
"progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
"metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
{ # Progress metric is (string, int|float|string) pair.
"doubleValue": 3.14, # For metrics with floating point value.
"intValue": "A String", # For metrics with integer value.
"name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
"stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
},
],
"name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
"stages": [ # Substages of an operation or a stage.
# Object with schema name: OperationProgress
],
"status": "A String", # Status of an operation stage. Unset for single-stage operations.
},
"selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
"startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"status": "A String", # Output only. The current status of the operation.
"statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
"targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
"zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

close()

Close httplib2 connections.

completeIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)

Completes master IP rotation.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # CompleteIPRotationRequest moves the cluster master back into single-IP mode.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster name) of the cluster to complete IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

create(projectId, zone, body=None, x__xgafv=None)

{ # CreateClusterRequest creates a cluster.
"cluster": { # A Google Kubernetes Engine cluster. # Required. A [cluster resource](https://cloud.google.com/container-engine/reference/rest/v1beta1/projects.locations.clusters)
"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.
},
"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.
},
"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
},
"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.
"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.
},
"gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver.
"enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster.
},
"gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver.
"enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.
},
"gkeBackupAgentConfig": { # Configuration for the Backup for GKE Agent. # Configuration for the Backup for GKE agent addon.
"enabled": True or False, # Whether the Backup for GKE agent is enabled for this cluster.
},
"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. # 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.
"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
},
"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. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
"disabled": True or False, # 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.
},
"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.
"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.
"disabled": True or False, # Whether Istio is enabled for this cluster.
},
"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
"enabled": True or False, # Whether KALM is enabled for this cluster.
},
"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # 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
"disabled": True or False, # 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. # 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.
"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
},
"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver.
"enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.
},
"rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon.
"enabled": True or False, # Whether the Ray addon is enabled for this cluster.
"rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters.
"enabled": True or False, # Enable log collection for Ray clusters.
},
"rayClusterMonitoringConfig": { # RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. # Optional. Monitoring configuration for Ray clusters.
"enabled": True or False, # Enable metrics collection for Ray clusters.
},
},
"statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on.
"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster.
},
},
"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.
},
"autopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # Autopilot configuration for the cluster.
"conversionStatus": { # AutopilotConversionStatus represents conversion status. # Output only. ConversionStatus shows conversion status.
"state": "A String", # Output only. The current state of the conversion.
},
"enabled": True or False, # Enable Autopilot
"workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters. # Workload policy configuration for Autopilot.
"allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability.
},
},
"autoscaling": { # 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. # Cluster-level autoscaling configuration.
"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
"A String",
],
"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
"bootDiskKmsKey": "A 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
"diskSizeGb": 42, # 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": "A 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'
"imageType": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # 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](https://cloud.google.com/compute/docs/instances/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.
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
},
"autoscalingProfile": "A String", # Defines autoscaling behaviour.
"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
"maximum": "A String", # Maximum amount of the resource in the cluster.
"minimum": "A String", # Minimum amount of the resource in the cluster.
"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
},
],
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
"enabled": True or False, # 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": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
"policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
{ # Binauthz policy that applies to this cluster.
"name": "A String", # The relative resource name of the binauthz platform policy to evaluate. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
},
],
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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`.
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
"compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
},
],
"mode": "A String", # Defines the enablement mode for Compliance Posture.
},
"conditions": [ # Which conditions caused the current cluster state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints.
"dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration.
"allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.
"endpoint": "A 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.
},
"ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration.
"authorizedNetworksConfig": { # 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. # 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.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"enablePublicEndpoint": True or False, # 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.
"enabled": True or False, # Controls whether to allow direct IP access.
"globalAccess": True or False, # 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.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's control plane. Only populated if enabled.
"privateEndpointSubnetwork": "A 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled.
},
},
"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
"currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
"currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) 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.
"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # 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.
"A String",
],
"keyName": "A 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
"lastOperationErrors": [ # Output only. Records errors seen during DatabaseEncryption update operations.
{ # OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.
"errorMessage": "A String", # Description of the error seen during the operation.
"keyName": "A String", # CloudKMS key resource that had the error.
"timestamp": "A String", # Time when the CloudKMS error was seen.
},
],
"state": "A String", # The desired state of etcd encryption.
},
"defaultMaxPodsConstraint": { # Constraints applied to pods. # 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.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"description": "A String", # An optional description of this cluster.
"enableK8sBetaApis": { # Kubernetes open source beta apis enabled on the cluster. # Kubernetes open source beta apis enabled on the cluster. Only beta apis.
"enabledApis": [ # api name, e.g. storage.k8s.io/v1beta1/csistoragecapacities.
"A String",
],
},
"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.
"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.
"endpoint": "A 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.
"enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration.
"clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster.
"desiredTier": "A String", # desired_tier specifies the desired tier of the cluster.
},
"etag": "A 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.
"expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster.
"membership": "A 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": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A 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.
},
"id": "A String", # Output only. Unique id for the cluster.
"identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component.
"enabled": True or False, # Whether to enable the Identity Service component
},
"initialClusterVersion": "A 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
"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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.
"instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
"A String",
],
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
"additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # 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.
"podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
"rangeName": "A String", # Output only. Name of a range.
"utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
"A String",
],
},
"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.
"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.
"clusterIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"clusterSecondaryRangeName": "A 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 and create_subnetwork is false.
"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
"defaultPodIpv4RangeUtilization": 3.14, # 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.
"ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true
"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
"nodeIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [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.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
"servicesIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster.
"servicesSecondaryRangeName": "A 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 and create_subnetwork is false.
"stackType": "A String", # IP stack type
"subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods.
"subnetworkName": "A 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.
"tpuIpv4CidrBlock": "A String", # 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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, use cluster.tpu_config.ipv4_cidr_block instead.
"useIpAliases": True or False, # 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
"useRoutes": True or False, # 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
},
"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.
"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
"enabled": True or False, # 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.
},
"location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
"A String",
],
"loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
"componentConfig": { # LoggingComponentConfig is cluster logging component configuration. # Logging components configuration
"enableComponents": [ # Select components to collect logs. An empty set would disable all logging.
"A String",
],
},
},
"loggingService": "A 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.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
"resourceVersion": "A 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.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
"duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
"a_key": { # Represents an arbitrary window of time.
"endTime": "A String", # The time that the window ends. The end time should take place after the start time.
"maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
"scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
},
"startTime": "A String", # The time that the window first starts.
},
},
"recurringWindow": { # Represents an arbitrary window of time that recurs. # 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.
"recurrence": "A String", # 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: `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.
"window": { # Represents an arbitrary window of time. # The window of the first recurrence.
"endTime": "A String", # The time that the window ends. The end time should take place after the start time.
"maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
"scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
},
"startTime": "A String", # The time that the window first starts.
},
},
},
},
"master": { # Master is the configuration for components on master. # Configuration for master components.
},
"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # 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.
"clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
"clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
"clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # 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
"username": "A String", # 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
},
"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. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.
"meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster.
"advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features.
"enableMetrics": True or False, # Expose flow metrics on nodes
"enableRelay": True or False, # Enable Relay component
"relayMode": "A String", # Method used to make Relay available
},
"componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration
"enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring.
"A String",
],
},
"managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster.
"autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration.
"scope": "A String", # Scope for GKE Workload Auto-Monitoring.
},
"enabled": True or False, # Enable Managed Collection.
},
},
"monitoringService": "A 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.
"name": "A 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.
"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
"defaultEnablePrivateNodes": True or False, # 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
"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # 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.
"disabled": True or False, # Disables cluster default sNAT rules.
},
"dnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.
"additiveVpcScopeDnsDomain": "A String", # Optional. The domain used in Additive VPC scope.
"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.
"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.
"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.
},
"enableCiliumClusterwideNetworkPolicy": True or False, # Whether CiliumClusterWideNetworkPolicy is enabled on this cluster.
"enableFqdnNetworkPolicy": True or False, # Whether FQDN Network Policy is enabled on this cluster.
"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster.
"enableMultiNetworking": True or False, # Whether multi-networking is enabled for this cluster.
"gatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # GatewayAPIConfig contains the desired config of Gateway API on this cluster.
"channel": "A String", # The Gateway API release channel to use for Gateway API.
},
"inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
"network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"privateIpv6GoogleAccess": "A String", # 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)
"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
"enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
},
"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
},
"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
"enabled": True or False, # Whether network policy is enabled on the cluster.
"provider": "A String", # The selected network policy provider.
},
"nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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.
"accelerators": [ # 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.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # 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.
},
"bootDiskKmsKey": "A 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
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # 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": "A 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'
"effectiveCgroupMode": "A String", # 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.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. 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": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # 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.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A 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.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"labels": { # 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/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # 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.
},
"localSsdCount": 42, # 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.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"metadata": { # 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-oslogin" - "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.
"a_key": "A String",
},
"minCpuPlatform": "A 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A 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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # 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.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A 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": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # 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.
"A String",
],
"taints": [ # 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/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"nodeIpv4CidrSize": 42, # 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.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # 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.
"tags": [ # List of network tags.
"A String",
],
},
"nodeKubeletConfig": { # Node kubelet configs. # NodeKubeletConfig controls the defaults for autoprovisioned node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
},
"nodePoolDefaults": { # Subset of Nodepool message that has defaults. # Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
"nodeConfigDefaults": { # Subset of NodeConfig message that has defaults. # Subset of NodeConfig message that has defaults.
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options.
"enabled": True or False, # Whether to use GCFS.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"nodeKubeletConfig": { # Node kubelet configs. # NodeKubeletConfig controls the defaults for new node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
},
},
"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
{ # 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.
"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # 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.
"minNodeCount": 42, # 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.
"totalMaxNodeCount": 42, # 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.
"totalMinNodeCount": 42, # 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.
},
"bestEffortProvisioning": { # Best effort provisioning. # Enable best effort provisioning for nodes
"enabled": True or False, # 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": 42, # 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.
},
"conditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
"accelerators": [ # 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.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # 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.
},
"bootDiskKmsKey": "A 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
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # 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": "A 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'
"effectiveCgroupMode": "A String", # 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.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. 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": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # 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.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A 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.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"labels": { # 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/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # 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.
},
"localSsdCount": 42, # 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.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"metadata": { # 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-oslogin" - "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.
"a_key": "A String",
},
"minCpuPlatform": "A 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A 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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # 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.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A 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": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # 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.
"A String",
],
"taints": [ # 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/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"etag": "A 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.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"name": "A String", # The name of the node pool.
"networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # 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
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # 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.
"enablePrivateNodes": True or False, # 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
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [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.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"podIpv4RangeUtilization": 3.14, # 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.
"podRange": "A 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.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
"policyName": "A 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.
"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
"podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"status": "A String", # Output only. The status of the nodes in this pool instance.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
"updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
],
"bluePoolDeletionStartTime": "A String", # Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"greenInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
"A String",
],
"greenPoolVersion": "A String", # Version of green pool.
"phase": "A String", # Current blue-green upgrade phase.
},
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
},
],
"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.
"enabled": True or False, # Enable notifications for Pub/Sub.
"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 # 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
"eventType": [ # Event types to allowlist.
"A String",
],
},
"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.
},
},
"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. # 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.
"labels": { # Labels contain the configuration of the parent product.
"a_key": "A String",
},
"productName": "A String", # Name of the parent product associated with the cluster.
},
"podAutoscaling": { # PodAutoscaling is used for configuration of parameters for workload autoscaling. # The config for pod autoscaling.
"hpaProfile": "A String", # Selected Horizontal Pod Autoscaling profile.
},
"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.
"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.
},
"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.
"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. 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.
"enablePrivateNodes": True or False, # 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.
"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access instead.
"enabled": True or False, # Whenever master is accessible globally or not.
},
"masterIpv4CidrBlock": "A 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.
"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint instead.
"privateEndpointSubnetwork": "A String", # 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint instead.
},
"protectConfig": { # ProtectConfig defines the flags needed to enable/disable features for the Protect API. # Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.
"workloadConfig": { # WorkloadConfig defines the flags to enable or disable the workload configurations for the cluster. # WorkloadConfig defines which actions are enabled for a cluster's workload configurations.
"auditMode": "A String", # Sets which mode of auditing should be used for the cluster's workloads.
},
"workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature.
},
"rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
"enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.
"enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.
},
"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. # 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.
"channel": "A String", # channel specifies which release channel the cluster is subscribed to.
},
"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.
"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
"datasetId": "A String", # The ID of a BigQuery Dataset.
},
"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
},
"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration.
"enabled": True or False, # Enable/Disable Secret Manager Config.
},
"securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
"status": "A String", # Output only. The current status of this cluster.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;
"enabled": True or False, # Whether Cloud TPU integration is enabled or not.
"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.
},
"tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
"userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
"aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
"clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster.
"controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.
"etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.
"etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.
"gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.
"serviceAccountSigningKeys": [ # 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}`
"A String",
],
"serviceAccountVerificationKeys": [ # 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}`
"A String",
],
},
"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"workloadAltsConfig": { # Configuration for direct-path (via ALTS) with workload identity. # Configuration for direct-path (via ALTS) with workload identity.
"enableAlts": True or False, # enable_alts controls whether the alts handshaker should be enabled or not for direct-path. Requires Workload Identity (workload_pool must be non-empty).
},
"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.
"identityProvider": "A String", # identity provider is the third party identity provider.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
"zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
},
"parent": "A String", # The parent (project and location) where the cluster will be created. Specified in the format `projects/*/locations/*`.
"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field.
"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the parent field.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

delete(projectId, zone, clusterId, name=None, x__xgafv=None)

Deletes the cluster, including the Kubernetes endpoint and all worker nodes. Firewalls and routes that were configured during cluster creation are also deleted. Other Google Compute Engine resources that might be in use by the cluster, such as load balancer resources, are not deleted if they weren't present when the cluster was initially created.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to delete. This field has been deprecated and replaced by the name field. (required)
  name: string, The name (project, location, cluster) of the cluster to delete. Specified in the format `projects/*/locations/*/clusters/*`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

fetchClusterUpgradeInfo(name, version=None, x__xgafv=None)

Fetch upgrade information of a specific cluster.

Args:
  name: string, Required. The name (project, location, cluster) of the cluster to get. Specified in the format `projects/*/locations/*/clusters/*` or `projects/*/zones/*/clusters/*`. (required)
  version: string, API request version that initiates this operation.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # ClusterUpgradeInfo contains the upgrade information of a cluster.
  "autoUpgradeStatus": [ # The auto upgrade status.
    "A String",
  ],
  "endOfExtendedSupportTimestamp": "A String", # The cluster's current minor version's end of extended support timestamp.
  "endOfStandardSupportTimestamp": "A String", # The cluster's current minor version's end of standard support timestamp.
  "minorTargetVersion": "A String", # minor_target_version indicates the target version for minor upgrade.
  "patchTargetVersion": "A String", # patch_target_version indicates the target version for patch upgrade.
  "pausedReason": [ # The auto upgrade paused reason.
    "A String",
  ],
  "upgradeDetails": [ # The list of past auto upgrades.
    { # UpgradeDetails contains detailed information of each individual upgrade operation.
      "endTime": "A String", # The end timestamp of the upgrade.
      "initialVersion": "A String", # The version before the upgrade.
      "startTime": "A String", # The start timestamp of the upgrade.
      "state": "A String", # Output only. The state of the upgrade.
      "targetVersion": "A String", # The version after the upgrade.
    },
  ],
}

get(projectId, zone, clusterId, name=None, x__xgafv=None)

Gets the details for a specific cluster.

Args:
projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
clusterId: string, Required. Deprecated. The name of the cluster to retrieve. This field has been deprecated and replaced by the name field. (required)
name: string, The name (project, location, cluster) of the cluster to retrieve. Specified in the format `projects/*/locations/*/clusters/*`.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # A Google Kubernetes Engine cluster.
"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.
},
"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.
},
"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
},
"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.
"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.
},
"gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver.
"enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster.
},
"gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver.
"enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.
},
"gkeBackupAgentConfig": { # Configuration for the Backup for GKE Agent. # Configuration for the Backup for GKE agent addon.
"enabled": True or False, # Whether the Backup for GKE agent is enabled for this cluster.
},
"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. # 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.
"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
},
"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. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
"disabled": True or False, # 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.
},
"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.
"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.
"disabled": True or False, # Whether Istio is enabled for this cluster.
},
"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
"enabled": True or False, # Whether KALM is enabled for this cluster.
},
"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # 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
"disabled": True or False, # 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. # 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.
"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
},
"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver.
"enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.
},
"rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon.
"enabled": True or False, # Whether the Ray addon is enabled for this cluster.
"rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters.
"enabled": True or False, # Enable log collection for Ray clusters.
},
"rayClusterMonitoringConfig": { # RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. # Optional. Monitoring configuration for Ray clusters.
"enabled": True or False, # Enable metrics collection for Ray clusters.
},
},
"statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on.
"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster.
},
},
"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.
},
"autopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # Autopilot configuration for the cluster.
"conversionStatus": { # AutopilotConversionStatus represents conversion status. # Output only. ConversionStatus shows conversion status.
"state": "A String", # Output only. The current state of the conversion.
},
"enabled": True or False, # Enable Autopilot
"workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters. # Workload policy configuration for Autopilot.
"allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability.
},
},
"autoscaling": { # 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. # Cluster-level autoscaling configuration.
"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
"A String",
],
"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
"bootDiskKmsKey": "A 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
"diskSizeGb": 42, # 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": "A 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'
"imageType": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # 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](https://cloud.google.com/compute/docs/instances/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.
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
},
"autoscalingProfile": "A String", # Defines autoscaling behaviour.
"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
"maximum": "A String", # Maximum amount of the resource in the cluster.
"minimum": "A String", # Minimum amount of the resource in the cluster.
"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
},
],
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
"enabled": True or False, # 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": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
"policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
{ # Binauthz policy that applies to this cluster.
"name": "A String", # The relative resource name of the binauthz platform policy to evaluate. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
},
],
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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`.
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
"compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
},
],
"mode": "A String", # Defines the enablement mode for Compliance Posture.
},
"conditions": [ # Which conditions caused the current cluster state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints.
"dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration.
"allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.
"endpoint": "A 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.
},
"ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration.
"authorizedNetworksConfig": { # 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. # 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.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"enablePublicEndpoint": True or False, # 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.
"enabled": True or False, # Controls whether to allow direct IP access.
"globalAccess": True or False, # 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.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's control plane. Only populated if enabled.
"privateEndpointSubnetwork": "A 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled.
},
},
"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
"currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
"currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) 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.
"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # 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.
"A String",
],
"keyName": "A 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
"lastOperationErrors": [ # Output only. Records errors seen during DatabaseEncryption update operations.
{ # OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.
"errorMessage": "A String", # Description of the error seen during the operation.
"keyName": "A String", # CloudKMS key resource that had the error.
"timestamp": "A String", # Time when the CloudKMS error was seen.
},
],
"state": "A String", # The desired state of etcd encryption.
},
"defaultMaxPodsConstraint": { # Constraints applied to pods. # 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.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"description": "A String", # An optional description of this cluster.
"enableK8sBetaApis": { # Kubernetes open source beta apis enabled on the cluster. # Kubernetes open source beta apis enabled on the cluster. Only beta apis.
"enabledApis": [ # api name, e.g. storage.k8s.io/v1beta1/csistoragecapacities.
"A String",
],
},
"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.
"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.
"endpoint": "A 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.
"enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration.
"clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster.
"desiredTier": "A String", # desired_tier specifies the desired tier of the cluster.
},
"etag": "A 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.
"expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster.
"membership": "A 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": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A 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.
},
"id": "A String", # Output only. Unique id for the cluster.
"identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component.
"enabled": True or False, # Whether to enable the Identity Service component
},
"initialClusterVersion": "A 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
"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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.
"instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
"A String",
],
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
"additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # 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.
"podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
"rangeName": "A String", # Output only. Name of a range.
"utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
"A String",
],
},
"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.
"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.
"clusterIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"clusterSecondaryRangeName": "A 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 and create_subnetwork is false.
"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
"defaultPodIpv4RangeUtilization": 3.14, # 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.
"ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true
"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
"nodeIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [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.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
"servicesIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster.
"servicesSecondaryRangeName": "A 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 and create_subnetwork is false.
"stackType": "A String", # IP stack type
"subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods.
"subnetworkName": "A 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.
"tpuIpv4CidrBlock": "A String", # 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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, use cluster.tpu_config.ipv4_cidr_block instead.
"useIpAliases": True or False, # 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
"useRoutes": True or False, # 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
},
"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.
"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
"enabled": True or False, # 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.
},
"location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
"A String",
],
"loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
"componentConfig": { # LoggingComponentConfig is cluster logging component configuration. # Logging components configuration
"enableComponents": [ # Select components to collect logs. An empty set would disable all logging.
"A String",
],
},
},
"loggingService": "A 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.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
"resourceVersion": "A 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.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
"duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
"a_key": { # Represents an arbitrary window of time.
"endTime": "A String", # The time that the window ends. The end time should take place after the start time.
"maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
"scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
},
"startTime": "A String", # The time that the window first starts.
},
},
"recurringWindow": { # Represents an arbitrary window of time that recurs. # 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.
"recurrence": "A String", # 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: `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.
"window": { # Represents an arbitrary window of time. # The window of the first recurrence.
"endTime": "A String", # The time that the window ends. The end time should take place after the start time.
"maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
"scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
},
"startTime": "A String", # The time that the window first starts.
},
},
},
},
"master": { # Master is the configuration for components on master. # Configuration for master components.
},
"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # 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.
"clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
"clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
"clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # 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
"username": "A String", # 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
},
"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. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.
"meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster.
"advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features.
"enableMetrics": True or False, # Expose flow metrics on nodes
"enableRelay": True or False, # Enable Relay component
"relayMode": "A String", # Method used to make Relay available
},
"componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration
"enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring.
"A String",
],
},
"managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster.
"autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration.
"scope": "A String", # Scope for GKE Workload Auto-Monitoring.
},
"enabled": True or False, # Enable Managed Collection.
},
},
"monitoringService": "A 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.
"name": "A 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.
"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
"defaultEnablePrivateNodes": True or False, # 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
"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # 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.
"disabled": True or False, # Disables cluster default sNAT rules.
},
"dnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.
"additiveVpcScopeDnsDomain": "A String", # Optional. The domain used in Additive VPC scope.
"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.
"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.
"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.
},
"enableCiliumClusterwideNetworkPolicy": True or False, # Whether CiliumClusterWideNetworkPolicy is enabled on this cluster.
"enableFqdnNetworkPolicy": True or False, # Whether FQDN Network Policy is enabled on this cluster.
"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster.
"enableMultiNetworking": True or False, # Whether multi-networking is enabled for this cluster.
"gatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # GatewayAPIConfig contains the desired config of Gateway API on this cluster.
"channel": "A String", # The Gateway API release channel to use for Gateway API.
},
"inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
"network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"privateIpv6GoogleAccess": "A String", # 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)
"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
"enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
},
"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
},
"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
"enabled": True or False, # Whether network policy is enabled on the cluster.
"provider": "A String", # The selected network policy provider.
},
"nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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.
"accelerators": [ # 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.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # 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.
},
"bootDiskKmsKey": "A 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
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # 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": "A 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'
"effectiveCgroupMode": "A String", # 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.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. 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": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # 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.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A 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.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"labels": { # 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/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # 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.
},
"localSsdCount": 42, # 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.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"metadata": { # 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-oslogin" - "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.
"a_key": "A String",
},
"minCpuPlatform": "A 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A 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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # 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.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A 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": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # 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.
"A String",
],
"taints": [ # 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/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"nodeIpv4CidrSize": 42, # 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.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # 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.
"tags": [ # List of network tags.
"A String",
],
},
"nodeKubeletConfig": { # Node kubelet configs. # NodeKubeletConfig controls the defaults for autoprovisioned node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
},
"nodePoolDefaults": { # Subset of Nodepool message that has defaults. # Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
"nodeConfigDefaults": { # Subset of NodeConfig message that has defaults. # Subset of NodeConfig message that has defaults.
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options.
"enabled": True or False, # Whether to use GCFS.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"nodeKubeletConfig": { # Node kubelet configs. # NodeKubeletConfig controls the defaults for new node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
},
},
"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
{ # 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.
"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # 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.
"minNodeCount": 42, # 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.
"totalMaxNodeCount": 42, # 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.
"totalMinNodeCount": 42, # 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.
},
"bestEffortProvisioning": { # Best effort provisioning. # Enable best effort provisioning for nodes
"enabled": True or False, # 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": 42, # 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.
},
"conditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
"accelerators": [ # 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.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # 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.
},
"bootDiskKmsKey": "A 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
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # 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": "A 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'
"effectiveCgroupMode": "A String", # 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.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. 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": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # 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.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A 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.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"labels": { # 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/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # 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.
},
"localSsdCount": 42, # 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.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"metadata": { # 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-oslogin" - "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.
"a_key": "A String",
},
"minCpuPlatform": "A 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A 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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # 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.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A 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": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # 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.
"A String",
],
"taints": [ # 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/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"etag": "A 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.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"name": "A String", # The name of the node pool.
"networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # 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
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # 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.
"enablePrivateNodes": True or False, # 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
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [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.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"podIpv4RangeUtilization": 3.14, # 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.
"podRange": "A 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.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
"policyName": "A 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.
"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
"podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"status": "A String", # Output only. The status of the nodes in this pool instance.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
"updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
],
"bluePoolDeletionStartTime": "A String", # Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"greenInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
"A String",
],
"greenPoolVersion": "A String", # Version of green pool.
"phase": "A String", # Current blue-green upgrade phase.
},
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
},
],
"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.
"enabled": True or False, # Enable notifications for Pub/Sub.
"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 # 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
"eventType": [ # Event types to allowlist.
"A String",
],
},
"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.
},
},
"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. # 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.
"labels": { # Labels contain the configuration of the parent product.
"a_key": "A String",
},
"productName": "A String", # Name of the parent product associated with the cluster.
},
"podAutoscaling": { # PodAutoscaling is used for configuration of parameters for workload autoscaling. # The config for pod autoscaling.
"hpaProfile": "A String", # Selected Horizontal Pod Autoscaling profile.
},
"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.
"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.
},
"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.
"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. 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.
"enablePrivateNodes": True or False, # 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.
"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access instead.
"enabled": True or False, # Whenever master is accessible globally or not.
},
"masterIpv4CidrBlock": "A 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.
"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint instead.
"privateEndpointSubnetwork": "A String", # 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint instead.
},
"protectConfig": { # ProtectConfig defines the flags needed to enable/disable features for the Protect API. # Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.
"workloadConfig": { # WorkloadConfig defines the flags to enable or disable the workload configurations for the cluster. # WorkloadConfig defines which actions are enabled for a cluster's workload configurations.
"auditMode": "A String", # Sets which mode of auditing should be used for the cluster's workloads.
},
"workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature.
},
"rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
"enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.
"enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.
},
"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. # 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.
"channel": "A String", # channel specifies which release channel the cluster is subscribed to.
},
"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.
"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
"datasetId": "A String", # The ID of a BigQuery Dataset.
},
"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
},
"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration.
"enabled": True or False, # Enable/Disable Secret Manager Config.
},
"securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
"status": "A String", # Output only. The current status of this cluster.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;
"enabled": True or False, # Whether Cloud TPU integration is enabled or not.
"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.
},
"tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
"userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
"aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
"clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster.
"controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.
"etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.
"etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.
"gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.
"serviceAccountSigningKeys": [ # 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}`
"A String",
],
"serviceAccountVerificationKeys": [ # 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}`
"A String",
],
},
"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"workloadAltsConfig": { # Configuration for direct-path (via ALTS) with workload identity. # Configuration for direct-path (via ALTS) with workload identity.
"enableAlts": True or False, # enable_alts controls whether the alts handshaker should be enabled or not for direct-path. Requires Workload Identity (workload_pool must be non-empty).
},
"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.
"identityProvider": "A String", # identity provider is the third party identity provider.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
"zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
}

legacyAbac(projectId, zone, clusterId, body=None, x__xgafv=None)

Enables or disables the ABAC authorization mechanism on a cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetLegacyAbacRequest enables or disables the ABAC authorization mechanism for a cluster.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to update. This field has been deprecated and replaced by the name field.
  "enabled": True or False, # Required. Whether ABAC authorization will be enabled in the cluster.
  "name": "A String", # The name (project, location, cluster name) of the cluster to set legacy abac. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

list(projectId, zone, parent=None, x__xgafv=None)

Lists all clusters owned by a project in either the specified zone or all zones.

Args:
projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the parent field. (required)
zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides, or "-" for all zones. This field has been deprecated and replaced by the parent field. (required)
parent: string, The parent (project and location) where the clusters will be listed. Specified in the format `projects/*/locations/*`. Location "-" matches all zones and all regions.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

{ # ListClustersResponse is the result of ListClustersRequest.
"clusters": [ # A list of clusters in the project in the specified zone, or across all ones.
{ # A Google Kubernetes Engine cluster.
"addonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.
},
"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.
},
"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
},
"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.
"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.
},
"gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver.
"enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster.
},
"gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver.
"enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.
},
"gkeBackupAgentConfig": { # Configuration for the Backup for GKE Agent. # Configuration for the Backup for GKE agent addon.
"enabled": True or False, # Whether the Backup for GKE agent is enabled for this cluster.
},
"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. # 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.
"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
},
"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. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
"disabled": True or False, # 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.
},
"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.
"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.
"disabled": True or False, # Whether Istio is enabled for this cluster.
},
"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
"enabled": True or False, # Whether KALM is enabled for this cluster.
},
"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # 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
"disabled": True or False, # 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. # 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.
"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
},
"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver.
"enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.
},
"rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon.
"enabled": True or False, # Whether the Ray addon is enabled for this cluster.
"rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters.
"enabled": True or False, # Enable log collection for Ray clusters.
},
"rayClusterMonitoringConfig": { # RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. # Optional. Monitoring configuration for Ray clusters.
"enabled": True or False, # Enable metrics collection for Ray clusters.
},
},
"statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on.
"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster.
},
},
"authenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # Configuration controlling RBAC group membership information.
"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.
},
"autopilot": { # Autopilot is the configuration for Autopilot settings on the cluster. # Autopilot configuration for the cluster.
"conversionStatus": { # AutopilotConversionStatus represents conversion status. # Output only. ConversionStatus shows conversion status.
"state": "A String", # Output only. The current state of the conversion.
},
"enabled": True or False, # Enable Autopilot
"workloadPolicyConfig": { # WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters. # Workload policy configuration for Autopilot.
"allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability.
},
},
"autoscaling": { # 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. # Cluster-level autoscaling configuration.
"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
"A String",
],
"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
"bootDiskKmsKey": "A 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
"diskSizeGb": 42, # 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": "A 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'
"imageType": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # 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](https://cloud.google.com/compute/docs/instances/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.
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
},
"autoscalingProfile": "A String", # Defines autoscaling behaviour.
"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
"maximum": "A String", # Maximum amount of the resource in the cluster.
"minimum": "A String", # Minimum amount of the resource in the cluster.
"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
},
],
},
"binaryAuthorization": { # Configuration for Binary Authorization. # Configuration for Binary Authorization.
"enabled": True or False, # 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": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
"policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
{ # Binauthz policy that applies to this cluster.
"name": "A String", # The relative resource name of the binauthz platform policy to evaluate. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
},
],
},
"clusterIpv4Cidr": "A String", # The IP address range of the container pods in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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`.
"clusterTelemetry": { # Telemetry integration for the cluster. # Telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
"compliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
},
],
"mode": "A String", # Defines the enablement mode for Compliance Posture.
},
"conditions": [ # Which conditions caused the current cluster state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Configuration of Confidential Nodes. All the nodes in the cluster will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"controlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Configuration for all cluster's control plane endpoints.
"dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration.
"allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.
"endpoint": "A 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.
},
"ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration.
"authorizedNetworksConfig": { # 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. # 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.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"enablePublicEndpoint": True or False, # 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.
"enabled": True or False, # Controls whether to allow direct IP access.
"globalAccess": True or False, # 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.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's control plane. Only populated if enabled.
"privateEndpointSubnetwork": "A 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled.
},
},
"costManagementConfig": { # Configuration for fine-grained cost management feature. # Configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
"createTime": "A String", # Output only. The time the cluster was created, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"currentMasterVersion": "A String", # Output only. The current software version of the master endpoint.
"currentNodeCount": 42, # Output only. The number of nodes currently in the cluster. Deprecated. Call Kubernetes API directly to retrieve node information.
"currentNodeVersion": "A String", # Output only. Deprecated, use [NodePool.version](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters.nodePools) 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.
"databaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # 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.
"A String",
],
"keyName": "A 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
"lastOperationErrors": [ # Output only. Records errors seen during DatabaseEncryption update operations.
{ # OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.
"errorMessage": "A String", # Description of the error seen during the operation.
"keyName": "A String", # CloudKMS key resource that had the error.
"timestamp": "A String", # Time when the CloudKMS error was seen.
},
],
"state": "A String", # The desired state of etcd encryption.
},
"defaultMaxPodsConstraint": { # Constraints applied to pods. # 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.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"description": "A String", # An optional description of this cluster.
"enableK8sBetaApis": { # Kubernetes open source beta apis enabled on the cluster. # Kubernetes open source beta apis enabled on the cluster. Only beta apis.
"enabledApis": [ # api name, e.g. storage.k8s.io/v1beta1/csistoragecapacities.
"A String",
],
},
"enableKubernetesAlpha": True or False, # Kubernetes alpha features are enabled on this cluster. This includes alpha API groups (e.g. v1beta1) 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.
"enableTpu": True or False, # Enable the ability to use Cloud TPUs in this cluster. This field is deprecated, use tpu_config.enabled instead.
"endpoint": "A 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.
"enterpriseConfig": { # EnterpriseConfig is the cluster enterprise configuration. # GKE Enterprise Configuration.
"clusterTier": "A String", # Output only. cluster_tier indicates the effective tier of the cluster.
"desiredTier": "A String", # desired_tier specifies the desired tier of the cluster.
},
"etag": "A 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.
"expireTime": "A String", # Output only. The time the cluster will be automatically deleted in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"fleet": { # Fleet is the fleet configuration for the cluster. # Fleet information for the cluster.
"membership": "A 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": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A 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.
},
"id": "A String", # Output only. Unique id for the cluster.
"identityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # Configuration for Identity Service component.
"enabled": True or False, # Whether to enable the Identity Service component
},
"initialClusterVersion": "A 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
"initialNodeCount": 42, # The number of nodes to create in this cluster. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) 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.
"instanceGroupUrls": [ # Output only. Deprecated. Use node_pools.instance_group_urls.
"A String",
],
"ipAllocationPolicy": { # Configuration for controlling how IPs are allocated in the cluster. # Configuration for cluster IP allocation.
"additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # 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.
"podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
"rangeName": "A String", # Output only. Name of a range.
"utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
"A String",
],
},
"allowRouteOverlap": True or False, # If true, allow allocation of cluster CIDR ranges that overlap with certain kinds of network routes. By default we do not allow cluster CIDR ranges to intersect with any user declared routes. With allow_route_overlap == true, we allow overlapping with CIDR ranges that are larger than the cluster CIDR range. If this field is set to true, then cluster and services CIDRs must be fully-specified (e.g. `10.96.0.0/14`, but not `/14`), which means: 1) When `use_ip_aliases` is true, `cluster_ipv4_cidr_block` and `services_ipv4_cidr_block` must be fully-specified. 2) When `use_ip_aliases` is false, `cluster.cluster_ipv4_cidr` muse be fully-specified.
"clusterIpv4Cidr": "A String", # This field is deprecated, use cluster_ipv4_cidr_block.
"clusterIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"clusterSecondaryRangeName": "A 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 and create_subnetwork is false.
"createSubnetwork": True or False, # Whether a new subnetwork will be created automatically for the cluster. This field is only applicable when `use_ip_aliases` is true.
"defaultPodIpv4RangeUtilization": 3.14, # 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.
"ipv6AccessType": "A String", # The ipv6 access type (internal or external) when create_subnetwork is true
"nodeIpv4Cidr": "A String", # This field is deprecated, use node_ipv4_cidr_block.
"nodeIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [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.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"servicesIpv4Cidr": "A String", # This field is deprecated, use services_ipv4_cidr_block.
"servicesIpv4CidrBlock": "A 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"servicesIpv6CidrBlock": "A String", # Output only. The services IPv6 CIDR block for the cluster.
"servicesSecondaryRangeName": "A 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 and create_subnetwork is false.
"stackType": "A String", # IP stack type
"subnetIpv6CidrBlock": "A String", # Output only. The subnet's IPv6 CIDR block used by nodes and pods.
"subnetworkName": "A 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.
"tpuIpv4CidrBlock": "A String", # 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](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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, use cluster.tpu_config.ipv4_cidr_block instead.
"useIpAliases": True or False, # 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
"useRoutes": True or False, # 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
},
"labelFingerprint": "A String", # The fingerprint of the set of labels for this cluster.
"legacyAbac": { # Configuration for the legacy Attribute Based Access Control authorization mode. # Configuration for the legacy ABAC authorization mode.
"enabled": True or False, # 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.
},
"location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This field provides a default value if [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) are not specified during node pool creation. Warning: changing cluster locations will update the [NodePool.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters.nodePools#NodePool.FIELDS.locations) of all node pools and will result in nodes being added and/or removed.
"A String",
],
"loggingConfig": { # LoggingConfig is cluster logging configuration. # Logging configuration for the cluster.
"componentConfig": { # LoggingComponentConfig is cluster logging component configuration. # Logging components configuration
"enableComponents": [ # Select components to collect logs. An empty set would disable all logging.
"A String",
],
},
},
"loggingService": "A 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.
"maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Configure the maintenance policy for this cluster.
"resourceVersion": "A 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.
"window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
"dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
"duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.
"startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
},
"maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
"a_key": { # Represents an arbitrary window of time.
"endTime": "A String", # The time that the window ends. The end time should take place after the start time.
"maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
"scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
},
"startTime": "A String", # The time that the window first starts.
},
},
"recurringWindow": { # Represents an arbitrary window of time that recurs. # 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.
"recurrence": "A String", # 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: `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.
"window": { # Represents an arbitrary window of time. # The window of the first recurrence.
"endTime": "A String", # The time that the window ends. The end time should take place after the start time.
"maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
"scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
},
"startTime": "A String", # The time that the window first starts.
},
},
},
},
"master": { # Master is the configuration for components on master. # Configuration for master components.
},
"masterAuth": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # 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.
"clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
"clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
"issueClientCertificate": True or False, # Issue a client certificate.
},
"clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
"clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
"password": "A String", # 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
"username": "A String", # 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
},
"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. # The configuration options for master authorized networks feature. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.authorized_networks_config instead.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"masterIpv4CidrBlock": "A String", # The IP prefix in CIDR notation to use for the hosted master network. This prefix will be used for assigning private IP addresses to the master or set of masters, as well as the ILB VIP. This field is deprecated, use private_cluster_config.master_ipv4_cidr_block instead.
"meshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"monitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # Monitoring configuration for the cluster.
"advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features.
"enableMetrics": True or False, # Expose flow metrics on nodes
"enableRelay": True or False, # Enable Relay component
"relayMode": "A String", # Method used to make Relay available
},
"componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration
"enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring.
"A String",
],
},
"managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster.
"autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration.
"scope": "A String", # Scope for GKE Workload Auto-Monitoring.
},
"enabled": True or False, # Enable Managed Collection.
},
},
"monitoringService": "A 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.
"name": "A 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.
"network": "A String", # The name of the Google Compute Engine [network](https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. If left unspecified, the `default` network will be used. On output this shows the network ID instead of the name.
"networkConfig": { # NetworkConfig reports the relative names of network & subnetwork. # Configuration for cluster networking.
"datapathProvider": "A String", # The desired datapath provider for this cluster. By default, uses the IPTables-based kube-proxy implementation.
"defaultEnablePrivateNodes": True or False, # 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
"defaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # 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.
"disabled": True or False, # Disables cluster default sNAT rules.
},
"dnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.
"additiveVpcScopeDnsDomain": "A String", # Optional. The domain used in Additive VPC scope.
"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.
"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.
"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.
},
"enableCiliumClusterwideNetworkPolicy": True or False, # Whether CiliumClusterWideNetworkPolicy is enabled on this cluster.
"enableFqdnNetworkPolicy": True or False, # Whether FQDN Network Policy is enabled on this cluster.
"enableIntraNodeVisibility": True or False, # Whether Intra-node visibility is enabled for this cluster. This makes same node pod to pod traffic visible for VPC network.
"enableL4ilbSubsetting": True or False, # Whether L4ILB Subsetting is enabled for this cluster.
"enableMultiNetworking": True or False, # Whether multi-networking is enabled for this cluster.
"gatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # GatewayAPIConfig contains the desired config of Gateway API on this cluster.
"channel": "A String", # The Gateway API release channel to use for Gateway API.
},
"inTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption.
"network": "A String", # Output only. The relative name of the Google Compute Engine network(https://cloud.google.com/compute/docs/networks-and-firewalls#networks) to which the cluster is connected. Example: projects/my-project/global/networks/my-network
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"privateIpv6GoogleAccess": "A String", # 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)
"serviceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies if services with externalIPs field are blocked or not.
"enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
},
"subnetwork": "A String", # Output only. The relative name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/vpc) to which the cluster is connected. Example: projects/my-project/regions/us-central1/subnetworks/my-subnet
},
"networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Configuration options for the NetworkPolicy feature.
"enabled": True or False, # Whether network policy is enabled on the cluster.
"provider": "A String", # The selected network policy provider.
},
"nodeConfig": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # 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.
"accelerators": [ # 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.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # 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.
},
"bootDiskKmsKey": "A 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
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # 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": "A 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'
"effectiveCgroupMode": "A String", # 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.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. 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": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # 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.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A 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.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"labels": { # 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/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # 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.
},
"localSsdCount": 42, # 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.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"metadata": { # 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-oslogin" - "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.
"a_key": "A String",
},
"minCpuPlatform": "A 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A 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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # 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.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A 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": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # 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.
"A String",
],
"taints": [ # 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/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"nodeIpv4CidrSize": 42, # 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.
"nodePoolAutoConfig": { # node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters # Node pool configs that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Output only. Configuration options for Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"networkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # 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.
"tags": [ # List of network tags.
"A String",
],
},
"nodeKubeletConfig": { # Node kubelet configs. # NodeKubeletConfig controls the defaults for autoprovisioned node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # Resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
},
"nodePoolDefaults": { # Subset of Nodepool message that has defaults. # Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object.
"nodeConfigDefaults": { # Subset of NodeConfig message that has defaults. # Subset of NodeConfig message that has defaults.
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System, also known as Riptide) options.
"enabled": True or False, # Whether to use GCFS.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration for node pools.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"nodeKubeletConfig": { # Node kubelet configs. # NodeKubeletConfig controls the defaults for new node-pools. Currently only `insecure_kubelet_readonly_port_enabled` can be set here.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
},
},
"nodePools": [ # The node pools associated with this cluster. This field should not be set if "node_config" or "initial_node_count" are specified.
{ # 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.
"autoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # 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.
"minNodeCount": 42, # 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.
"totalMaxNodeCount": 42, # 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.
"totalMinNodeCount": 42, # 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.
},
"bestEffortProvisioning": { # Best effort provisioning. # Enable best effort provisioning for nodes
"enabled": True or False, # 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": 42, # 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.
},
"conditions": [ # Which conditions caused the current node pool state.
{ # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
"canonicalCode": "A String", # Canonical code of the condition.
"code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
"message": "A String", # Human-friendly representation of the condition
},
],
"config": { # Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in `NodeConfig`. Use AutoprovisioningNodePoolDefaults instead. # The node configuration of the pool.
"accelerators": [ # 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.
{ # AcceleratorConfig represents a Hardware Accelerator request.
"acceleratorCount": "A String", # The number of the accelerator cards exposed to an instance.
"acceleratorType": "A String", # The accelerator type resource name. List of supported accelerators [here](https://cloud.google.com/compute/docs/gpus)
"gpuDriverInstallationConfig": { # GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed. # The configuration for auto installation of GPU driver.
"gpuDriverVersion": "A String", # Mode for how the GPU driver is installed.
},
"gpuPartitionSize": "A String", # Size of partitions to create on the GPU. Valid values are described in the NVIDIA [mig user guide](https://docs.nvidia.com/datacenter/tesla/mig-user-guide/#partitioning).
"gpuSharingConfig": { # GPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators. # The configuration for GPU sharing options.
"gpuSharingStrategy": "A String", # The type of GPU sharing strategy to enable on the GPU node.
"maxSharedClientsPerGpu": "A String", # The max number of containers that can share a physical GPU.
},
"maxTimeSharedClientsPerGpu": "A String", # The number of time-shared GPU resources to expose for each physical GPU.
},
],
"advancedMachineFeatures": { # Specifies options for controlling advanced machine features. # Advanced features for the Compute Engine VM.
"enableNestedVirtualization": True or False, # Whether or not to enable nested virtualization (defaults to false).
"threadsPerCore": "A String", # 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.
},
"bootDiskKmsKey": "A 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
"confidentialNodes": { # ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. # Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
"enabled": True or False, # Whether Confidential Nodes feature is enabled.
},
"containerdConfig": { # ContainerdConfig contains configuration to customize containerd. # Parameters for containerd customization.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"diskSizeGb": 42, # 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": "A 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'
"effectiveCgroupMode": "A String", # 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.
"enableConfidentialStorage": True or False, # Optional. Reserved for future use.
"ephemeralStorageConfig": { # EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. # Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
"localSsdCount": 42, # Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. 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": { # EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. # Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config
"localSsdCount": 42, # 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.
},
"fastSocket": { # Configuration of Fast Socket feature. # Enable or disable NCCL fast socket for the node pool.
"enabled": True or False, # Whether Fast Socket features are enabled in the node pool.
},
"gcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # GCFS (Google Container File System) configs.
"enabled": True or False, # Whether to use GCFS.
},
"gvnic": { # Configuration of gVNIC feature. # Enable or disable gvnic on the node pool.
"enabled": True or False, # Whether gVNIC features are enabled in the node pool.
},
"hostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"imageType": "A 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.
"kubeletConfig": { # Node kubelet configs. # Node kubelet configs.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"labels": { # 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/
"a_key": "A String",
},
"linuxNodeConfig": { # Parameters that can be configured on Linux nodes. # Parameters that can be configured on Linux nodes.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"localNvmeSsdBlockConfig": { # LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs # Parameters for using raw-block Local NVMe SSDs.
"localSsdCount": 42, # 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.
},
"localSsdCount": 42, # 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.
"localSsdEncryptionMode": "A String", # Specifies which method should be used for encrypting the Local SSDs attahced to the node.
"loggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # Logging configuration.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"machineType": "A String", # The name of a Google Compute Engine [machine type](https://cloud.google.com/compute/docs/machine-types). If unspecified, the default machine type is `e2-medium`.
"metadata": { # 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-oslogin" - "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.
"a_key": "A String",
},
"minCpuPlatform": "A 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](https://cloud.google.com/compute/docs/instances/specify-min-cpu-platform).
"nodeGroup": "A 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](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes).
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"preemptible": True or False, # 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.
"reservationAffinity": { # [ReservationAffinity](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) is the configuration of desired reservation which instances could take capacity from. # The optional reservation affinity. Setting this field will apply the specified [Zonal Compute Reservation](https://cloud.google.com/compute/docs/instances/reserving-zonal-resources) to this node pool.
"consumeReservationType": "A String", # Corresponds to the type of reservation consumption.
"key": "A 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": [ # Corresponds to the label value(s) of reservation resource(s).
"A String",
],
},
"resourceLabels": { # The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # A map of resource manager tag keys and values to be attached to the nodes.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"sandboxConfig": { # SandboxConfig contains configurations of the sandbox to use for the node. # Sandbox configuration for this node.
"sandboxType": "A String", # Type of the sandbox to use for the node (e.g. 'gvisor')
"type": "A String", # Type of the sandbox to use for the node.
},
"secondaryBootDiskUpdateStrategy": { # SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. # Secondary boot disk update strategy.
},
"secondaryBootDisks": [ # List of secondary boot disks attached to the nodes.
{ # SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
"diskImage": "A String", # Fully-qualified resource ID for an existing disk image.
"mode": "A String", # Disk mode (container image cache, etc.)
},
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"soleTenantConfig": { # SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. # Parameters for node pools to be backed by shared sole tenant node groups.
"nodeAffinities": [ # NodeAffinities used to match to a shared sole tenant node group.
{ # Specifies the NodeAffinity key, values, and affinity operator according to [shared sole tenant node group affinities](https://cloud.google.com/compute/docs/nodes/sole-tenant-nodes#node_affinity_and_anti-affinity).
"key": "A String", # Key for NodeAffinity.
"operator": "A String", # Operator for NodeAffinity.
"values": [ # Values for NodeAffinity.
"A String",
],
},
],
},
"spot": True or False, # Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
"storagePools": [ # List of Storage Pools where boot disks are provisioned.
"A String",
],
"tags": [ # 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.
"A String",
],
"taints": [ # 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/
{ # Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute. See [here](https://kubernetes.io/docs/concepts/configuration/taint-and-toleration) for more information, including usage and the valid values.
"effect": "A String", # Effect for taint.
"key": "A String", # Key for taint.
"value": "A String", # Value for taint.
},
],
"windowsNodeConfig": { # Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings # Parameters that can be configured on Windows nodes.
"osVersion": "A String", # OSVersion specifies the Windows node config to be used on the node
},
"workloadMetadataConfig": { # WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. # The workload metadata configuration for this node.
"mode": "A String", # Mode is the configuration for how to expose metadata to workloads running on the node pool.
"nodeMetadata": "A String", # NodeMetadata is the configuration for how to expose metadata to the workloads running on the node.
},
},
"etag": "A 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.
"initialNodeCount": 42, # The initial node count for the pool. You must ensure that your Compute Engine [resource quota](https://cloud.google.com/compute/quotas) is sufficient for this number of instances. You must also have available firewall and routes quota.
"instanceGroupUrls": [ # Output only. The resource URLs of the [managed instance groups](https://cloud.google.com/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
"A String",
],
"locations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the [Cluster.Locations](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1/projects.locations.clusters#Cluster.FIELDS.locations) value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed.
"A String",
],
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"maxPodsConstraint": { # Constraints applied to pods. # The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"name": "A String", # The name of the node pool.
"networkConfig": { # Parameters for node pool-level network config. # Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.
"additionalNodeNetworkConfigs": [ # We specify the additional node networks for this node pool using this list. Each node network corresponds to an additional interface
{ # AdditionalNodeNetworkConfig is the configuration for additional node networks within the NodeNetworkConfig message
"network": "A String", # Name of the VPC where the additional interface belongs
"subnetwork": "A String", # Name of the subnetwork where the additional interface belongs
},
],
"additionalPodNetworkConfigs": [ # 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
{ # AdditionalPodNetworkConfig is the configuration for additional pod networks within the NodeNetworkConfig message
"maxPodsPerNode": { # Constraints applied to pods. # The maximum number of pods per node which use this pod network.
"maxPodsPerNode": "A String", # Constraint enforced on the max num of pods per node.
},
"networkAttachment": "A String", # The name of the network attachment for pods to communicate to; cannot be specified along with subnetwork or secondary_pod_range.
"secondaryPodRange": "A String", # The name of the secondary range on the subnet which provides IP address for this pod range.
"subnetwork": "A String", # Name of the subnetwork where the additional pod network belongs.
},
],
"createPodRange": True or False, # 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.
"enablePrivateNodes": True or False, # 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
"networkPerformanceConfig": { # Configuration of all network bandwidth tiers # Network bandwidth tier configuration.
"externalIpEgressBandwidthTier": "A String", # Specifies the network bandwidth tier for the NodePool for traffic to external/public IP addresses.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"podCidrOverprovisionConfig": { # [PRIVATE FIELD] Config for pod CIDR size overprovisioning. # [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.
"disable": True or False, # Whether Pod CIDR overprovisioning is disabled. Note: Pod CIDR overprovisioning is enabled by default.
},
"podIpv4CidrBlock": "A 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](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) 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.
"podIpv4RangeUtilization": 3.14, # 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.
"podRange": "A 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.
},
"placementPolicy": { # PlacementPolicy defines the placement policy used by the node pool. # Specifies the node placement policy.
"policyName": "A 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.
"tpuTopology": "A String", # TPU placement topology for pod slice node pool. https://cloud.google.com/tpu/docs/types-topologies#tpu_topologies
"type": "A String", # The type of placement.
},
"podIpv4CidrSize": 42, # Output only. The pod CIDR block size per node in this node pool.
"queuedProvisioning": { # QueuedProvisioning defines the queued provisioning used by the node pool. # Specifies the configuration of queued provisioning.
"enabled": True or False, # Denotes that this nodepool is QRM specific, meaning nodes can be only obtained through queuing via the Cluster Autoscaler ProvisioningRequest API.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"status": "A String", # Output only. The status of the nodes in this pool instance.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
"updateInfo": { # UpdateInfo contains resource (instance groups, etc), status and other intermediate information relevant to a node pool upgrade. # Output only. Update info contains relevant information during a node pool update.
"blueGreenInfo": { # Information relevant to blue-green upgrade. # Information of a blue-green upgrade.
"blueInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with blue pool.
"A String",
],
"bluePoolDeletionStartTime": "A String", # Time to start deleting blue pool to complete blue-green upgrade, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"greenInstanceGroupUrls": [ # The resource URLs of the [managed instance groups] (/compute/docs/instance-groups/creating-groups-of-managed-instances) associated with green pool.
"A String",
],
"greenPoolVersion": "A String", # Version of green pool.
"phase": "A String", # Current blue-green upgrade phase.
},
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
"version": "A String", # The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described [here](https://cloud.google.com/kubernetes-engine/versioning#specifying_node_version).
},
],
"notificationConfig": { # NotificationConfig is the configuration of notifications. # Notification configuration of the cluster.
"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.
"enabled": True or False, # Enable notifications for Pub/Sub.
"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 # 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
"eventType": [ # Event types to allowlist.
"A String",
],
},
"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.
},
},
"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. # 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.
"labels": { # Labels contain the configuration of the parent product.
"a_key": "A String",
},
"productName": "A String", # Name of the parent product associated with the cluster.
},
"podAutoscaling": { # PodAutoscaling is used for configuration of parameters for workload autoscaling. # The config for pod autoscaling.
"hpaProfile": "A String", # Selected Horizontal Pod Autoscaling profile.
},
"podSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # Configuration for the PodSecurityPolicy feature.
"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.
},
"privateCluster": True or False, # If this is a private cluster setup. Private clusters are clusters that, by default have no external IP addresses on the nodes and where nodes and the master communicate over private IP addresses. This field is deprecated, use private_cluster_config.enable_private_nodes instead.
"privateClusterConfig": { # Configuration options for private clusters. # Configuration for private cluster.
"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. 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.
"enablePrivateNodes": True or False, # 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.
"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access instead.
"enabled": True or False, # Whenever master is accessible globally or not.
},
"masterIpv4CidrBlock": "A 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.
"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint instead.
"privateEndpointSubnetwork": "A String", # 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint instead.
},
"protectConfig": { # ProtectConfig defines the flags needed to enable/disable features for the Protect API. # Deprecated: Use SecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.
"workloadConfig": { # WorkloadConfig defines the flags to enable or disable the workload configurations for the cluster. # WorkloadConfig defines which actions are enabled for a cluster's workload configurations.
"auditMode": "A String", # Sets which mode of auditing should be used for the cluster's workloads.
},
"workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature.
},
"rbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
"enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.
"enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.
},
"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. # 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.
"channel": "A String", # channel specifies which release channel the cluster is subscribed to.
},
"resourceLabels": { # The resource labels for the cluster to use to annotate any related Google Compute Engine resources.
"a_key": "A String",
},
"resourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # Configuration for exporting resource usages. Resource usage export is disabled when this config unspecified.
"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
"datasetId": "A String", # The ID of a BigQuery Dataset.
},
"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
},
"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
},
"satisfiesPzi": True or False, # Output only. Reserved for future use.
"satisfiesPzs": True or False, # Output only. Reserved for future use.
"secretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Secret CSI driver configuration.
"enabled": True or False, # Enable/Disable Secret Manager Config.
},
"securityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
"selfLink": "A String", # Output only. Server-defined URL for the resource.
"servicesIpv4Cidr": "A String", # Output only. The IP address range of the Kubernetes services in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`). Service addresses are typically put in the last `/16` from the container CIDR.
"shieldedNodes": { # Configuration of Shielded Nodes feature. # Shielded Nodes configuration.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
"status": "A String", # Output only. The current status of this cluster.
"statusMessage": "A String", # Output only. Deprecated. Use conditions instead. Additional information about the current status of this cluster, if available.
"subnetwork": "A String", # The name of the Google Compute Engine [subnetwork](https://cloud.google.com/compute/docs/subnetworks) to which the cluster is connected. On output this shows the subnetwork ID instead of the name.
"tpuConfig": { # Configuration for Cloud TPU. # Configuration for Cloud TPU support;
"enabled": True or False, # Whether Cloud TPU integration is enabled or not.
"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.
},
"tpuIpv4CidrBlock": "A String", # Output only. The IP address range of the Cloud TPUs in this cluster, in [CIDR](http://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) notation (e.g. `1.2.3.4/29`).
"userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
"aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
"clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster.
"controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.
"etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.
"etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.
"gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.
"serviceAccountSigningKeys": [ # 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}`
"A String",
],
"serviceAccountVerificationKeys": [ # 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}`
"A String",
],
},
"verticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"workloadAltsConfig": { # Configuration for direct-path (via ALTS) with workload identity. # Configuration for direct-path (via ALTS) with workload identity.
"enableAlts": True or False, # enable_alts controls whether the alts handshaker should be enabled or not for direct-path. Requires Workload Identity (workload_pool must be non-empty).
},
"workloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"workloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies.
"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.
"identityProvider": "A String", # identity provider is the third party identity provider.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
"zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field is deprecated, use location instead.
},
],
"missingZones": [ # If any zones are listed here, the list of clusters returned may be missing those zones.
"A String",
],
}

locations(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the locations for a specific cluster. Deprecated. Use [projects.locations.clusters.update](https://cloud.google.com/kubernetes-engine/docs/reference/rest/v1beta1/projects.locations.clusters/update) instead.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetLocationsRequest sets the locations of the cluster.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  "locations": [ # Required. The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. Changing the locations a cluster is in will result in nodes being either created or removed from the cluster, depending on whether locations are being added or removed. This list must always include the cluster's primary zone.
    "A String",
  ],
  "name": "A String", # The name (project, location, cluster) of the cluster to set locations. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

logging(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the logging service for a specific cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetLoggingServiceRequest sets the logging service of a cluster.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  "loggingService": "A String", # Required. 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.
  "name": "A String", # The name (project, location, cluster) of the cluster to set logging. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

master(projectId, zone, clusterId, body=None, x__xgafv=None)

Updates the master for a specific cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # UpdateMasterRequest updates the master of the cluster.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  "masterVersion": "A String", # Required. The Kubernetes version to change the master to. 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
  "name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

monitoring(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the monitoring service for a specific cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetMonitoringServiceRequest sets the monitoring service of a cluster.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  "monitoringService": "A String", # Required. 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.
  "name": "A String", # The name (project, location, cluster) of the cluster to set monitoring. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

resourceLabels(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets labels on a cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # 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
  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
  "labelFingerprint": "A String", # Required. The fingerprint of the previous set of labels for this resource, used to detect conflicts. The fingerprint is initially generated by Kubernetes Engine and changes after every request to modify or update labels. You must always provide an up-to-date fingerprint hash when updating or changing labels. Make a `get()` request to the resource to get the latest fingerprint.
  "name": "A String", # The name (project, location, cluster name) of the cluster to set labels. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "resourceLabels": { # Required. The labels to set for that cluster.
    "a_key": "A String",
  },
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

setMaintenancePolicy(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets the maintenance policy for a cluster.

Args:
  projectId: string, Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). (required)
  zone: string, Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. (required)
  clusterId: string, Required. The name of the cluster to update. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetMaintenancePolicyRequest sets the maintenance policy for a cluster.
  "clusterId": "A String", # Required. The name of the cluster to update.
  "maintenancePolicy": { # MaintenancePolicy defines the maintenance policy to be used for the cluster. # Required. The maintenance policy to be set for the cluster. An empty field clears the existing maintenance policy.
    "resourceVersion": "A 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.
    "window": { # MaintenanceWindow defines the maintenance window to be used for the cluster. # Specifies the maintenance window in which maintenance may be performed.
      "dailyMaintenanceWindow": { # Time window specified for daily maintenance operations. # DailyMaintenanceWindow specifies a daily maintenance operation window.
        "duration": "A String", # Output only. Duration of the time window, automatically chosen to be smallest possible in the given scenario.
        "startTime": "A String", # Time within the maintenance window to start the maintenance operations. It must be in format "HH:MM", where HH : [00-23] and MM : [00-59] GMT.
      },
      "maintenanceExclusions": { # Exceptions to maintenance window. Non-emergency maintenance should not occur in these windows.
        "a_key": { # Represents an arbitrary window of time.
          "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
          "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
            "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
          },
          "startTime": "A String", # The time that the window first starts.
        },
      },
      "recurringWindow": { # Represents an arbitrary window of time that recurs. # 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.
        "recurrence": "A String", # 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: `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.
        "window": { # Represents an arbitrary window of time. # The window of the first recurrence.
          "endTime": "A String", # The time that the window ends. The end time should take place after the start time.
          "maintenanceExclusionOptions": { # Represents the Maintenance exclusion option. # MaintenanceExclusionOptions provides maintenance exclusion related options.
            "scope": "A String", # Scope specifies the upgrade scope which upgrades are blocked by the exclusion.
          },
          "startTime": "A String", # The time that the window first starts.
        },
      },
    },
  },
  "name": "A String", # The name (project, location, cluster name) of the cluster to set maintenance policy. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects).
  "zone": "A String", # Required. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

setMasterAuth(projectId, zone, clusterId, body=None, x__xgafv=None)

Sets master auth materials. Currently supports changing the admin password or a specific cluster, either via password generation or explicitly setting the password.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetMasterAuthRequest updates the admin password of a cluster.
  "action": "A String", # Required. The exact form of action to be taken on the master auth.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster) of the cluster to set auth. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "update": { # The authentication information for accessing the master endpoint. Authentication can be done using HTTP basic auth or using client certificates. # Required. A description of the update.
    "clientCertificate": "A String", # Output only. Base64-encoded public certificate used by clients to authenticate to the cluster endpoint. Issued only if client_certificate_config is set.
    "clientCertificateConfig": { # Configuration for client certificates on the cluster. # Configuration for client certificate authentication on the cluster. For clusters before v1.12, if no configuration is specified, a client certificate is issued.
      "issueClientCertificate": True or False, # Issue a client certificate.
    },
    "clientKey": "A String", # Output only. Base64-encoded private key used by clients to authenticate to the cluster endpoint.
    "clusterCaCertificate": "A String", # Output only. Base64-encoded public certificate that is the root of trust for the cluster.
    "password": "A String", # 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
    "username": "A String", # 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
  },
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

setNetworkPolicy(projectId, zone, clusterId, body=None, x__xgafv=None)

Enables or disables Network Policy for a cluster.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # SetNetworkPolicyRequest enables/disables network policy for a cluster.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster name) of the cluster to set networking policy. Specified in the format `projects/*/locations/*/clusters/*`.
  "networkPolicy": { # Configuration options for the NetworkPolicy feature. https://kubernetes.io/docs/concepts/services-networking/networkpolicies/ # Required. Configuration options for the NetworkPolicy feature.
    "enabled": True or False, # Whether network policy is enabled on the cluster.
    "provider": "A String", # The selected network policy provider.
  },
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

startIpRotation(projectId, zone, clusterId, body=None, x__xgafv=None)

Starts master IP rotation.

Args:
  projectId: string, Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field. (required)
  zone: string, Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field. (required)
  clusterId: string, Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field. (required)
  body: object, The request body.
    The object takes the form of:

{ # StartIPRotationRequest creates a new IP for the cluster and then performs a node upgrade on each node pool to point to the new IP.
  "clusterId": "A String", # Required. Deprecated. The name of the cluster. This field has been deprecated and replaced by the name field.
  "name": "A String", # The name (project, location, cluster name) of the cluster to start IP rotation. Specified in the format `projects/*/locations/*/clusters/*`.
  "projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
  "rotateCredentials": True or False, # Whether to rotate credentials during IP rotation.
  "zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # This operation resource represents operations that may have happened or are happening on the cluster. All fields are output only.
  "clusterConditions": [ # Which conditions caused the current cluster state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "detail": "A String", # Output only. Detailed operation progress, if available.
  "endTime": "A String", # Output only. The time the operation completed, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "location": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) or [region](https://cloud.google.com/compute/docs/regions-zones/regions-zones#available) in which the cluster resides.
  "name": "A String", # Output only. The server-assigned ID for the operation.
  "nodepoolConditions": [ # Which conditions caused the current node pool state. Deprecated. Use field error instead.
    { # StatusCondition describes why a cluster or a node pool has a certain status (e.g., ERROR or DEGRADED).
      "canonicalCode": "A String", # Canonical code of the condition.
      "code": "A String", # Machine-friendly representation of the condition Deprecated. Use canonical_code instead.
      "message": "A String", # Human-friendly representation of the condition
    },
  ],
  "operationType": "A String", # Output only. The operation type.
  "progress": { # Information about operation (or operation stage) progress. # Output only. Progress information for an operation.
    "metrics": [ # Progress metric bundle, for example: metrics: [{name: "nodes done", int_value: 15}, {name: "nodes total", int_value: 32}] or metrics: [{name: "progress", double_value: 0.56}, {name: "progress scale", double_value: 1.0}]
      { # Progress metric is (string, int|float|string) pair.
        "doubleValue": 3.14, # For metrics with floating point value.
        "intValue": "A String", # For metrics with integer value.
        "name": "A String", # Required. Metric name, e.g., "nodes total", "percent done".
        "stringValue": "A String", # For metrics with custom values (ratios, visual progress, etc.).
      },
    ],
    "name": "A String", # A non-parameterized string describing an operation stage. Unset for single-stage operations.
    "stages": [ # Substages of an operation or a stage.
      # Object with schema name: OperationProgress
    ],
    "status": "A String", # Status of an operation stage. Unset for single-stage operations.
  },
  "selfLink": "A String", # Output only. Server-defined URI for the operation. Example: `https://container.googleapis.com/v1alpha1/projects/123/locations/us-central1/operations/operation-123`.
  "startTime": "A String", # Output only. The time the operation started, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
  "status": "A String", # Output only. The current status of the operation.
  "statusMessage": "A String", # Output only. If an error has occurred, a textual description of the error. Deprecated. Use field error instead.
  "targetLink": "A String", # Output only. Server-defined URI for the target of the operation. The format of this is a URI to the resource being modified (such as a cluster, node pool, or node). For node pool repairs, there may be multiple nodes being repaired, but only one will be the target. Examples: - ## `https://container.googleapis.com/v1/projects/123/locations/us-central1/clusters/my-cluster` ## `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np` `https://container.googleapis.com/v1/projects/123/zones/us-central1-c/clusters/my-cluster/nodePools/my-np/node/my-node`
  "zone": "A String", # Output only. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the operation is taking place. This field is deprecated, use location instead.
}

update(projectId, zone, clusterId, body=None, x__xgafv=None)

Updates the settings for a specific cluster.

{ # UpdateClusterRequest updates the settings of a cluster.
"clusterId": "A String", # Required. Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field.
"name": "A String", # The name (project, location, cluster) of the cluster to update. Specified in the format `projects/*/locations/*/clusters/*`.
"projectId": "A String", # Required. Deprecated. The Google Developers Console [project ID or project number](https://cloud.google.com/resource-manager/docs/creating-managing-projects). This field has been deprecated and replaced by the name field.
"update": { # 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. # Required. A description of the update.
"additionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges to be added to the cluster. These pod ranges can be used by node pools to allocate pod IPs.
"podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
"rangeName": "A String", # Output only. Name of a range.
"utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
"A String",
],
},
"desiredAddonsConfig": { # Configuration for the addons that can be automatically spun up in the cluster, enabling additional functionality. # Configurations for the various addons available to run in the cluster.
"cloudRunConfig": { # Configuration options for the Cloud Run feature. # Configuration for the Cloud Run addon. The `IstioConfig` addon must be enabled in order to enable Cloud Run addon. This option can only be enabled at cluster creation time.
"disabled": True or False, # Whether Cloud Run addon is enabled for this cluster.
"loadBalancerType": "A String", # Which load balancer type is installed for Cloud Run.
},
"configConnectorConfig": { # Configuration options for the Config Connector add-on. # Configuration for the ConfigConnector add-on, a Kubernetes extension to manage hosted GCP services through the Kubernetes API
"enabled": True or False, # Whether Cloud Connector is enabled for this cluster.
},
"dnsCacheConfig": { # Configuration for NodeLocal DNSCache # Configuration for NodeLocalDNS, a dns cache running on cluster nodes
"enabled": True or False, # Whether NodeLocal DNSCache is enabled for this cluster.
},
"gcePersistentDiskCsiDriverConfig": { # Configuration for the Compute Engine PD CSI driver. # Configuration for the Compute Engine Persistent Disk CSI driver.
"enabled": True or False, # Whether the Compute Engine PD CSI driver is enabled for this cluster.
},
"gcpFilestoreCsiDriverConfig": { # Configuration for the GCP Filestore CSI driver. # Configuration for the GCP Filestore CSI driver.
"enabled": True or False, # Whether the GCP Filestore CSI driver is enabled for this cluster.
},
"gcsFuseCsiDriverConfig": { # Configuration for the Cloud Storage Fuse CSI driver. # Configuration for the Cloud Storage Fuse CSI driver.
"enabled": True or False, # Whether the Cloud Storage Fuse CSI driver is enabled for this cluster.
},
"gkeBackupAgentConfig": { # Configuration for the Backup for GKE Agent. # Configuration for the Backup for GKE agent addon.
"enabled": True or False, # Whether the Backup for GKE agent is enabled for this cluster.
},
"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. # 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.
"disabled": True or False, # Whether the Horizontal Pod Autoscaling feature is enabled in the cluster. When enabled, it ensures that metrics are collected into Stackdriver Monitoring.
},
"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. # Configuration for the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster.
"disabled": True or False, # 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.
},
"istioConfig": { # Configuration options for Istio addon. # Configuration for Istio, an open platform to connect, manage, and secure microservices.
"auth": "A String", # The specified Istio auth mode, either none, or mutual TLS.
"disabled": True or False, # Whether Istio is enabled for this cluster.
},
"kalmConfig": { # Configuration options for the KALM addon. # Configuration for the KALM addon, which manages the lifecycle of k8s applications.
"enabled": True or False, # Whether KALM is enabled for this cluster.
},
"kubernetesDashboard": { # Configuration for the Kubernetes Dashboard. # 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
"disabled": True or False, # 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. # 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.
"disabled": True or False, # Whether NetworkPolicy is enabled for this cluster.
},
"parallelstoreCsiDriverConfig": { # Configuration for the Cloud Storage Parallelstore CSI driver. # Configuration for the Cloud Storage Parallelstore CSI driver.
"enabled": True or False, # Whether the Cloud Storage Parallelstore CSI driver is enabled for this cluster.
},
"rayOperatorConfig": { # Configuration options for the Ray Operator add-on. # Optional. Configuration for Ray Operator addon.
"enabled": True or False, # Whether the Ray addon is enabled for this cluster.
"rayClusterLoggingConfig": { # RayClusterLoggingConfig specifies logging configuration for Ray clusters. # Optional. Logging configuration for Ray clusters.
"enabled": True or False, # Enable log collection for Ray clusters.
},
"rayClusterMonitoringConfig": { # RayClusterMonitoringConfig specifies monitoring configuration for Ray clusters. # Optional. Monitoring configuration for Ray clusters.
"enabled": True or False, # Enable metrics collection for Ray clusters.
},
},
"statefulHaConfig": { # Configuration for the Stateful HA add-on. # Optional. Configuration for the StatefulHA add-on.
"enabled": True or False, # Whether the Stateful HA add-on is enabled for this cluster.
},
},
"desiredAuthenticatorGroupsConfig": { # Configuration for returning group information from authenticators. # AuthenticatorGroupsConfig specifies the config for the cluster security groups settings.
"enabled": True or False, # Whether this cluster should return group membership lookups during authentication using a group of security groups.
"securityGroup": "A String", # The name of the security group-of-groups to be used. Only relevant if enabled = true.
},
"desiredAutopilotWorkloadPolicyConfig": { # WorkloadPolicyConfig is the configuration of workload policy for autopilot clusters. # The desired workload policy configuration for the autopilot cluster.
"allowNetAdmin": True or False, # If true, workloads can use NET_ADMIN capability.
},
"desiredBinaryAuthorization": { # Configuration for Binary Authorization. # The desired configuration options for the Binary Authorization feature.
"enabled": True or False, # 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": "A String", # Mode of operation for binauthz policy evaluation. If unspecified, defaults to DISABLED.
"policyBindings": [ # Optional. Binauthz policies that apply to this cluster.
{ # Binauthz policy that applies to this cluster.
"name": "A String", # The relative resource name of the binauthz platform policy to evaluate. GKE platform policies have the following format: `projects/{project_number}/platforms/gke/policies/{policy_id}`.
},
],
},
"desiredClusterAutoscaling": { # 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. # Cluster-level autoscaling configuration.
"autoprovisioningLocations": [ # The list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the NodePool's nodes can be created by NAP.
"A String",
],
"autoprovisioningNodePoolDefaults": { # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP. # AutoprovisioningNodePoolDefaults contains defaults for a node pool created by NAP.
"bootDiskKmsKey": "A 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
"diskSizeGb": 42, # 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": "A 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'
"imageType": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"management": { # NodeManagement defines the set of node management services turned on for the node pool. # NodeManagement configuration for this NodePool.
"autoRepair": True or False, # Whether the nodes will be automatically repaired.
"autoUpgrade": True or False, # Whether the nodes will be automatically upgraded.
"upgradeOptions": { # AutoUpgradeOptions defines the set of options for the user to control how the Auto Upgrades will proceed. # Specifies the Auto Upgrade knobs for the node pool.
"autoUpgradeStartTime": "A String", # Output only. This field is set when upgrades are about to commence with the approximate start time for the upgrades, in [RFC3339](https://www.ietf.org/rfc/rfc3339.txt) text format.
"description": "A String", # Output only. This field is set when upgrades are about to commence with the description of the upgrade.
},
},
"minCpuPlatform": "A String", # 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](https://cloud.google.com/compute/docs/instances/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.
"oauthScopes": [ # 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 [Google Container Registry](https://cloud.google.com/container-registry/)). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
"A String",
],
"serviceAccount": "A 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.
"shieldedInstanceConfig": { # A set of Shielded Instance options. # Shielded Instance options.
"enableIntegrityMonitoring": True or False, # 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.
"enableSecureBoot": True or False, # 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.
},
"upgradeSettings": { # 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. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. 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. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue-green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. # Upgrade settings control disruption and speed of the upgrade.
"blueGreenSettings": { # Settings for blue-green upgrade. # Settings for blue-green upgrade strategy.
"autoscaledRolloutPolicy": { # Autoscaled rollout policy uses cluster autoscaler during blue-green upgrades to scale both the green and blue pools. # Autoscaled policy for cluster autoscaler enabled blue-green upgrade.
},
"nodePoolSoakDuration": "A String", # Time needed after draining entire blue pool. After this period, blue pool will be cleaned up.
"standardRolloutPolicy": { # Standard rollout policy is the default policy for blue-green. # Standard policy for the blue-green upgrade.
"batchNodeCount": 42, # Number of blue nodes to drain in a batch.
"batchPercentage": 3.14, # Percentage of the blue pool nodes to drain in a batch. The range of this field should be (0.0, 1.0].
"batchSoakDuration": "A String", # Soak time after each batch gets drained. Default to zero.
},
},
"maxSurge": 42, # The maximum number of nodes that can be created beyond the current size of the node pool during the upgrade process.
"maxUnavailable": 42, # The maximum number of nodes that can be simultaneously unavailable during the upgrade process. A node is considered available if its status is Ready.
"strategy": "A String", # Update strategy of the node pool.
},
},
"autoscalingProfile": "A String", # Defines autoscaling behaviour.
"enableNodeAutoprovisioning": True or False, # Enables automatic node pool creation and deletion.
"resourceLimits": [ # Contains global constraints regarding minimum and maximum amount of resources in the cluster.
{ # Contains information about amount of some resource in the cluster. For memory, value should be in GB.
"maximum": "A String", # Maximum amount of the resource in the cluster.
"minimum": "A String", # Minimum amount of the resource in the cluster.
"resourceType": "A String", # Resource name "cpu", "memory" or gpu-specific string.
},
],
},
"desiredClusterTelemetry": { # Telemetry integration for the cluster. # The desired telemetry integration for the cluster.
"type": "A String", # Type of the integration.
},
"desiredCompliancePostureConfig": { # CompliancePostureConfig defines the settings needed to enable/disable features for the Compliance Posture. # Enable/Disable Compliance Posture features for the cluster.
"complianceStandards": [ # List of enabled compliance standards.
{ # Defines the details of a compliance standard.
"standard": "A String", # Name of the compliance standard.
},
],
"mode": "A String", # Defines the enablement mode for Compliance Posture.
},
"desiredContainerdConfig": { # ContainerdConfig contains configuration to customize containerd. # The desired containerd config for the cluster.
"privateRegistryAccessConfig": { # PrivateRegistryAccessConfig contains access configuration for private container registries. # PrivateRegistryAccessConfig is used to configure access configuration for private container registries.
"certificateAuthorityDomainConfig": [ # Private registry access configuration.
{ # CertificateAuthorityDomainConfig configures one or more fully qualified domain names (FQDN) to a specific certificate.
"fqdns": [ # List of fully qualified domain names (FQDN). Specifying port is supported. Wilcards are NOT supported. Examples: - my.customdomain.com - 10.0.1.2:5000
"A String",
],
"gcpSecretManagerCertificateConfig": { # GCPSecretManagerCertificateConfig configures a secret from [Google Secret Manager](https://cloud.google.com/secret-manager). # Google Secret Manager (GCP) certificate configuration.
"secretUri": "A String", # Secret URI, in the form "projects/$PROJECT_ID/secrets/$SECRET_NAME/versions/$VERSION". Version can be fixed (e.g. "2") or "latest"
},
},
],
"enabled": True or False, # Private registry access is enabled.
},
},
"desiredControlPlaneEndpointsConfig": { # Configuration for all of the cluster's control plane endpoints. # Control plane endpoints configuration.
"dnsEndpointConfig": { # Describes the configuration of a DNS endpoint. # DNS endpoint configuration.
"allowExternalTraffic": True or False, # Controls whether user traffic is allowed over this endpoint. Note that GCP-managed services may still use the endpoint even if this is false.
"endpoint": "A 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.
},
"ipEndpointsConfig": { # IP endpoints configuration. # IP endpoints configuration.
"authorizedNetworksConfig": { # 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. # 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.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"enablePublicEndpoint": True or False, # 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.
"enabled": True or False, # Controls whether to allow direct IP access.
"globalAccess": True or False, # 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.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's control plane. Only populated if enabled.
"privateEndpointSubnetwork": "A 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's control plane. Only populated if enabled.
},
},
"desiredCostManagementConfig": { # Configuration for fine-grained cost management feature. # The desired configuration for the fine-grained cost management feature.
"enabled": True or False, # Whether the feature is enabled or not.
},
"desiredDatabaseEncryption": { # Configuration of etcd encryption. # Configuration of etcd encryption.
"currentState": "A String", # Output only. The current state of etcd encryption.
"decryptionKeys": [ # 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.
"A String",
],
"keyName": "A 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
"lastOperationErrors": [ # Output only. Records errors seen during DatabaseEncryption update operations.
{ # OperationError records errors seen from CloudKMS keys encountered during updates to DatabaseEncryption configuration.
"errorMessage": "A String", # Description of the error seen during the operation.
"keyName": "A String", # CloudKMS key resource that had the error.
"timestamp": "A String", # Time when the CloudKMS error was seen.
},
],
"state": "A String", # The desired state of etcd encryption.
},
"desiredDatapathProvider": "A String", # The desired datapath provider for the cluster.
"desiredDefaultEnablePrivateNodes": True or False, # Override the default setting of whether future created nodes have private IP addresses only, namely NetworkConfig.default_enable_private_nodes
"desiredDefaultSnatStatus": { # DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster. # The desired status of whether to disable default sNAT for this cluster.
"disabled": True or False, # Disables cluster default sNAT rules.
},
"desiredDnsConfig": { # DNSConfig contains the desired set of options for configuring clusterDNS. # DNSConfig contains clusterDNS config for this cluster.
"additiveVpcScopeDnsDomain": "A String", # Optional. The domain used in Additive VPC scope.
"clusterDns": "A String", # cluster_dns indicates which in-cluster DNS provider should be used.
"clusterDnsDomain": "A String", # cluster_dns_domain is the suffix used for all cluster service records.
"clusterDnsScope": "A String", # cluster_dns_scope indicates the scope of access to cluster DNS records.
},
"desiredEnableCiliumClusterwideNetworkPolicy": True or False, # Enable/Disable Cilium Clusterwide Network Policy for the cluster.
"desiredEnableFqdnNetworkPolicy": True or False, # Enable/Disable FQDN Network Policy for the cluster.
"desiredEnableMultiNetworking": True or False, # Enable/Disable Multi-Networking for the cluster
"desiredEnablePrivateEndpoint": True or False, # Enable/Disable private endpoint for the cluster's master. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.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.
"desiredEnterpriseConfig": { # DesiredEnterpriseConfig is a wrapper used for updating enterprise_config. # The desired enterprise configuration for the cluster.
"desiredTier": "A String", # desired_tier specifies the desired tier of the cluster.
},
"desiredFleet": { # Fleet is the fleet configuration for the cluster. # The desired fleet configuration for the cluster.
"membership": "A 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": True or False, # Output only. Whether the cluster has been registered through the fleet API.
"project": "A 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.
},
"desiredGatewayApiConfig": { # GatewayAPIConfig contains the desired config of Gateway API on this cluster. # The desired config of Gateway API on this cluster.
"channel": "A String", # The Gateway API release channel to use for Gateway API.
},
"desiredGcfsConfig": { # GcfsConfig contains configurations of Google Container File System. # The desired GCFS config for the cluster.
"enabled": True or False, # Whether to use GCFS.
},
"desiredHostMaintenancePolicy": { # HostMaintenancePolicy contains the maintenance policy for the hosts on which the GKE VMs run on. # HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
"maintenanceInterval": "A String", # Specifies the frequency of planned maintenance events.
"opportunisticMaintenanceStrategy": { # Strategy that will trigger maintenance on behalf of the customer. # Strategy that will trigger maintenance on behalf of the customer.
"maintenanceAvailabilityWindow": "A String", # The window of time that opportunistic maintenance can run. Example: A setting of 14 days implies that opportunistic maintenance can only be ran in the 2 weeks leading up to the scheduled maintenance date. Setting 28 days allows opportunistic maintenance to run at any time in the scheduled maintenance window (all `PERIODIC` maintenance is set 28 days in advance).
"minNodesPerPool": "A String", # The minimum nodes required to be available in a pool. Blocks maintenance if it would cause the number of running nodes to dip below this value.
"nodeIdleTimeWindow": "A String", # The amount of time that a node can remain idle (no customer owned workloads running), before triggering maintenance.
},
},
"desiredIdentityServiceConfig": { # IdentityServiceConfig is configuration for Identity Service which allows customers to use external identity providers with the K8S API # The desired Identity Service component configuration.
"enabled": True or False, # Whether to enable the Identity Service component
},
"desiredImageType": "A String", # The desired image type for the node pool. NOTE: Set the "desired_node_pool" field as well.
"desiredInTransitEncryptionConfig": "A String", # Specify the details of in-transit encryption. Now named inter-node transparent encryption.
"desiredIntraNodeVisibilityConfig": { # IntraNodeVisibilityConfig contains the desired config of the intra-node visibility on this cluster. # The desired config of Intra-node visibility.
"enabled": True or False, # Enables intra node visibility for this cluster.
},
"desiredK8sBetaApis": { # Kubernetes open source beta apis enabled on the cluster. # Beta APIs enabled for cluster.
"enabledApis": [ # api name, e.g. storage.k8s.io/v1beta1/csistoragecapacities.
"A String",
],
},
"desiredL4ilbSubsettingConfig": { # ILBSubsettingConfig contains the desired config of L4 Internal LoadBalancer subsetting on this cluster. # The desired L4 Internal Load Balancer Subsetting configuration.
"enabled": True or False, # Enables l4 ILB subsetting for this cluster
},
"desiredLocations": [ # The desired list of Google Compute Engine [zones](https://cloud.google.com/compute/docs/zones#available) in which the cluster's nodes should be located. This list must always include the cluster's primary zone. Warning: changing cluster locations will update the locations of all node pools and will result in nodes being added and/or removed.
"A String",
],
"desiredLoggingConfig": { # LoggingConfig is cluster logging configuration. # The desired logging configuration.
"componentConfig": { # LoggingComponentConfig is cluster logging component configuration. # Logging components configuration
"enableComponents": [ # Select components to collect logs. An empty set would disable all logging.
"A String",
],
},
},
"desiredLoggingService": "A 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.
"desiredMaster": { # Master is the configuration for components on master. # Configuration for master components.
},
"desiredMasterAuthorizedNetworksConfig": { # 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. # The desired configuration options for master authorized networks feature. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.authorized_networks_config instead.
"cidrBlocks": [ # cidr_blocks define up to 10 external networks that could access Kubernetes master through HTTPS.
{ # CidrBlock contains an optional name and one CIDR block.
"cidrBlock": "A String", # cidr_block must be specified in CIDR notation.
"displayName": "A String", # display_name is an optional field for users to identify CIDR blocks.
},
],
"enabled": True or False, # Whether or not master authorized networks is enabled.
"gcpPublicCidrsAccessEnabled": True or False, # Whether master is accessbile via Google Compute Engine Public IP addresses.
"privateEndpointEnforcementEnabled": True or False, # Whether master authorized networks is enforced on private endpoint or not.
},
"desiredMasterVersion": "A String", # The Kubernetes version to change the master to. The only valid value is the latest supported version. 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
"desiredMeshCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"desiredMonitoringConfig": { # MonitoringConfig is cluster monitoring configuration. # The desired monitoring configuration.
"advancedDatapathObservabilityConfig": { # AdvancedDatapathObservabilityConfig specifies configuration of observability features of advanced datapath. # Configuration of Advanced Datapath Observability features.
"enableMetrics": True or False, # Expose flow metrics on nodes
"enableRelay": True or False, # Enable Relay component
"relayMode": "A String", # Method used to make Relay available
},
"componentConfig": { # MonitoringComponentConfig is cluster monitoring component configuration. # Monitoring components configuration
"enableComponents": [ # Select components to collect metrics. An empty set would disable all monitoring.
"A String",
],
},
"managedPrometheusConfig": { # ManagedPrometheusConfig defines the configuration for Google Cloud Managed Service for Prometheus. # Enable Google Cloud Managed Service for Prometheus in the cluster.
"autoMonitoringConfig": { # AutoMonitoringConfig defines the configuration for GKE Workload Auto-Monitoring. # GKE Workload Auto-Monitoring Configuration.
"scope": "A String", # Scope for GKE Workload Auto-Monitoring.
},
"enabled": True or False, # Enable Managed Collection.
},
},
"desiredMonitoringService": "A 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.
"desiredNetworkPerformanceConfig": { # Configuration of all network bandwidth tiers # The desired network performance config.
"totalEgressBandwidthTier": "A String", # Specifies the total network bandwidth tier for the NodePool.
},
"desiredNodeKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for the cluster.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"desiredNodePoolAutoConfigKubeletConfig": { # Node kubelet configs. # The desired node kubelet config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"cpuCfsQuota": True or False, # 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": "A 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.
"cpuManagerPolicy": "A 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.
"insecureKubeletReadonlyPortEnabled": True or False, # Enable or disable Kubelet read only port.
"podPidsLimit": "A String", # 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.
},
"desiredNodePoolAutoConfigLinuxNodeConfig": { # Parameters that can be configured on Linux nodes. # The desired Linux node config for all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters. Currently only `cgroup_mode` can be set here.
"cgroupMode": "A String", # cgroup_mode specifies the cgroup mode to be used on the node.
"hugepages": { # Hugepages amount in both 2m and 1g size # Optional. Amounts for 2M and 1G hugepages
"hugepageSize1g": 42, # Optional. Amount of 1G hugepages
"hugepageSize2m": 42, # Optional. Amount of 2M hugepages
},
"sysctls": { # 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.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 kernel.shmmni kernel.shmmax kernel.shmall
"a_key": "A String",
},
},
"desiredNodePoolAutoConfigNetworkTags": { # Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See `tags` field in [`NodeConfig`](/kubernetes-engine/docs/reference/rest/v1/NodeConfig)). # The desired network tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"tags": [ # List of network tags.
"A String",
],
},
"desiredNodePoolAutoConfigResourceManagerTags": { # A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags-firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. # The desired resource manager tags that apply to all auto-provisioned node pools in autopilot clusters and node auto-provisioning enabled clusters.
"tags": { # Tags 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}`
"a_key": "A String",
},
},
"desiredNodePoolAutoscaling": { # NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. # Autoscaler configuration for the node pool specified in desired_node_pool_id. If there is only one pool in the cluster and desired_node_pool_id is not provided then the change applies to that single node pool.
"autoprovisioned": True or False, # Can this node pool be deleted automatically.
"enabled": True or False, # Is autoscaling enabled for this node pool.
"locationPolicy": "A String", # Location policy used when scaling up a nodepool.
"maxNodeCount": 42, # 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.
"minNodeCount": 42, # 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.
"totalMaxNodeCount": 42, # 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.
"totalMinNodeCount": 42, # 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.
},
"desiredNodePoolId": "A String", # The node pool to be upgraded. This field is mandatory if "desired_node_version", "desired_image_family", "desired_node_pool_autoscaling", or "desired_workload_metadata_config" is specified and there is more than one node pool on the cluster.
"desiredNodePoolLoggingConfig": { # NodePoolLoggingConfig specifies logging configuration for nodepools. # The desired node pool logging configuration defaults for the cluster.
"variantConfig": { # LoggingVariantConfig specifies the behaviour of the logging component. # Logging variant configuration.
"variant": "A String", # Logging variant deployed on nodes.
},
},
"desiredNodeVersion": "A String", # The Kubernetes version to change the nodes to (typically an upgrade). 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 Kubernetes master version
"desiredNotificationConfig": { # NotificationConfig is the configuration of notifications. # The desired notification configuration.
"pubsub": { # Pub/Sub specific notification config. # Notification config for Pub/Sub.
"enabled": True or False, # Enable notifications for Pub/Sub.
"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 # 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
"eventType": [ # Event types to allowlist.
"A String",
],
},
"topic": "A String", # The desired Pub/Sub topic to which notifications will be sent by GKE. Format is `projects/{project}/topics/{topic}`.
},
},
"desiredParentProductConfig": { # 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. # The desired parent product config for the cluster.
"labels": { # Labels contain the configuration of the parent product.
"a_key": "A String",
},
"productName": "A String", # Name of the parent product associated with the cluster.
},
"desiredPodAutoscaling": { # PodAutoscaling is used for configuration of parameters for workload autoscaling. # The desired config for pod autoscaling.
"hpaProfile": "A String", # Selected Horizontal Pod Autoscaling profile.
},
"desiredPodSecurityPolicyConfig": { # Configuration for the PodSecurityPolicy feature. # The desired configuration options for the PodSecurityPolicy feature.
"enabled": True or False, # Enable the PodSecurityPolicy controller for this cluster. If enabled, pods must be valid under a PodSecurityPolicy to be created.
},
"desiredPrivateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration. master_global_access_config is the only field that can be changed via this field. See also ClusterUpdate.desired_enable_private_endpoint for modifying other fields within PrivateClusterConfig. Deprecated: Use desired_control_plane_endpoints_config.ip_endpoints_config.global_access instead.
"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. 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.
"enablePrivateNodes": True or False, # 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.
"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access instead.
"enabled": True or False, # Whenever master is accessible globally or not.
},
"masterIpv4CidrBlock": "A 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.
"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint instead.
"privateEndpointSubnetwork": "A String", # 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint instead.
},
"desiredPrivateIpv6GoogleAccess": "A String", # The desired state of IPv6 connectivity to Google Services.
"desiredProtectConfig": { # ProtectConfig defines the flags needed to enable/disable features for the Protect API. # Deprecated: Use DesiredSecurityPostureConfig instead. Enable/Disable Protect API features for the cluster.
"workloadConfig": { # WorkloadConfig defines the flags to enable or disable the workload configurations for the cluster. # WorkloadConfig defines which actions are enabled for a cluster's workload configurations.
"auditMode": "A String", # Sets which mode of auditing should be used for the cluster's workloads.
},
"workloadVulnerabilityMode": "A String", # Sets which mode to use for Protect workload vulnerability scanning feature.
},
"desiredRbacBindingConfig": { # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created. # RBACBindingConfig allows user to restrict ClusterRoleBindings an RoleBindings that can be created.
"enableInsecureBindingSystemAuthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjects system:authenticated.
"enableInsecureBindingSystemUnauthenticated": True or False, # Setting this to true will allow any ClusterRoleBinding and RoleBinding with subjets system:anonymous or system:unauthenticated.
},
"desiredReleaseChannel": { # 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. # The desired release channel configuration.
"channel": "A String", # channel specifies which release channel the cluster is subscribed to.
},
"desiredResourceUsageExportConfig": { # Configuration for exporting cluster resource usages. # The desired configuration for exporting resource usage.
"bigqueryDestination": { # Parameters for using BigQuery as the destination of resource usage export. # Configuration to use BigQuery as usage export destination.
"datasetId": "A String", # The ID of a BigQuery Dataset.
},
"consumptionMeteringConfig": { # Parameters for controlling consumption metering. # Configuration to enable resource consumption metering.
"enabled": True or False, # Whether to enable consumption metering for this cluster. If enabled, a second BigQuery table will be created to hold resource consumption records.
},
"enableNetworkEgressMetering": True or False, # Whether to enable network egress metering for this cluster. If enabled, a daemonset will be created in the cluster to meter network egress traffic.
},
"desiredSecretManagerConfig": { # SecretManagerConfig is config for secret manager enablement. # Enable/Disable Secret Manager Config.
"enabled": True or False, # Enable/Disable Secret Manager Config.
},
"desiredSecurityPostureConfig": { # SecurityPostureConfig defines the flags needed to enable/disable features for the Security Posture API. # Enable/Disable Security Posture API features for the cluster.
"mode": "A String", # Sets which mode to use for Security Posture features.
"vulnerabilityMode": "A String", # Sets which mode to use for vulnerability scanning.
},
"desiredServiceExternalIpsConfig": { # Config to block services with externalIPs field. # ServiceExternalIPsConfig specifies the config for the use of Services with ExternalIPs field.
"enabled": True or False, # Whether Services with ExternalIPs field are allowed or not.
},
"desiredShieldedNodes": { # Configuration of Shielded Nodes feature. # Configuration for Shielded Nodes.
"enabled": True or False, # Whether Shielded Nodes features are enabled on all nodes in this cluster.
},
"desiredStackType": "A String", # The desired stack type of the cluster. If a stack type is provided and does not match the current stack type of the cluster, update will attempt to change the stack type to the new type.
"desiredTpuConfig": { # Configuration for Cloud TPU. # The desired Cloud TPU configuration.
"enabled": True or False, # Whether Cloud TPU integration is enabled or not.
"ipv4CidrBlock": "A String", # IPv4 CIDR block reserved for Cloud TPU in the VPC.
"useServiceNetworking": True or False, # Whether to use service networking for Cloud TPU or not.
},
"desiredVerticalPodAutoscaling": { # VerticalPodAutoscaling contains global, per-cluster information required by Vertical Pod Autoscaler to automatically adjust the resources of pods controlled by it. # Cluster-level Vertical Pod Autoscaling configuration.
"enabled": True or False, # Enables vertical pod autoscaling.
},
"desiredWorkloadAltsConfig": { # Configuration for direct-path (via ALTS) with workload identity. # Configuration for direct-path (via ALTS) with workload identity.
"enableAlts": True or False, # enable_alts controls whether the alts handshaker should be enabled or not for direct-path. Requires Workload Identity (workload_pool must be non-empty).
},
"desiredWorkloadCertificates": { # Configuration for issuance of mTLS keys and certificates to Kubernetes pods. # Configuration for issuance of mTLS keys and certificates to Kubernetes pods.
"enableCertificates": True or False, # 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).
},
"desiredWorkloadIdentityConfig": { # Configuration for the use of Kubernetes Service Accounts in GCP IAM policies. # Configuration for Workload Identity.
"identityNamespace": "A String", # IAM Identity Namespace to attach all Kubernetes Service Accounts to.
"identityProvider": "A String", # identity provider is the third party identity provider.
"workloadPool": "A String", # The workload pool to attach all Kubernetes service accounts to.
},
"enableK8sBetaApis": { # Kubernetes open source beta apis enabled on the cluster. # Kubernetes open source beta apis enabled on the cluster. Only beta apis
"enabledApis": [ # api name, e.g. storage.k8s.io/v1beta1/csistoragecapacities.
"A String",
],
},
"etag": "A String", # The current etag of the cluster. If an etag is provided and does not match the current etag of the cluster, update will be blocked and an ABORTED error will be returned.
"privateClusterConfig": { # Configuration options for private clusters. # The desired private cluster configuration. Has no effect. Use desired_private_cluster_config instead.
"enablePrivateEndpoint": True or False, # Whether the master's internal IP address is used as the cluster endpoint. 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.
"enablePrivateNodes": True or False, # 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.
"masterGlobalAccessConfig": { # Configuration for controlling master global access settings. # Controls master global access settings. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.enable_global_access instead.
"enabled": True or False, # Whenever master is accessible globally or not.
},
"masterIpv4CidrBlock": "A 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.
"peeringName": "A String", # Output only. The peering name in the customer VPC used by this cluster.
"privateEndpoint": "A String", # Output only. The internal IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.private_endpoint instead.
"privateEndpointSubnetwork": "A String", # 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.
"publicEndpoint": "A String", # Output only. The external IP address of this cluster's master endpoint. Deprecated: Use ControlPlaneEndpointsConfig.IPEndpointsConfig.public_endpoint instead.
},
"removedAdditionalPodRangesConfig": { # AdditionalPodRangesConfig is the configuration for additional pod secondary ranges supporting the ClusterUpdate message. # The additional pod ranges that are to be removed from the cluster. The pod ranges specified here must have been specified earlier in the 'additional_pod_ranges_config' argument.
"podRangeInfo": [ # Output only. Information for additional pod range.
{ # RangeInfo contains the range name and the range utilization by this cluster.
"rangeName": "A String", # Output only. Name of a range.
"utilization": 3.14, # Output only. The utilization of the range.
},
],
"podRangeNames": [ # Name for pod secondary ipv4 range which has the actual range defined ahead.
"A String",
],
},
"userManagedKeysConfig": { # UserManagedKeysConfig holds the resource address to Keys which are used for signing certs and token that are used for communication within cluster. # The Custom keys configuration for the cluster.
"aggregationCa": "A String", # The Certificate Authority Service caPool to use for the aggregation CA in this cluster.
"clusterCa": "A String", # The Certificate Authority Service caPool to use for the cluster CA in this cluster.
"controlPlaneDiskEncryptionKey": "A String", # The Cloud KMS cryptoKey to use for Confidential Hyperdisk on the control plane nodes.
"etcdApiCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd API CA in this cluster.
"etcdPeerCa": "A String", # Resource path of the Certificate Authority Service caPool to use for the etcd peer CA in this cluster.
"gkeopsEtcdBackupEncryptionKey": "A String", # Resource path of the Cloud KMS cryptoKey to use for encryption of internal etcd backups.
"serviceAccountSigningKeys": [ # 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}`
"A String",
],
"serviceAccountVerificationKeys": [ # 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}`
"A String",
],
},
},
"zone": "A String", # Required. Deprecated. The name of the Google Compute Engine [zone](https://cloud.google.com/compute/docs/zones#available) in which the cluster resides. This field has been deprecated and replaced by the name field.
}

x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

Kubernetes Engine API . projects . zones . clusters

Instance Methods

Method Details