Marketplace
BrowsePublish
Marketplace
You are viewing an outdated version of provider-gcp.Go to Latest
upbound/provider-gcp@v0.41.2
Cluster
container.gcp.upbound.io
Cluster
upbound/provider-gcp@v0.41.2container.gcp.upbound.io

Cluster is the Schema for the Clusters API. Creates a Google Kubernetes Engine (GKE) cluster.

Type

CRD

Group

container.gcp.upbound.io

Version

v1beta1

apiVersion: container.gcp.upbound.io/v1beta1

kind: Cluster

API Documentation
apiVersion
string
kind
string
metadata
object
spec
object
object

ClusterSpec defines the desired state of Cluster

forProvider
requiredobject
requiredobject

No description provided.

array

The configuration for addons supported by GKE. Structure is documented below.

array

. Structure is documented below.

array

. The status of the ConfigConnector addon. It is disabled by default; Set enabled = true to enable.

enabled
boolean
array

. The status of the NodeLocal DNSCache addon. It is disabled by default. Set enabled = true to enable.

enabled
boolean
array

. Whether this cluster should enable the Google Compute Engine Persistent Disk Container Storage Interface (CSI) Driver. Defaults to disabled; set enabled = true to enabled.

enabled
boolean
array

The status of the Filestore CSI driver addon, which allows the usage of filestore instance as volumes. It is disabled by default; set enabled = true to enable.

enabled
boolean
array

The status of the GCSFuse CSI driver addon, which allows the usage of a gcs bucket as volumes. It is disabled by default; set enabled = true to enable.

enabled
boolean
array

. The status of the Backup for GKE agent addon. It is disabled by default; Set enabled = true to enable.

enabled
boolean
array

The status of the Horizontal Pod Autoscaling addon, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. It is enabled by default; set disabled = true to disable.

disabled
boolean
array

The status of the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. It is enabled by default; set disabled = true to disable.

disabled
boolean
array

Whether we should enable the network policy addon for the master. This must be enabled in order to enable network policy for the nodes. To enable this, you must also define a network_policy block, otherwise nothing will happen. It can only be disabled if the nodes already do not have network policies enabled. Defaults to disabled; set disabled = false to enable.

disabled
boolean
array

Configuration for the Google Groups for GKE feature. Structure is documented below.

array

Configuration options for the Binary Authorization feature. Structure is documented below.

array

Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. Structure is documented below.

array

Contains defaults for a node pool created by NAP. A subset of fields also apply to GKE Autopilot clusters. Structure is documented below.

diskSize
number
diskType
string
imageType
string
array

NodeManagement configuration for this NodePool. Structure is documented below.

autoRepair
boolean
array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

Shielded Instance options. Structure is documented below.

array

Specifies the upgrade settings for NAP created node pools. Structure is documented below.

array

Settings for blue-green upgrade strategy. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

array

green upgrade. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

maxSurge
number
strategy
string
enabled
boolean
array

Global constraints for machine resources in the cluster. Configuring the cpu and memory types is required if node auto-provisioning is enabled. These limits will apply to node pool autoscaling in addition to node auto-provisioning. Structure is documented below.

maximum
number
minimum
number
array

Configuration for Confidential Nodes feature. Structure is documented below documented below.

enabled
boolean
array

Configuration for the Cost Allocation feature. Structure is documented below.

enabled
boolean
array

Structure is documented below.

keyName
string
state
string
array

GKE SNAT DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster, API doc. Structure is documented below

disabled
boolean
array

Configuration for Using Cloud DNS for GKE. Structure is documented below.

array

Configuration for Kubernetes Beta APIs. Structure is documented below.

array

Enabled Kubernetes Beta APIs. To list a Beta API resource, use the representation {group}/{version}/{resource}. The version must be a Beta version. Note that you cannot disable beta APIs that are already enabled on a cluster without recreating it. See the Configure beta APIs for more information.

enableTpu
boolean
array

Configuration for GKE Gateway API controller. Structure is documented below.

channel
string
array

Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. Structure is documented below.

location
requiredstring
array

Logging configuration for the cluster. Structure is documented below.

array

The GKE components exposing logs. Supported values include: SYSTEM_COMPONENTS, APISERVER, CONTROLLER_MANAGER, SCHEDULER, and WORKLOADS.

array

The maintenance policy to use for the cluster. Structure is documented below.

array

structure documented below.

startTime
string
array

structure documented below

endTime
string
array

MaintenanceExclusionOptions provides maintenance exclusion related options.

scope
string
startTime
string
array

structure documented below

endTime
string
startTime
string
array

The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. Structure is documented below.

array

Whether client certificate authorization is enabled for this cluster. For example:

array

The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). Structure is documented below.

array

External networks that can access the Kubernetes cluster master through HTTPS.

array

Structure is documented below.

array

Monitoring configuration for the cluster. Structure is documented below.

array

The GKE components exposing metrics. Supported values include: SYSTEM_COMPONENTS, APISERVER, CONTROLLER_MANAGER, and SCHEDULER. In beta provider, WORKLOADS is supported on top of those 4 values. (WORKLOADS is deprecated and removed in GKE 1.24.)

array

Configuration for Managed Service for Prometheus. Structure is documented below.

enabled
boolean
network
string
array

Configuration options for the NetworkPolicy feature. Structure is documented below.

enabled
boolean
provider
string
object

Reference to a Network in compute to populate network.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in compute to populate network.

policy
object
object

Policies for selection.

resolve
string
array

Parameters used in creating the default node pool. Structure is documented below.

array

Specifies options for controlling advanced machine features. Structure is documented below.

diskType
string
array

Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. Structure is documented below.

array

Parameters for the Google Container Filesystem (GCFS). If unspecified, GCFS will not be enabled on the node pool. When enabling this feature you must specify image_type = "COS_CONTAINERD" and node_version from GKE versions 1.19 or later to use it. For GKE versions 1.19, 1.20, and 1.21, the recommended minimum node_version would be 1.19.15-gke.1300, 1.20.11-gke.1300, and 1.21.5-gke.1300 respectively. A machine_type that has more than 16 GiB of memory is also recommended. GCFS must be enabled in order to use image streaming. Structure is documented below.

enabled
boolean
array

List of the type and count of accelerator cards attached to the instance. Structure documented below.12 this field is an Attribute as Block

count
number
array

Configuration for auto installation of GPU driver. Structure is documented below.

array

Configuration for GPU sharing. Structure is documented below.

type
string
gvnic
array
array

Google Virtual NIC (gVNIC) is a virtual network interface. Installing the gVNIC driver allows for more efficient traffic transmission across the Google network infrastructure. gVNIC is an alternative to the virtIO-based ethernet driver. GKE nodes must use a Container-Optimized OS node image. GKE node version 1.15.11-gke.15 or later Structure is documented below.

enabled
boolean
array

The maintenance policy to use for the cluster. Structure is documented below.

imageType
string
array

Kubelet configuration, currently supported attributes can be found here. Structure is documented below.

labels
object
array

Linux node configuration, currently supported attributes can be found here. Note that validations happen all server side. All attributes are optional. Structure is documented below.

sysctls
object
array

Parameters for the local NVMe SSDs. Structure is documented below.

metadata
object
nodeGroup
string
array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

The configuration of the desired reservation which instances could take capacity from. Structure is documented below.

key
string
values
array
array

name"

object

Reference to a ServiceAccount in cloudplatform to populate serviceAccount.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a ServiceAccount in cloudplatform to populate serviceAccount.

policy
object
object

Policies for selection.

resolve
string
array

Shielded Instance options. Structure is documented below.

array

Allows specifying multiple node affinities useful for running workloads on sole tenant nodes. node_affinity structure is documented below.

array

No description provided.

key
string
operator
string
values
array
array

name"

spot
boolean
tags
array
array

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls.

taint
array
array

A list of Kubernetes taints to apply to nodes. GKE's API can only set this field on cluster creation. However, GKE will add taints to your nodes if you enable certain features such as GPUs. Taint values can be updated safely in Kubernetes (eg. through kubectl), and it's recommended that you do not use this field to manage taints. If you do, lifecycle.ignore_changes is recommended. Structure is documented below.

effect
string
key
string
value
string
array

Metadata configuration to expose to workloads on the node pool. Structure is documented below.

mode
string
array

The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone.

array

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. Structure is documented below.

array

Subset of NodeConfig message that has defaults.

array

Configuration for the cluster upgrade notifications feature. Structure is documented below.

pubsub
array
array

The pubsub config for the cluster's upgrade notifications.

enabled
boolean
filter
array
array

Choose what type of notifications you want to receive. If no filters are applied, you'll receive all notification types. Structure is documented below.

array

Can be used to filter what notifications are sent. Accepted values are UPGRADE_AVAILABLE_EVENT, UPGRADE_EVENT and SECURITY_BULLETIN_EVENT. See Filtering notifications for more details.

topic
string
array

Configuration for private clusters, clusters with private nodes. Structure is documented below.

array

Controls cluster master global access settings. Structure is documented below.

enabled
boolean
project
string
array

Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. When updating this field, GKE imposes specific version requirements. See Selecting a new release channel for more details; the google_container_engine_versions datasource can provide the default version for a channel. Instead, use the "UNSPECIFIED" channel. Structure is documented below.

channel
string
array

Configuration for the ResourceUsageExportConfig feature. Structure is documented below.

array

Parameters for using BigQuery as the destination of resource usage export.

datasetId
string
array

Enable/Disable Security Posture API features for the cluster. Structure is documented below.

array

Structure is documented below.

enabled
boolean
object

Reference to a Subnetwork in compute to populate subnetwork.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Subnetwork in compute to populate subnetwork.

policy
object
object

Policies for selection.

resolve
string
array

Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. Structure is documented below.

enabled
boolean
array

Workload Identity allows Kubernetes service accounts to act as a user-managed Google IAM Service Account. Structure is documented below.

object

THIS IS A BETA FIELD. It will be honored unless the Management Policies feature flag is disabled. InitProvider holds the same fields as ForProvider, with the exception of Identifier and other resource reference fields. The fields that are in InitProvider are merged into ForProvider when the resource is created. The same fields are also added to the terraform ignore_changes hook, to avoid updating them after creation. This is useful for fields that are required on creation, but we do not desire to update them after creation, for example because of an external controller is managing them, like an autoscaler.

array

The configuration for addons supported by GKE. Structure is documented below.

array

. Structure is documented below.

array

. The status of the ConfigConnector addon. It is disabled by default; Set enabled = true to enable.

enabled
boolean
array

. The status of the NodeLocal DNSCache addon. It is disabled by default. Set enabled = true to enable.

enabled
boolean
array

. Whether this cluster should enable the Google Compute Engine Persistent Disk Container Storage Interface (CSI) Driver. Defaults to disabled; set enabled = true to enabled.

enabled
boolean
array

The status of the Filestore CSI driver addon, which allows the usage of filestore instance as volumes. It is disabled by default; set enabled = true to enable.

enabled
boolean
array

The status of the GCSFuse CSI driver addon, which allows the usage of a gcs bucket as volumes. It is disabled by default; set enabled = true to enable.

enabled
boolean
array

. The status of the Backup for GKE agent addon. It is disabled by default; Set enabled = true to enable.

enabled
boolean
array

The status of the Horizontal Pod Autoscaling addon, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. It is enabled by default; set disabled = true to disable.

disabled
boolean
array

The status of the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. It is enabled by default; set disabled = true to disable.

disabled
boolean
array

Whether we should enable the network policy addon for the master. This must be enabled in order to enable network policy for the nodes. To enable this, you must also define a network_policy block, otherwise nothing will happen. It can only be disabled if the nodes already do not have network policies enabled. Defaults to disabled; set disabled = false to enable.

disabled
boolean
array

Configuration for the Google Groups for GKE feature. Structure is documented below.

array

Configuration options for the Binary Authorization feature. Structure is documented below.

array

Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. Structure is documented below.

array

Contains defaults for a node pool created by NAP. A subset of fields also apply to GKE Autopilot clusters. Structure is documented below.

diskSize
number
diskType
string
imageType
string
array

NodeManagement configuration for this NodePool. Structure is documented below.

autoRepair
boolean
array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

Shielded Instance options. Structure is documented below.

array

Specifies the upgrade settings for NAP created node pools. Structure is documented below.

array

Settings for blue-green upgrade strategy. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

array

green upgrade. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

maxSurge
number
strategy
string
enabled
boolean
array

Global constraints for machine resources in the cluster. Configuring the cpu and memory types is required if node auto-provisioning is enabled. These limits will apply to node pool autoscaling in addition to node auto-provisioning. Structure is documented below.

maximum
number
minimum
number
array

Configuration for Confidential Nodes feature. Structure is documented below documented below.

enabled
boolean
array

Configuration for the Cost Allocation feature. Structure is documented below.

enabled
boolean
array

Structure is documented below.

keyName
string
state
string
array

GKE SNAT DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster, API doc. Structure is documented below

disabled
boolean
array

Configuration for Using Cloud DNS for GKE. Structure is documented below.

array

Configuration for Kubernetes Beta APIs. Structure is documented below.

array

Enabled Kubernetes Beta APIs. To list a Beta API resource, use the representation {group}/{version}/{resource}. The version must be a Beta version. Note that you cannot disable beta APIs that are already enabled on a cluster without recreating it. See the Configure beta APIs for more information.

enableTpu
boolean
array

Configuration for GKE Gateway API controller. Structure is documented below.

channel
string
array

Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. Structure is documented below.

array

Logging configuration for the cluster. Structure is documented below.

array

The GKE components exposing logs. Supported values include: SYSTEM_COMPONENTS, APISERVER, CONTROLLER_MANAGER, SCHEDULER, and WORKLOADS.

array

The maintenance policy to use for the cluster. Structure is documented below.

array

structure documented below.

startTime
string
array

structure documented below

endTime
string
array

MaintenanceExclusionOptions provides maintenance exclusion related options.

scope
string
startTime
string
array

structure documented below

endTime
string
startTime
string
array

The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. Structure is documented below.

array

Whether client certificate authorization is enabled for this cluster. For example:

array

The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). Structure is documented below.

array

External networks that can access the Kubernetes cluster master through HTTPS.

array

Structure is documented below.

array

Monitoring configuration for the cluster. Structure is documented below.

array

The GKE components exposing metrics. Supported values include: SYSTEM_COMPONENTS, APISERVER, CONTROLLER_MANAGER, and SCHEDULER. In beta provider, WORKLOADS is supported on top of those 4 values. (WORKLOADS is deprecated and removed in GKE 1.24.)

array

Configuration for Managed Service for Prometheus. Structure is documented below.

enabled
boolean
network
string
array

Configuration options for the NetworkPolicy feature. Structure is documented below.

enabled
boolean
provider
string
object

Reference to a Network in compute to populate network.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Network in compute to populate network.

policy
object
object

Policies for selection.

resolve
string
array

Parameters used in creating the default node pool. Structure is documented below.

array

Specifies options for controlling advanced machine features. Structure is documented below.

diskType
string
array

Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. Structure is documented below.

array

Parameters for the Google Container Filesystem (GCFS). If unspecified, GCFS will not be enabled on the node pool. When enabling this feature you must specify image_type = "COS_CONTAINERD" and node_version from GKE versions 1.19 or later to use it. For GKE versions 1.19, 1.20, and 1.21, the recommended minimum node_version would be 1.19.15-gke.1300, 1.20.11-gke.1300, and 1.21.5-gke.1300 respectively. A machine_type that has more than 16 GiB of memory is also recommended. GCFS must be enabled in order to use image streaming. Structure is documented below.

enabled
boolean
array

List of the type and count of accelerator cards attached to the instance. Structure documented below.12 this field is an Attribute as Block

count
number
array

Configuration for auto installation of GPU driver. Structure is documented below.

array

Configuration for GPU sharing. Structure is documented below.

type
string
gvnic
array
array

Google Virtual NIC (gVNIC) is a virtual network interface. Installing the gVNIC driver allows for more efficient traffic transmission across the Google network infrastructure. gVNIC is an alternative to the virtIO-based ethernet driver. GKE nodes must use a Container-Optimized OS node image. GKE node version 1.15.11-gke.15 or later Structure is documented below.

enabled
boolean
array

The maintenance policy to use for the cluster. Structure is documented below.

imageType
string
array

Kubelet configuration, currently supported attributes can be found here. Structure is documented below.

labels
object
array

Linux node configuration, currently supported attributes can be found here. Note that validations happen all server side. All attributes are optional. Structure is documented below.

sysctls
object
array

Parameters for the local NVMe SSDs. Structure is documented below.

metadata
object
nodeGroup
string
array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

The configuration of the desired reservation which instances could take capacity from. Structure is documented below.

key
string
values
array
array

name"

object

Reference to a ServiceAccount in cloudplatform to populate serviceAccount.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a ServiceAccount in cloudplatform to populate serviceAccount.

policy
object
object

Policies for selection.

resolve
string
array

Shielded Instance options. Structure is documented below.

array

Allows specifying multiple node affinities useful for running workloads on sole tenant nodes. node_affinity structure is documented below.

array

No description provided.

key
string
operator
string
values
array
array

name"

spot
boolean
tags
array
array

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls.

taint
array
array

A list of Kubernetes taints to apply to nodes. GKE's API can only set this field on cluster creation. However, GKE will add taints to your nodes if you enable certain features such as GPUs. Taint values can be updated safely in Kubernetes (eg. through kubectl), and it's recommended that you do not use this field to manage taints. If you do, lifecycle.ignore_changes is recommended. Structure is documented below.

effect
string
key
string
value
string
array

Metadata configuration to expose to workloads on the node pool. Structure is documented below.

mode
string
array

The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone.

array

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. Structure is documented below.

array

Subset of NodeConfig message that has defaults.

array

Configuration for the cluster upgrade notifications feature. Structure is documented below.

pubsub
array
array

The pubsub config for the cluster's upgrade notifications.

enabled
boolean
filter
array
array

Choose what type of notifications you want to receive. If no filters are applied, you'll receive all notification types. Structure is documented below.

array

Can be used to filter what notifications are sent. Accepted values are UPGRADE_AVAILABLE_EVENT, UPGRADE_EVENT and SECURITY_BULLETIN_EVENT. See Filtering notifications for more details.

topic
string
array

Configuration for private clusters, clusters with private nodes. Structure is documented below.

array

Controls cluster master global access settings. Structure is documented below.

enabled
boolean
project
string
array

Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. When updating this field, GKE imposes specific version requirements. See Selecting a new release channel for more details; the google_container_engine_versions datasource can provide the default version for a channel. Instead, use the "UNSPECIFIED" channel. Structure is documented below.

channel
string
array

Configuration for the ResourceUsageExportConfig feature. Structure is documented below.

array

Parameters for using BigQuery as the destination of resource usage export.

datasetId
string
array

Enable/Disable Security Posture API features for the cluster. Structure is documented below.

array

Structure is documented below.

enabled
boolean
object

Reference to a Subnetwork in compute to populate subnetwork.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

Selector for a Subnetwork in compute to populate subnetwork.

policy
object
object

Policies for selection.

resolve
string
array

Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. Structure is documented below.

enabled
boolean
array

Workload Identity allows Kubernetes service accounts to act as a user-managed Google IAM Service Account. Structure is documented below.

array

THIS IS A BETA FIELD. It is on by default but can be opted out through a Crossplane feature flag. ManagementPolicies specify the array of actions Crossplane is allowed to take on the managed and external resources. This field is planned to replace the DeletionPolicy field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. If both are custom, the DeletionPolicy field will be ignored. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223 and this one: https://github.com/crossplane/crossplane/blob/444267e84783136daa93568b364a5f01228cacbe/design/one-pager-ignore-changes.md

object

ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
object

PublishConnectionDetailsTo specifies the connection secret config which contains a name, metadata and a reference to secret store config to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource.

configRef
object
object

SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret.

name
requiredstring
policy
object
object

Policies for referencing.

resolve
string
metadata
object
object

Metadata is the metadata for connection secret.

labels
object
type
string
name
requiredstring
object

WriteConnectionSecretToReference specifies the namespace and name of a Secret to which any connection details for this managed resource should be written. Connection details frequently include the endpoint, username, and password required to connect to the managed resource. This field is planned to be replaced in a future release in favor of PublishConnectionDetailsTo. Currently, both could be set independently and connection details would be published to both without affecting each other.

name
requiredstring
namespace
requiredstring
status
object
object

ClusterStatus defines the observed state of Cluster.

object

No description provided.

array

The configuration for addons supported by GKE. Structure is documented below.

array

. Structure is documented below.

array

. The status of the ConfigConnector addon. It is disabled by default; Set enabled = true to enable.

enabled
boolean
array

. The status of the NodeLocal DNSCache addon. It is disabled by default. Set enabled = true to enable.

enabled
boolean
array

. Whether this cluster should enable the Google Compute Engine Persistent Disk Container Storage Interface (CSI) Driver. Defaults to disabled; set enabled = true to enabled.

enabled
boolean
array

The status of the Filestore CSI driver addon, which allows the usage of filestore instance as volumes. It is disabled by default; set enabled = true to enable.

enabled
boolean
array

The status of the GCSFuse CSI driver addon, which allows the usage of a gcs bucket as volumes. It is disabled by default; set enabled = true to enable.

enabled
boolean
array

. The status of the Backup for GKE agent addon. It is disabled by default; Set enabled = true to enable.

enabled
boolean
array

The status of the Horizontal Pod Autoscaling addon, which increases or decreases the number of replica pods a replication controller has based on the resource usage of the existing pods. It is enabled by default; set disabled = true to disable.

disabled
boolean
array

The status of the HTTP (L7) load balancing controller addon, which makes it easy to set up HTTP load balancers for services in a cluster. It is enabled by default; set disabled = true to disable.

disabled
boolean
array

Whether we should enable the network policy addon for the master. This must be enabled in order to enable network policy for the nodes. To enable this, you must also define a network_policy block, otherwise nothing will happen. It can only be disabled if the nodes already do not have network policies enabled. Defaults to disabled; set disabled = false to enable.

disabled
boolean
array

Configuration for the Google Groups for GKE feature. Structure is documented below.

array

Configuration options for the Binary Authorization feature. Structure is documented below.

array

Per-cluster configuration of Node Auto-Provisioning with Cluster Autoscaler to automatically adjust the size of the cluster and create/delete node pools based on the current needs of the cluster's workload. See the guide to using Node Auto-Provisioning for more details. Structure is documented below.

array

Contains defaults for a node pool created by NAP. A subset of fields also apply to GKE Autopilot clusters. Structure is documented below.

diskSize
number
diskType
string
imageType
string
array

NodeManagement configuration for this NodePool. Structure is documented below.

autoRepair
boolean
array

Specifies the Auto Upgrade knobs for the node pool.

array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

Shielded Instance options. Structure is documented below.

array

Specifies the upgrade settings for NAP created node pools. Structure is documented below.

array

Settings for blue-green upgrade strategy. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

array

green upgrade. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

maxSurge
number
strategy
string
enabled
boolean
array

Global constraints for machine resources in the cluster. Configuring the cpu and memory types is required if node auto-provisioning is enabled. These limits will apply to node pool autoscaling in addition to node auto-provisioning. Structure is documented below.

maximum
number
minimum
number
array

Configuration for Confidential Nodes feature. Structure is documented below documented below.

enabled
boolean
array

Configuration for the Cost Allocation feature. Structure is documented below.

enabled
boolean
array

Structure is documented below.

keyName
string
state
string
array

GKE SNAT DefaultSnatStatus contains the desired state of whether default sNAT should be disabled on the cluster, API doc. Structure is documented below

disabled
boolean
array

Configuration for Using Cloud DNS for GKE. Structure is documented below.

array

Configuration for Kubernetes Beta APIs. Structure is documented below.

array

Enabled Kubernetes Beta APIs. To list a Beta API resource, use the representation {group}/{version}/{resource}. The version must be a Beta version. Note that you cannot disable beta APIs that are already enabled on a cluster without recreating it. See the Configure beta APIs for more information.

enableTpu
boolean
endpoint
string
array

Configuration for GKE Gateway API controller. Structure is documented below.

channel
string
id
string
array

Configuration of cluster IP allocation for VPC-native clusters. Adding this block enables IP aliasing, making the cluster VPC-native instead of routes-based. Structure is documented below.

location
string
array

Logging configuration for the cluster. Structure is documented below.

array

The GKE components exposing logs. Supported values include: SYSTEM_COMPONENTS, APISERVER, CONTROLLER_MANAGER, SCHEDULER, and WORKLOADS.

array

The maintenance policy to use for the cluster. Structure is documented below.

array

structure documented below.

duration
string
startTime
string
array

structure documented below

endTime
string
array

MaintenanceExclusionOptions provides maintenance exclusion related options.

scope
string
startTime
string
array

structure documented below

endTime
string
startTime
string
array

The authentication information for accessing the Kubernetes master. Some values in this block are only returned by the API if your service account has permission to get credentials for your GKE cluster. If you see an unexpected diff unsetting your client cert, ensure you have the container.clusters.getCredentials permission. Structure is documented below.

array

Whether client certificate authorization is enabled for this cluster. For example:

array

The desired configuration options for master authorized networks. Omit the nested cidr_blocks attribute to disallow external access (except the cluster node IPs, which GKE automatically whitelists). Structure is documented below.

array

External networks that can access the Kubernetes cluster master through HTTPS.

array

Structure is documented below.

array

Monitoring configuration for the cluster. Structure is documented below.

array

The GKE components exposing metrics. Supported values include: SYSTEM_COMPONENTS, APISERVER, CONTROLLER_MANAGER, and SCHEDULER. In beta provider, WORKLOADS is supported on top of those 4 values. (WORKLOADS is deprecated and removed in GKE 1.24.)

array

Configuration for Managed Service for Prometheus. Structure is documented below.

enabled
boolean
network
string
array

Configuration options for the NetworkPolicy feature. Structure is documented below.

enabled
boolean
provider
string
array

Parameters used in creating the default node pool. Structure is documented below.

array

Specifies options for controlling advanced machine features. Structure is documented below.

diskType
string
array

Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. Structure is documented below.

array

Parameters for the Google Container Filesystem (GCFS). If unspecified, GCFS will not be enabled on the node pool. When enabling this feature you must specify image_type = "COS_CONTAINERD" and node_version from GKE versions 1.19 or later to use it. For GKE versions 1.19, 1.20, and 1.21, the recommended minimum node_version would be 1.19.15-gke.1300, 1.20.11-gke.1300, and 1.21.5-gke.1300 respectively. A machine_type that has more than 16 GiB of memory is also recommended. GCFS must be enabled in order to use image streaming. Structure is documented below.

enabled
boolean
array

List of the type and count of accelerator cards attached to the instance. Structure documented below.12 this field is an Attribute as Block

count
number
array

Configuration for auto installation of GPU driver. Structure is documented below.

array

Configuration for GPU sharing. Structure is documented below.

type
string
gvnic
array
array

Google Virtual NIC (gVNIC) is a virtual network interface. Installing the gVNIC driver allows for more efficient traffic transmission across the Google network infrastructure. gVNIC is an alternative to the virtIO-based ethernet driver. GKE nodes must use a Container-Optimized OS node image. GKE node version 1.15.11-gke.15 or later Structure is documented below.

enabled
boolean
array

The maintenance policy to use for the cluster. Structure is documented below.

imageType
string
array

Kubelet configuration, currently supported attributes can be found here. Structure is documented below.

labels
object
array

Linux node configuration, currently supported attributes can be found here. Note that validations happen all server side. All attributes are optional. Structure is documented below.

sysctls
object
array

Parameters for the local NVMe SSDs. Structure is documented below.

metadata
object
nodeGroup
string
array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

The configuration of the desired reservation which instances could take capacity from. Structure is documented below.

key
string
values
array
array

name"

array

Shielded Instance options. Structure is documented below.

array

Allows specifying multiple node affinities useful for running workloads on sole tenant nodes. node_affinity structure is documented below.

array

No description provided.

key
string
operator
string
values
array
array

name"

spot
boolean
tags
array
array

The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls.

taint
array
array

A list of Kubernetes taints to apply to nodes. GKE's API can only set this field on cluster creation. However, GKE will add taints to your nodes if you enable certain features such as GPUs. Taint values can be updated safely in Kubernetes (eg. through kubectl), and it's recommended that you do not use this field to manage taints. If you do, lifecycle.ignore_changes is recommended. Structure is documented below.

effect
string
key
string
value
string
array

Metadata configuration to expose to workloads on the node pool. Structure is documented below.

mode
string
array

The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone.

array

List of node pools associated with this cluster. See google_container_node_pool for schema. Warning: node pools defined inside a cluster can't be changed (or added/removed) after cluster creation without deleting and recreating the entire cluster. Unless you absolutely need the ability to say "these are the only node pools associated with this cluster", use the google_container_node_pool resource instead of this property.

array

No description provided.

array

No description provided.

array

No description provided.

array

NodeManagement configuration for this NodePool. Structure is documented below.

autoRepair
boolean
name
string
array

No description provided.

array

No description provided.

disabled
boolean
podRange
string
array

Parameters used in creating the default node pool. Structure is documented below.

array

Specifies options for controlling advanced machine features. Structure is documented below.

diskType
string
array

Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk. Structure is documented below.

array

The default Google Container Filesystem (GCFS) configuration at the cluster level. e.g. enable image streaming across all the node pools within the cluster. Structure is documented below.

enabled
boolean
array

List of the type and count of accelerator cards attached to the instance. Structure documented below.12 this field is an Attribute as Block

count
number
array

Configuration for auto installation of GPU driver. Structure is documented below.

array

Configuration for GPU sharing. Structure is documented below.

type
string
gvnic
array
array

Google Virtual NIC (gVNIC) is a virtual network interface. Installing the gVNIC driver allows for more efficient traffic transmission across the Google network infrastructure. gVNIC is an alternative to the virtIO-based ethernet driver. GKE nodes must use a Container-Optimized OS node image. GKE node version 1.15.11-gke.15 or later Structure is documented below.

enabled
boolean
array

The maintenance policy to use for the cluster. Structure is documented below.

imageType
string
array

Kubelet configuration, currently supported attributes can be found here. Structure is documented below.

labels
object
array

Linux node configuration, currently supported attributes can be found here. Note that validations happen all server side. All attributes are optional. Structure is documented below.

sysctls
object
array

Parameters for the local NVMe SSDs. Structure is documented below.

metadata
object
nodeGroup
string
array

The set of Google API scopes to be made available on all of the node VMs under the "default" service account. Use the "https://www.googleapis.com/auth/cloud-platform" scope to grant access to all APIs. It is recommended that you set service_account to a non-default service account and grant IAM roles to that service account for only the resources that it needs.

array

The configuration of the desired reservation which instances could take capacity from. Structure is documented below.

key
string
values
array
array

name"

array

Shielded Instance options. Structure is documented below.

array

Allows specifying multiple node affinities useful for running workloads on sole tenant nodes. node_affinity structure is documented below.

array

No description provided.

key
string
operator
string
values
array
array

name"

spot
boolean
tags
array
array

List of network tags applied to auto-provisioned node pools.

taint
array
array

A list of Kubernetes taints to apply to nodes. GKE's API can only set this field on cluster creation. However, GKE will add taints to your nodes if you enable certain features such as GPUs. Taint values can be updated safely in Kubernetes (eg. through kubectl), and it's recommended that you do not use this field to manage taints. If you do, lifecycle.ignore_changes is recommended. Structure is documented below.

effect
string
key
string
value
string
array

Metadata configuration to expose to workloads on the node pool. Structure is documented below.

mode
string
nodeCount
number
array

The list of zones in which the cluster's nodes are located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If this is specified for a zonal cluster, omit the cluster's zone.

array

No description provided.

type
string
array

Specifies the upgrade settings for NAP created node pools. Structure is documented below.

array

Settings for blue-green upgrade strategy. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

array

green upgrade. To be specified when strategy is set to BLUE_GREEN. Structure is documented below.

maxSurge
number
strategy
string
version
string
array

Default NodePool settings for the entire cluster. These settings are overridden if specified on the specific NodePool object. Structure is documented below.

array

Subset of NodeConfig message that has defaults.

array

Configuration for the cluster upgrade notifications feature. Structure is documented below.

pubsub
array
array

The pubsub config for the cluster's upgrade notifications.

enabled
boolean
filter
array
array

Choose what type of notifications you want to receive. If no filters are applied, you'll receive all notification types. Structure is documented below.

array

Can be used to filter what notifications are sent. Accepted values are UPGRADE_AVAILABLE_EVENT, UPGRADE_EVENT and SECURITY_BULLETIN_EVENT. See Filtering notifications for more details.

topic
string
operation
string
array

Configuration for private clusters, clusters with private nodes. Structure is documented below.

array

Controls cluster master global access settings. Structure is documented below.

enabled
boolean
project
string
array

Configuration options for the Release channel feature, which provide more control over automatic upgrades of your GKE clusters. When updating this field, GKE imposes specific version requirements. See Selecting a new release channel for more details; the google_container_engine_versions datasource can provide the default version for a channel. Instead, use the "UNSPECIFIED" channel. Structure is documented below.

channel
string
array

Configuration for the ResourceUsageExportConfig feature. Structure is documented below.

array

Parameters for using BigQuery as the destination of resource usage export.

datasetId
string
array

Enable/Disable Security Posture API features for the cluster. Structure is documented below.

selfLink
string
array

Structure is documented below.

enabled
boolean
array

Vertical Pod Autoscaling automatically adjusts the resources of pods controlled by it. Structure is documented below.

enabled
boolean
array

Workload Identity allows Kubernetes service accounts to act as a user-managed Google IAM Service Account. Structure is documented below.

array

Conditions of the resource.

lastTransitionTime
requiredstring
message
string
reason
requiredstring
status
requiredstring
type
requiredstring
Marketplace

Discover the building blocks for your internal cloud platform.

© 2022 Upbound, Inc.

SolutionsProvidersConfigurations
LearnDocumentationTry for Free
MorePrivacy PolicyTerms & Conditions
Marketplace

© 2022 Upbound, Inc.

Marketplace

Discover the building blocksfor your internal cloud platform.