container.v1beta1.nodePool
"NodePool is the Schema for the NodePools API. Manages a GKE NodePool resource."
Index
fn new(name)
obj metadata
fn withAnnotations(annotations)
fn withAnnotationsMixin(annotations)
fn withClusterName(clusterName)
fn withCreationTimestamp(creationTimestamp)
fn withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
fn withDeletionTimestamp(deletionTimestamp)
fn withFinalizers(finalizers)
fn withFinalizersMixin(finalizers)
fn withGenerateName(generateName)
fn withGeneration(generation)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withName(name)
fn withNamespace(namespace)
fn withOwnerReferences(ownerReferences)
fn withOwnerReferencesMixin(ownerReferences)
fn withResourceVersion(resourceVersion)
fn withSelfLink(selfLink)
fn withUid(uid)
obj spec
fn withDeletionPolicy(deletionPolicy)
fn withManagementPolicies(managementPolicies)
fn withManagementPoliciesMixin(managementPolicies)
obj spec.forProvider
fn withAutoscaling(autoscaling)
fn withAutoscalingMixin(autoscaling)
fn withCluster(cluster)
fn withInitialNodeCount(initialNodeCount)
fn withLocation(location)
fn withManagement(management)
fn withManagementMixin(management)
fn withMaxPodsPerNode(maxPodsPerNode)
fn withNetworkConfig(networkConfig)
fn withNetworkConfigMixin(networkConfig)
fn withNodeConfig(nodeConfig)
fn withNodeConfigMixin(nodeConfig)
fn withNodeCount(nodeCount)
fn withNodeLocations(nodeLocations)
fn withNodeLocationsMixin(nodeLocations)
fn withPlacementPolicy(placementPolicy)
fn withPlacementPolicyMixin(placementPolicy)
fn withProject(project)
fn withUpgradeSettings(upgradeSettings)
fn withUpgradeSettingsMixin(upgradeSettings)
fn withVersion(version)
obj spec.forProvider.autoscaling
obj spec.forProvider.clusterRef
obj spec.forProvider.clusterSelector
obj spec.forProvider.management
obj spec.forProvider.networkConfig
fn withCreatePodRange(createPodRange)
fn withEnablePrivateNodes(enablePrivateNodes)
fn withPodCidrOverprovisionConfig(podCidrOverprovisionConfig)
fn withPodCidrOverprovisionConfigMixin(podCidrOverprovisionConfig)
fn withPodIpv4CidrBlock(podIpv4CidrBlock)
fn withPodRange(podRange)
obj spec.forProvider.networkConfig.podCidrOverprovisionConfig
obj spec.forProvider.nodeConfig
fn withAdvancedMachineFeatures(advancedMachineFeatures)
fn withAdvancedMachineFeaturesMixin(advancedMachineFeatures)
fn withBootDiskKmsKey(bootDiskKmsKey)
fn withDiskSizeGb(diskSizeGb)
fn withDiskType(diskType)
fn withEphemeralStorageLocalSsdConfig(ephemeralStorageLocalSsdConfig)
fn withEphemeralStorageLocalSsdConfigMixin(ephemeralStorageLocalSsdConfig)
fn withGcfsConfig(gcfsConfig)
fn withGcfsConfigMixin(gcfsConfig)
fn withGuestAccelerator(guestAccelerator)
fn withGuestAcceleratorMixin(guestAccelerator)
fn withGvnic(gvnic)
fn withGvnicMixin(gvnic)
fn withImageType(imageType)
fn withKubeletConfig(kubeletConfig)
fn withKubeletConfigMixin(kubeletConfig)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withLinuxNodeConfig(linuxNodeConfig)
fn withLinuxNodeConfigMixin(linuxNodeConfig)
fn withLocalNvmeSsdBlockConfig(localNvmeSsdBlockConfig)
fn withLocalNvmeSsdBlockConfigMixin(localNvmeSsdBlockConfig)
fn withLocalSsdCount(localSsdCount)
fn withLoggingVariant(loggingVariant)
fn withMachineType(machineType)
fn withMetadata(metadata)
fn withMetadataMixin(metadata)
fn withMinCpuPlatform(minCpuPlatform)
fn withNodeGroup(nodeGroup)
fn withOauthScopes(oauthScopes)
fn withOauthScopesMixin(oauthScopes)
fn withPreemptible(preemptible)
fn withReservationAffinity(reservationAffinity)
fn withReservationAffinityMixin(reservationAffinity)
fn withResourceLabels(resourceLabels)
fn withResourceLabelsMixin(resourceLabels)
fn withServiceAccount(serviceAccount)
fn withShieldedInstanceConfig(shieldedInstanceConfig)
fn withShieldedInstanceConfigMixin(shieldedInstanceConfig)
fn withSpot(spot)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTaint(taint)
fn withTaintMixin(taint)
fn withWorkloadMetadataConfig(workloadMetadataConfig)
fn withWorkloadMetadataConfigMixin(workloadMetadataConfig)
obj spec.forProvider.nodeConfig.advancedMachineFeatures
obj spec.forProvider.nodeConfig.ephemeralStorageLocalSsdConfig
obj spec.forProvider.nodeConfig.gcfsConfig
obj spec.forProvider.nodeConfig.guestAccelerator
obj spec.forProvider.nodeConfig.gvnic
obj spec.forProvider.nodeConfig.kubeletConfig
obj spec.forProvider.nodeConfig.linuxNodeConfig
obj spec.forProvider.nodeConfig.localNvmeSsdBlockConfig
obj spec.forProvider.nodeConfig.reservationAffinity
obj spec.forProvider.nodeConfig.serviceAccountRef
obj spec.forProvider.nodeConfig.serviceAccountSelector
obj spec.forProvider.nodeConfig.shieldedInstanceConfig
obj spec.forProvider.nodeConfig.taint
obj spec.forProvider.nodeConfig.workloadMetadataConfig
obj spec.forProvider.placementPolicy
obj spec.forProvider.upgradeSettings
fn withBlueGreenSettings(blueGreenSettings)
fn withBlueGreenSettingsMixin(blueGreenSettings)
fn withMaxSurge(maxSurge)
fn withMaxUnavailable(maxUnavailable)
fn withStrategy(strategy)
obj spec.forProvider.upgradeSettings.blueGreenSettings
obj spec.initProvider
fn withAutoscaling(autoscaling)
fn withAutoscalingMixin(autoscaling)
fn withInitialNodeCount(initialNodeCount)
fn withManagement(management)
fn withManagementMixin(management)
fn withMaxPodsPerNode(maxPodsPerNode)
fn withNetworkConfig(networkConfig)
fn withNetworkConfigMixin(networkConfig)
fn withNodeConfig(nodeConfig)
fn withNodeConfigMixin(nodeConfig)
fn withNodeCount(nodeCount)
fn withNodeLocations(nodeLocations)
fn withNodeLocationsMixin(nodeLocations)
fn withPlacementPolicy(placementPolicy)
fn withPlacementPolicyMixin(placementPolicy)
fn withProject(project)
fn withUpgradeSettings(upgradeSettings)
fn withUpgradeSettingsMixin(upgradeSettings)
fn withVersion(version)
obj spec.initProvider.autoscaling
obj spec.initProvider.management
obj spec.initProvider.networkConfig
fn withCreatePodRange(createPodRange)
fn withEnablePrivateNodes(enablePrivateNodes)
fn withPodCidrOverprovisionConfig(podCidrOverprovisionConfig)
fn withPodCidrOverprovisionConfigMixin(podCidrOverprovisionConfig)
fn withPodIpv4CidrBlock(podIpv4CidrBlock)
fn withPodRange(podRange)
obj spec.initProvider.networkConfig.podCidrOverprovisionConfig
obj spec.initProvider.nodeConfig
fn withAdvancedMachineFeatures(advancedMachineFeatures)
fn withAdvancedMachineFeaturesMixin(advancedMachineFeatures)
fn withBootDiskKmsKey(bootDiskKmsKey)
fn withDiskSizeGb(diskSizeGb)
fn withDiskType(diskType)
fn withEphemeralStorageLocalSsdConfig(ephemeralStorageLocalSsdConfig)
fn withEphemeralStorageLocalSsdConfigMixin(ephemeralStorageLocalSsdConfig)
fn withGcfsConfig(gcfsConfig)
fn withGcfsConfigMixin(gcfsConfig)
fn withGuestAccelerator(guestAccelerator)
fn withGuestAcceleratorMixin(guestAccelerator)
fn withGvnic(gvnic)
fn withGvnicMixin(gvnic)
fn withImageType(imageType)
fn withKubeletConfig(kubeletConfig)
fn withKubeletConfigMixin(kubeletConfig)
fn withLabels(labels)
fn withLabelsMixin(labels)
fn withLinuxNodeConfig(linuxNodeConfig)
fn withLinuxNodeConfigMixin(linuxNodeConfig)
fn withLocalNvmeSsdBlockConfig(localNvmeSsdBlockConfig)
fn withLocalNvmeSsdBlockConfigMixin(localNvmeSsdBlockConfig)
fn withLocalSsdCount(localSsdCount)
fn withLoggingVariant(loggingVariant)
fn withMachineType(machineType)
fn withMetadata(metadata)
fn withMetadataMixin(metadata)
fn withMinCpuPlatform(minCpuPlatform)
fn withNodeGroup(nodeGroup)
fn withOauthScopes(oauthScopes)
fn withOauthScopesMixin(oauthScopes)
fn withPreemptible(preemptible)
fn withReservationAffinity(reservationAffinity)
fn withReservationAffinityMixin(reservationAffinity)
fn withResourceLabels(resourceLabels)
fn withResourceLabelsMixin(resourceLabels)
fn withShieldedInstanceConfig(shieldedInstanceConfig)
fn withShieldedInstanceConfigMixin(shieldedInstanceConfig)
fn withSpot(spot)
fn withTags(tags)
fn withTagsMixin(tags)
fn withTaint(taint)
fn withTaintMixin(taint)
fn withWorkloadMetadataConfig(workloadMetadataConfig)
fn withWorkloadMetadataConfigMixin(workloadMetadataConfig)
obj spec.initProvider.nodeConfig.advancedMachineFeatures
obj spec.initProvider.nodeConfig.ephemeralStorageLocalSsdConfig
obj spec.initProvider.nodeConfig.gcfsConfig
obj spec.initProvider.nodeConfig.guestAccelerator
obj spec.initProvider.nodeConfig.gvnic
obj spec.initProvider.nodeConfig.kubeletConfig
obj spec.initProvider.nodeConfig.linuxNodeConfig
obj spec.initProvider.nodeConfig.localNvmeSsdBlockConfig
obj spec.initProvider.nodeConfig.reservationAffinity
obj spec.initProvider.nodeConfig.shieldedInstanceConfig
obj spec.initProvider.nodeConfig.taint
obj spec.initProvider.nodeConfig.workloadMetadataConfig
obj spec.initProvider.placementPolicy
obj spec.initProvider.upgradeSettings
fn withBlueGreenSettings(blueGreenSettings)
fn withBlueGreenSettingsMixin(blueGreenSettings)
fn withMaxSurge(maxSurge)
fn withMaxUnavailable(maxUnavailable)
fn withStrategy(strategy)
obj spec.initProvider.upgradeSettings.blueGreenSettings
obj spec.providerConfigRef
obj spec.providerRef
obj spec.publishConnectionDetailsTo
obj spec.writeConnectionSecretToRef
Fields
fn new
new(name)
new returns an instance of NodePool
obj metadata
"ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create."
fn metadata.withAnnotations
withAnnotations(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
fn metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects. More info: http://kubernetes.io/docs/user-guide/annotations"
Note: This function appends passed data to existing values
fn metadata.withClusterName
withClusterName(clusterName)
"The name of the cluster which the object belongs to. This is used to distinguish resources with same name and namespace in different clusters. This field is not set anywhere right now and apiserver is going to ignore it if set in create or update request."
fn metadata.withCreationTimestamp
withCreationTimestamp(creationTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withDeletionGracePeriodSeconds
withDeletionGracePeriodSeconds(deletionGracePeriodSeconds)
"Number of seconds allowed for this object to gracefully terminate before it will be removed from the system. Only set when deletionTimestamp is also set. May only be shortened. Read-only."
fn metadata.withDeletionTimestamp
withDeletionTimestamp(deletionTimestamp)
"Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers."
fn metadata.withFinalizers
withFinalizers(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
fn metadata.withFinalizersMixin
withFinalizersMixin(finalizers)
"Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed. Finalizers may be processed and removed in any order. Order is NOT enforced because it introduces significant risk of stuck finalizers. finalizers is a shared field, any actor with permission can reorder it. If the finalizer list is processed in order, then this can lead to a situation in which the component responsible for the first finalizer in the list is waiting for a signal (field value, external system, or other) produced by a component responsible for a finalizer later in the list, resulting in a deadlock. Without enforced ordering finalizers are free to order amongst themselves and are not vulnerable to ordering changes in the list."
Note: This function appends passed data to existing values
fn metadata.withGenerateName
withGenerateName(generateName)
"GenerateName is an optional prefix, used by the server, to generate a unique name ONLY IF the Name field has not been provided. If this field is used, the name returned to the client will be different than the name passed. This value will also be combined with a unique suffix. The provided value has the same validation rules as the Name field, and may be truncated by the length of the suffix required to make the value unique on the server.\n\nIf this field is specified and the generated name exists, the server will NOT return a 409 - instead, it will either return 201 Created or 500 with Reason ServerTimeout indicating a unique name could not be found in the time allotted, and the client should retry (optionally after the time indicated in the Retry-After header).\n\nApplied only if Name is not specified. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#idempotency"
fn metadata.withGeneration
withGeneration(generation)
"A sequence number representing a specific generation of the desired state. Populated by the system. Read-only."
fn metadata.withLabels
withLabels(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
fn metadata.withLabelsMixin
withLabelsMixin(labels)
"Map of string keys and values that can be used to organize and categorize (scope and select) objects. May match selectors of replication controllers and services. More info: http://kubernetes.io/docs/user-guide/labels"
Note: This function appends passed data to existing values
fn metadata.withName
withName(name)
"Name must be unique within a namespace. Is required when creating resources, although some resources may allow a client to request the generation of an appropriate name automatically. Name is primarily intended for creation idempotence and configuration definition. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/identifiers#names"
fn metadata.withNamespace
withNamespace(namespace)
"Namespace defines the space within which each name must be unique. An empty namespace is equivalent to the \"default\" namespace, but \"default\" is the canonical representation. Not all objects are required to be scoped to a namespace - the value of this field for those objects will be empty.\n\nMust be a DNS_LABEL. Cannot be updated. More info: http://kubernetes.io/docs/user-guide/namespaces"
fn metadata.withOwnerReferences
withOwnerReferences(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
fn metadata.withOwnerReferencesMixin
withOwnerReferencesMixin(ownerReferences)
"List of objects depended by this object. If ALL objects in the list have been deleted, this object will be garbage collected. If this object is managed by a controller, then an entry in this list will point to this controller, with the controller field set to true. There cannot be more than one managing controller."
Note: This function appends passed data to existing values
fn metadata.withResourceVersion
withResourceVersion(resourceVersion)
"An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources. Clients must treat these values as opaque and passed unmodified back to the server. They may only be valid for a particular resource or set of resources.\n\nPopulated by the system. Read-only. Value must be treated as opaque by clients and . More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#concurrency-control-and-consistency"
fn metadata.withSelfLink
withSelfLink(selfLink)
"SelfLink is a URL representing this object. Populated by the system. Read-only.\n\nDEPRECATED Kubernetes will stop propagating this field in 1.20 release and the field is planned to be removed in 1.21 release."
fn metadata.withUid
withUid(uid)
"UID is the unique in time and space value for this object. It is typically generated by the server on successful creation of a resource and is not allowed to change on PUT operations.\n\nPopulated by the system. Read-only. More info: http://kubernetes.io/docs/user-guide/identifiers#uids"
obj spec
"NodePoolSpec defines the desired state of NodePool"
fn spec.withDeletionPolicy
withDeletionPolicy(deletionPolicy)
"DeletionPolicy specifies what will happen to the underlying external when this managed resource is deleted - either \"Delete\" or \"Orphan\" the external resource. This field is planned to be deprecated in favor of the ManagementPolicies field in a future release. Currently, both could be set independently and non-default values would be honored if the feature flag is enabled. See the design doc for more information: https://github.com/crossplane/crossplane/blob/499895a25d1a1a0ba1604944ef98ac7a1a71f197/design/design-doc-observe-only-resources.md?plain=1#L223"
fn spec.withManagementPolicies
withManagementPolicies(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. 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"
fn spec.withManagementPoliciesMixin
withManagementPoliciesMixin(managementPolicies)
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. 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"
Note: This function appends passed data to existing values
obj spec.forProvider
fn spec.forProvider.withAutoscaling
withAutoscaling(autoscaling)
"Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below."
fn spec.forProvider.withAutoscalingMixin
withAutoscalingMixin(autoscaling)
"Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withCluster
withCluster(cluster)
"The cluster to create the node pool for. Cluster must be present in location provided for clusters. May be specified in the format projects/{{project}}/locations/{{location}}/clusters/{{cluster}} or as just the name of the cluster."
fn spec.forProvider.withInitialNodeCount
withInitialNodeCount(initialNodeCount)
"The initial number of nodes for the pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Changing this will force recreation of the resource. If you don't need this value, don't set it. If you do need it, you can use a lifecycle block to ignore subsequent changes to this field."
fn spec.forProvider.withLocation
withLocation(location)
"The location (region or zone) of the cluster."
fn spec.forProvider.withManagement
withManagement(management)
"Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below."
fn spec.forProvider.withManagementMixin
withManagementMixin(management)
"Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withMaxPodsPerNode
withMaxPodsPerNode(maxPodsPerNode)
"The maximum number of pods per node in this node pool. Note that this does not work on node pools which are \"route-based\" - that is, node pools belonging to clusters that do not have IP Aliasing enabled. See the official documentation for more information."
fn spec.forProvider.withNetworkConfig
withNetworkConfig(networkConfig)
"The network configuration of the pool. Such as configuration for Adding Pod IP address ranges) to the node pool. Or enabling private nodes. Structure is documented below"
fn spec.forProvider.withNetworkConfigMixin
withNetworkConfigMixin(networkConfig)
"The network configuration of the pool. Such as configuration for Adding Pod IP address ranges) to the node pool. Or enabling private nodes. Structure is documented below"
Note: This function appends passed data to existing values
fn spec.forProvider.withNodeConfig
withNodeConfig(nodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.forProvider.withNodeConfigMixin
withNodeConfigMixin(nodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
Note: This function appends passed data to existing values
fn spec.forProvider.withNodeCount
withNodeCount(nodeCount)
"The number of nodes per instance group. This field can be used to update the number of nodes per instance group but should not be used alongside autoscaling."
fn spec.forProvider.withNodeLocations
withNodeLocations(nodeLocations)
"The list of zones in which the node pool's nodes should be 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 unspecified, the cluster-level node_locations will be used."
fn spec.forProvider.withNodeLocationsMixin
withNodeLocationsMixin(nodeLocations)
"The list of zones in which the node pool's nodes should be 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 unspecified, the cluster-level node_locations will be used."
Note: This function appends passed data to existing values
fn spec.forProvider.withPlacementPolicy
withPlacementPolicy(placementPolicy)
"Specifies a custom placement policy for the nodes."
fn spec.forProvider.withPlacementPolicyMixin
withPlacementPolicyMixin(placementPolicy)
"Specifies a custom placement policy for the nodes."
Note: This function appends passed data to existing values
fn spec.forProvider.withProject
withProject(project)
"The ID of the project in which to create the node pool. If blank, the provider-configured project will be used."
fn spec.forProvider.withUpgradeSettings
withUpgradeSettings(upgradeSettings)
"Specify node upgrade settings to change how GKE upgrades nodes. The maximum number of nodes upgraded simultaneously is limited to 20. Structure is documented below."
fn spec.forProvider.withUpgradeSettingsMixin
withUpgradeSettingsMixin(upgradeSettings)
"Specify node upgrade settings to change how GKE upgrades nodes. The maximum number of nodes upgraded simultaneously is limited to 20. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.forProvider.withVersion
withVersion(version)
"The Kubernetes version for the nodes in this pool. Note that if this field and auto_upgrade are both specified, they will fight each other for what the node version should be, so setting both is highly discouraged."
obj spec.forProvider.autoscaling
"Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below."
fn spec.forProvider.autoscaling.withLocationPolicy
withLocationPolicy(locationPolicy)
"Location policy specifies the algorithm used when scaling-up the node pool. Location policy is supported only in 1.24.1+ clusters."
fn spec.forProvider.autoscaling.withMaxNodeCount
withMaxNodeCount(maxNodeCount)
"Maximum number of nodes per zone in the NodePool. Must be >= min_node_count. Cannot be used with total limits."
fn spec.forProvider.autoscaling.withMinNodeCount
withMinNodeCount(minNodeCount)
"Minimum number of nodes per zone in the NodePool. Must be >=0 and <= max_node_count. Cannot be used with total limits."
fn spec.forProvider.autoscaling.withTotalMaxNodeCount
withTotalMaxNodeCount(totalMaxNodeCount)
"Total maximum number of nodes in the NodePool. Must be >= total_min_node_count. Cannot be used with per zone limits. Total size limits are supported only in 1.24.1+ clusters."
fn spec.forProvider.autoscaling.withTotalMinNodeCount
withTotalMinNodeCount(totalMinNodeCount)
"Total minimum number of nodes in the NodePool. Must be >=0 and <= total_max_node_count. Cannot be used with per zone limits. Total size limits are supported only in 1.24.1+ clusters."
obj spec.forProvider.clusterRef
"Reference to a Cluster to populate cluster."
fn spec.forProvider.clusterRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.clusterRef.policy
"Policies for referencing."
fn spec.forProvider.clusterRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.clusterRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.clusterSelector
"Selector for a Cluster to populate cluster."
fn spec.forProvider.clusterSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.clusterSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.clusterSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.clusterSelector.policy
"Policies for selection."
fn spec.forProvider.clusterSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.clusterSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.management
"Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below."
fn spec.forProvider.management.withAutoRepair
withAutoRepair(autoRepair)
"Whether the nodes will be automatically repaired."
fn spec.forProvider.management.withAutoUpgrade
withAutoUpgrade(autoUpgrade)
"Whether the nodes will be automatically upgraded."
obj spec.forProvider.networkConfig
"The network configuration of the pool. Such as configuration for Adding Pod IP address ranges) to the node pool. Or enabling private nodes. Structure is documented below"
fn spec.forProvider.networkConfig.withCreatePodRange
withCreatePodRange(createPodRange)
"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."
fn spec.forProvider.networkConfig.withEnablePrivateNodes
withEnablePrivateNodes(enablePrivateNodes)
"Whether nodes have internal IP addresses only."
fn spec.forProvider.networkConfig.withPodCidrOverprovisionConfig
withPodCidrOverprovisionConfig(podCidrOverprovisionConfig)
fn spec.forProvider.networkConfig.withPodCidrOverprovisionConfigMixin
withPodCidrOverprovisionConfigMixin(podCidrOverprovisionConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.networkConfig.withPodIpv4CidrBlock
withPodIpv4CidrBlock(podIpv4CidrBlock)
"The IP address range for pod IPs in this node pool. Only applicable if createPodRange is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use."
fn spec.forProvider.networkConfig.withPodRange
withPodRange(podRange)
"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."
obj spec.forProvider.networkConfig.podCidrOverprovisionConfig
fn spec.forProvider.networkConfig.podCidrOverprovisionConfig.withDisabled
withDisabled(disabled)
obj spec.forProvider.nodeConfig
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.forProvider.nodeConfig.withAdvancedMachineFeatures
withAdvancedMachineFeatures(advancedMachineFeatures)
fn spec.forProvider.nodeConfig.withAdvancedMachineFeaturesMixin
withAdvancedMachineFeaturesMixin(advancedMachineFeatures)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withBootDiskKmsKey
withBootDiskKmsKey(bootDiskKmsKey)
fn spec.forProvider.nodeConfig.withDiskSizeGb
withDiskSizeGb(diskSizeGb)
fn spec.forProvider.nodeConfig.withDiskType
withDiskType(diskType)
fn spec.forProvider.nodeConfig.withEphemeralStorageLocalSsdConfig
withEphemeralStorageLocalSsdConfig(ephemeralStorageLocalSsdConfig)
fn spec.forProvider.nodeConfig.withEphemeralStorageLocalSsdConfigMixin
withEphemeralStorageLocalSsdConfigMixin(ephemeralStorageLocalSsdConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withGcfsConfig
withGcfsConfig(gcfsConfig)
fn spec.forProvider.nodeConfig.withGcfsConfigMixin
withGcfsConfigMixin(gcfsConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withGuestAccelerator
withGuestAccelerator(guestAccelerator)
fn spec.forProvider.nodeConfig.withGuestAcceleratorMixin
withGuestAcceleratorMixin(guestAccelerator)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withGvnic
withGvnic(gvnic)
fn spec.forProvider.nodeConfig.withGvnicMixin
withGvnicMixin(gvnic)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withImageType
withImageType(imageType)
fn spec.forProvider.nodeConfig.withKubeletConfig
withKubeletConfig(kubeletConfig)
fn spec.forProvider.nodeConfig.withKubeletConfigMixin
withKubeletConfigMixin(kubeletConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withLabels
withLabels(labels)
fn spec.forProvider.nodeConfig.withLabelsMixin
withLabelsMixin(labels)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withLinuxNodeConfig
withLinuxNodeConfig(linuxNodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.forProvider.nodeConfig.withLinuxNodeConfigMixin
withLinuxNodeConfigMixin(linuxNodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withLocalNvmeSsdBlockConfig
withLocalNvmeSsdBlockConfig(localNvmeSsdBlockConfig)
fn spec.forProvider.nodeConfig.withLocalNvmeSsdBlockConfigMixin
withLocalNvmeSsdBlockConfigMixin(localNvmeSsdBlockConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withLocalSsdCount
withLocalSsdCount(localSsdCount)
fn spec.forProvider.nodeConfig.withLoggingVariant
withLoggingVariant(loggingVariant)
fn spec.forProvider.nodeConfig.withMachineType
withMachineType(machineType)
fn spec.forProvider.nodeConfig.withMetadata
withMetadata(metadata)
fn spec.forProvider.nodeConfig.withMetadataMixin
withMetadataMixin(metadata)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withMinCpuPlatform
withMinCpuPlatform(minCpuPlatform)
fn spec.forProvider.nodeConfig.withNodeGroup
withNodeGroup(nodeGroup)
fn spec.forProvider.nodeConfig.withOauthScopes
withOauthScopes(oauthScopes)
fn spec.forProvider.nodeConfig.withOauthScopesMixin
withOauthScopesMixin(oauthScopes)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withPreemptible
withPreemptible(preemptible)
fn spec.forProvider.nodeConfig.withReservationAffinity
withReservationAffinity(reservationAffinity)
fn spec.forProvider.nodeConfig.withReservationAffinityMixin
withReservationAffinityMixin(reservationAffinity)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withResourceLabels
withResourceLabels(resourceLabels)
fn spec.forProvider.nodeConfig.withResourceLabelsMixin
withResourceLabelsMixin(resourceLabels)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withServiceAccount
withServiceAccount(serviceAccount)
fn spec.forProvider.nodeConfig.withShieldedInstanceConfig
withShieldedInstanceConfig(shieldedInstanceConfig)
fn spec.forProvider.nodeConfig.withShieldedInstanceConfigMixin
withShieldedInstanceConfigMixin(shieldedInstanceConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withSpot
withSpot(spot)
fn spec.forProvider.nodeConfig.withTags
withTags(tags)
fn spec.forProvider.nodeConfig.withTagsMixin
withTagsMixin(tags)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withTaint
withTaint(taint)
fn spec.forProvider.nodeConfig.withTaintMixin
withTaintMixin(taint)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.withWorkloadMetadataConfig
withWorkloadMetadataConfig(workloadMetadataConfig)
fn spec.forProvider.nodeConfig.withWorkloadMetadataConfigMixin
withWorkloadMetadataConfigMixin(workloadMetadataConfig)
Note: This function appends passed data to existing values
obj spec.forProvider.nodeConfig.advancedMachineFeatures
fn spec.forProvider.nodeConfig.advancedMachineFeatures.withThreadsPerCore
withThreadsPerCore(threadsPerCore)
obj spec.forProvider.nodeConfig.ephemeralStorageLocalSsdConfig
fn spec.forProvider.nodeConfig.ephemeralStorageLocalSsdConfig.withLocalSsdCount
withLocalSsdCount(localSsdCount)
obj spec.forProvider.nodeConfig.gcfsConfig
fn spec.forProvider.nodeConfig.gcfsConfig.withEnabled
withEnabled(enabled)
obj spec.forProvider.nodeConfig.guestAccelerator
fn spec.forProvider.nodeConfig.guestAccelerator.withCount
withCount(count)
fn spec.forProvider.nodeConfig.guestAccelerator.withGpuPartitionSize
withGpuPartitionSize(gpuPartitionSize)
fn spec.forProvider.nodeConfig.guestAccelerator.withGpuSharingConfig
withGpuSharingConfig(gpuSharingConfig)
fn spec.forProvider.nodeConfig.guestAccelerator.withGpuSharingConfigMixin
withGpuSharingConfigMixin(gpuSharingConfig)
Note: This function appends passed data to existing values
fn spec.forProvider.nodeConfig.guestAccelerator.withType
withType(type)
"The type of the policy. Supports a single value: COMPACT. Specifying COMPACT placement policy type places node pool's nodes in a closer physical proximity in order to reduce network latency between nodes."
obj spec.forProvider.nodeConfig.guestAccelerator.gpuSharingConfig
fn spec.forProvider.nodeConfig.guestAccelerator.gpuSharingConfig.withGpuSharingStrategy
withGpuSharingStrategy(gpuSharingStrategy)
fn spec.forProvider.nodeConfig.guestAccelerator.gpuSharingConfig.withMaxSharedClientsPerGpu
withMaxSharedClientsPerGpu(maxSharedClientsPerGpu)
obj spec.forProvider.nodeConfig.gvnic
fn spec.forProvider.nodeConfig.gvnic.withEnabled
withEnabled(enabled)
obj spec.forProvider.nodeConfig.kubeletConfig
fn spec.forProvider.nodeConfig.kubeletConfig.withCpuCfsQuota
withCpuCfsQuota(cpuCfsQuota)
fn spec.forProvider.nodeConfig.kubeletConfig.withCpuCfsQuotaPeriod
withCpuCfsQuotaPeriod(cpuCfsQuotaPeriod)
fn spec.forProvider.nodeConfig.kubeletConfig.withCpuManagerPolicy
withCpuManagerPolicy(cpuManagerPolicy)
fn spec.forProvider.nodeConfig.kubeletConfig.withPodPidsLimit
withPodPidsLimit(podPidsLimit)
obj spec.forProvider.nodeConfig.linuxNodeConfig
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.forProvider.nodeConfig.linuxNodeConfig.withSysctls
withSysctls(sysctls)
fn spec.forProvider.nodeConfig.linuxNodeConfig.withSysctlsMixin
withSysctlsMixin(sysctls)
Note: This function appends passed data to existing values
obj spec.forProvider.nodeConfig.localNvmeSsdBlockConfig
fn spec.forProvider.nodeConfig.localNvmeSsdBlockConfig.withLocalSsdCount
withLocalSsdCount(localSsdCount)
obj spec.forProvider.nodeConfig.reservationAffinity
fn spec.forProvider.nodeConfig.reservationAffinity.withConsumeReservationType
withConsumeReservationType(consumeReservationType)
fn spec.forProvider.nodeConfig.reservationAffinity.withKey
withKey(key)
fn spec.forProvider.nodeConfig.reservationAffinity.withValues
withValues(values)
fn spec.forProvider.nodeConfig.reservationAffinity.withValuesMixin
withValuesMixin(values)
Note: This function appends passed data to existing values
obj spec.forProvider.nodeConfig.serviceAccountRef
"Reference to a ServiceAccount in cloudplatform to populate serviceAccount."
fn spec.forProvider.nodeConfig.serviceAccountRef.withName
withName(name)
"Name of the referenced object."
obj spec.forProvider.nodeConfig.serviceAccountRef.policy
"Policies for referencing."
fn spec.forProvider.nodeConfig.serviceAccountRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.nodeConfig.serviceAccountRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.nodeConfig.serviceAccountSelector
"Selector for a ServiceAccount in cloudplatform to populate serviceAccount."
fn spec.forProvider.nodeConfig.serviceAccountSelector.withMatchControllerRef
withMatchControllerRef(matchControllerRef)
"MatchControllerRef ensures an object with the same controller reference as the selecting object is selected."
fn spec.forProvider.nodeConfig.serviceAccountSelector.withMatchLabels
withMatchLabels(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
fn spec.forProvider.nodeConfig.serviceAccountSelector.withMatchLabelsMixin
withMatchLabelsMixin(matchLabels)
"MatchLabels ensures an object with matching labels is selected."
Note: This function appends passed data to existing values
obj spec.forProvider.nodeConfig.serviceAccountSelector.policy
"Policies for selection."
fn spec.forProvider.nodeConfig.serviceAccountSelector.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.forProvider.nodeConfig.serviceAccountSelector.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.forProvider.nodeConfig.shieldedInstanceConfig
fn spec.forProvider.nodeConfig.shieldedInstanceConfig.withEnableIntegrityMonitoring
withEnableIntegrityMonitoring(enableIntegrityMonitoring)
fn spec.forProvider.nodeConfig.shieldedInstanceConfig.withEnableSecureBoot
withEnableSecureBoot(enableSecureBoot)
obj spec.forProvider.nodeConfig.taint
fn spec.forProvider.nodeConfig.taint.withEffect
withEffect(effect)
fn spec.forProvider.nodeConfig.taint.withKey
withKey(key)
fn spec.forProvider.nodeConfig.taint.withValue
withValue(value)
obj spec.forProvider.nodeConfig.workloadMetadataConfig
fn spec.forProvider.nodeConfig.workloadMetadataConfig.withMode
withMode(mode)
obj spec.forProvider.placementPolicy
"Specifies a custom placement policy for the nodes."
fn spec.forProvider.placementPolicy.withType
withType(type)
"The type of the policy. Supports a single value: COMPACT. Specifying COMPACT placement policy type places node pool's nodes in a closer physical proximity in order to reduce network latency between nodes."
obj spec.forProvider.upgradeSettings
"Specify node upgrade settings to change how GKE upgrades nodes. The maximum number of nodes upgraded simultaneously is limited to 20. Structure is documented below."
fn spec.forProvider.upgradeSettings.withBlueGreenSettings
withBlueGreenSettings(blueGreenSettings)
"The settings to adjust blue green upgrades. Structure is documented below"
fn spec.forProvider.upgradeSettings.withBlueGreenSettingsMixin
withBlueGreenSettingsMixin(blueGreenSettings)
"The settings to adjust blue green upgrades. Structure is documented below"
Note: This function appends passed data to existing values
fn spec.forProvider.upgradeSettings.withMaxSurge
withMaxSurge(maxSurge)
"The number of additional nodes that can be added to the node pool during an upgrade. Increasing max_surge raises the number of nodes that can be upgraded simultaneously. Can be set to 0 or greater."
fn spec.forProvider.upgradeSettings.withMaxUnavailable
withMaxUnavailable(maxUnavailable)
"The number of nodes that can be simultaneously unavailable during an upgrade. Increasing max_unavailable raises the number of nodes that can be upgraded in parallel. Can be set to 0 or greater."
fn spec.forProvider.upgradeSettings.withStrategy
withStrategy(strategy)
"(Default SURGE) The upgrade stragey to be used for upgrading the nodes."
obj spec.forProvider.upgradeSettings.blueGreenSettings
"The settings to adjust blue green upgrades. Structure is documented below"
fn spec.forProvider.upgradeSettings.blueGreenSettings.withNodePoolSoakDuration
withNodePoolSoakDuration(nodePoolSoakDuration)
"Time needed after draining the entire blue pool. After this period, the blue pool will be cleaned up."
fn spec.forProvider.upgradeSettings.blueGreenSettings.withStandardRolloutPolicy
withStandardRolloutPolicy(standardRolloutPolicy)
"Specifies the standard policy settings for blue-green upgrades."
fn spec.forProvider.upgradeSettings.blueGreenSettings.withStandardRolloutPolicyMixin
withStandardRolloutPolicyMixin(standardRolloutPolicy)
"Specifies the standard policy settings for blue-green upgrades."
Note: This function appends passed data to existing values
obj spec.forProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy
"Specifies the standard policy settings for blue-green upgrades."
fn spec.forProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy.withBatchNodeCount
withBatchNodeCount(batchNodeCount)
"Number of blue nodes to drain in a batch."
fn spec.forProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy.withBatchPercentage
withBatchPercentage(batchPercentage)
"Percentage of the blue pool nodes to drain in a batch."
fn spec.forProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy.withBatchSoakDuration
withBatchSoakDuration(batchSoakDuration)
"(Optionial) Soak time after each batch gets drained."
obj spec.initProvider
"THIS IS AN ALPHA FIELD. Do not use it in production. It is not honored unless the relevant Crossplane feature flag is enabled, and may be changed or removed without notice. 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."
fn spec.initProvider.withAutoscaling
withAutoscaling(autoscaling)
"Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below."
fn spec.initProvider.withAutoscalingMixin
withAutoscalingMixin(autoscaling)
"Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withInitialNodeCount
withInitialNodeCount(initialNodeCount)
"The initial number of nodes for the pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Changing this will force recreation of the resource. If you don't need this value, don't set it. If you do need it, you can use a lifecycle block to ignore subsequent changes to this field."
fn spec.initProvider.withManagement
withManagement(management)
"Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below."
fn spec.initProvider.withManagementMixin
withManagementMixin(management)
"Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withMaxPodsPerNode
withMaxPodsPerNode(maxPodsPerNode)
"The maximum number of pods per node in this node pool. Note that this does not work on node pools which are \"route-based\" - that is, node pools belonging to clusters that do not have IP Aliasing enabled. See the official documentation for more information."
fn spec.initProvider.withNetworkConfig
withNetworkConfig(networkConfig)
"The network configuration of the pool. Such as configuration for Adding Pod IP address ranges) to the node pool. Or enabling private nodes. Structure is documented below"
fn spec.initProvider.withNetworkConfigMixin
withNetworkConfigMixin(networkConfig)
"The network configuration of the pool. Such as configuration for Adding Pod IP address ranges) to the node pool. Or enabling private nodes. Structure is documented below"
Note: This function appends passed data to existing values
fn spec.initProvider.withNodeConfig
withNodeConfig(nodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.initProvider.withNodeConfigMixin
withNodeConfigMixin(nodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
Note: This function appends passed data to existing values
fn spec.initProvider.withNodeCount
withNodeCount(nodeCount)
"The number of nodes per instance group. This field can be used to update the number of nodes per instance group but should not be used alongside autoscaling."
fn spec.initProvider.withNodeLocations
withNodeLocations(nodeLocations)
"The list of zones in which the node pool's nodes should be 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 unspecified, the cluster-level node_locations will be used."
fn spec.initProvider.withNodeLocationsMixin
withNodeLocationsMixin(nodeLocations)
"The list of zones in which the node pool's nodes should be 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 unspecified, the cluster-level node_locations will be used."
Note: This function appends passed data to existing values
fn spec.initProvider.withPlacementPolicy
withPlacementPolicy(placementPolicy)
"Specifies a custom placement policy for the nodes."
fn spec.initProvider.withPlacementPolicyMixin
withPlacementPolicyMixin(placementPolicy)
"Specifies a custom placement policy for the nodes."
Note: This function appends passed data to existing values
fn spec.initProvider.withProject
withProject(project)
"The ID of the project in which to create the node pool. If blank, the provider-configured project will be used."
fn spec.initProvider.withUpgradeSettings
withUpgradeSettings(upgradeSettings)
"Specify node upgrade settings to change how GKE upgrades nodes. The maximum number of nodes upgraded simultaneously is limited to 20. Structure is documented below."
fn spec.initProvider.withUpgradeSettingsMixin
withUpgradeSettingsMixin(upgradeSettings)
"Specify node upgrade settings to change how GKE upgrades nodes. The maximum number of nodes upgraded simultaneously is limited to 20. Structure is documented below."
Note: This function appends passed data to existing values
fn spec.initProvider.withVersion
withVersion(version)
"The Kubernetes version for the nodes in this pool. Note that if this field and auto_upgrade are both specified, they will fight each other for what the node version should be, so setting both is highly discouraged."
obj spec.initProvider.autoscaling
"Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below."
fn spec.initProvider.autoscaling.withLocationPolicy
withLocationPolicy(locationPolicy)
"Location policy specifies the algorithm used when scaling-up the node pool. Location policy is supported only in 1.24.1+ clusters."
fn spec.initProvider.autoscaling.withMaxNodeCount
withMaxNodeCount(maxNodeCount)
"Maximum number of nodes per zone in the NodePool. Must be >= min_node_count. Cannot be used with total limits."
fn spec.initProvider.autoscaling.withMinNodeCount
withMinNodeCount(minNodeCount)
"Minimum number of nodes per zone in the NodePool. Must be >=0 and <= max_node_count. Cannot be used with total limits."
fn spec.initProvider.autoscaling.withTotalMaxNodeCount
withTotalMaxNodeCount(totalMaxNodeCount)
"Total maximum number of nodes in the NodePool. Must be >= total_min_node_count. Cannot be used with per zone limits. Total size limits are supported only in 1.24.1+ clusters."
fn spec.initProvider.autoscaling.withTotalMinNodeCount
withTotalMinNodeCount(totalMinNodeCount)
"Total minimum number of nodes in the NodePool. Must be >=0 and <= total_max_node_count. Cannot be used with per zone limits. Total size limits are supported only in 1.24.1+ clusters."
obj spec.initProvider.management
"Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below."
fn spec.initProvider.management.withAutoRepair
withAutoRepair(autoRepair)
"Whether the nodes will be automatically repaired."
fn spec.initProvider.management.withAutoUpgrade
withAutoUpgrade(autoUpgrade)
"Whether the nodes will be automatically upgraded."
obj spec.initProvider.networkConfig
"The network configuration of the pool. Such as configuration for Adding Pod IP address ranges) to the node pool. Or enabling private nodes. Structure is documented below"
fn spec.initProvider.networkConfig.withCreatePodRange
withCreatePodRange(createPodRange)
"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."
fn spec.initProvider.networkConfig.withEnablePrivateNodes
withEnablePrivateNodes(enablePrivateNodes)
"Whether nodes have internal IP addresses only."
fn spec.initProvider.networkConfig.withPodCidrOverprovisionConfig
withPodCidrOverprovisionConfig(podCidrOverprovisionConfig)
fn spec.initProvider.networkConfig.withPodCidrOverprovisionConfigMixin
withPodCidrOverprovisionConfigMixin(podCidrOverprovisionConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.networkConfig.withPodIpv4CidrBlock
withPodIpv4CidrBlock(podIpv4CidrBlock)
"The IP address range for pod IPs in this node pool. Only applicable if createPodRange is true. Set to blank to have a range chosen with the default size. Set to /netmask (e.g. /14) to have a range chosen with a specific netmask. Set to a CIDR notation (e.g. 10.96.0.0/14) to pick a specific range to use."
fn spec.initProvider.networkConfig.withPodRange
withPodRange(podRange)
"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."
obj spec.initProvider.networkConfig.podCidrOverprovisionConfig
fn spec.initProvider.networkConfig.podCidrOverprovisionConfig.withDisabled
withDisabled(disabled)
obj spec.initProvider.nodeConfig
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.initProvider.nodeConfig.withAdvancedMachineFeatures
withAdvancedMachineFeatures(advancedMachineFeatures)
fn spec.initProvider.nodeConfig.withAdvancedMachineFeaturesMixin
withAdvancedMachineFeaturesMixin(advancedMachineFeatures)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withBootDiskKmsKey
withBootDiskKmsKey(bootDiskKmsKey)
fn spec.initProvider.nodeConfig.withDiskSizeGb
withDiskSizeGb(diskSizeGb)
fn spec.initProvider.nodeConfig.withDiskType
withDiskType(diskType)
fn spec.initProvider.nodeConfig.withEphemeralStorageLocalSsdConfig
withEphemeralStorageLocalSsdConfig(ephemeralStorageLocalSsdConfig)
fn spec.initProvider.nodeConfig.withEphemeralStorageLocalSsdConfigMixin
withEphemeralStorageLocalSsdConfigMixin(ephemeralStorageLocalSsdConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withGcfsConfig
withGcfsConfig(gcfsConfig)
fn spec.initProvider.nodeConfig.withGcfsConfigMixin
withGcfsConfigMixin(gcfsConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withGuestAccelerator
withGuestAccelerator(guestAccelerator)
fn spec.initProvider.nodeConfig.withGuestAcceleratorMixin
withGuestAcceleratorMixin(guestAccelerator)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withGvnic
withGvnic(gvnic)
fn spec.initProvider.nodeConfig.withGvnicMixin
withGvnicMixin(gvnic)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withImageType
withImageType(imageType)
fn spec.initProvider.nodeConfig.withKubeletConfig
withKubeletConfig(kubeletConfig)
fn spec.initProvider.nodeConfig.withKubeletConfigMixin
withKubeletConfigMixin(kubeletConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withLabels
withLabels(labels)
fn spec.initProvider.nodeConfig.withLabelsMixin
withLabelsMixin(labels)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withLinuxNodeConfig
withLinuxNodeConfig(linuxNodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.initProvider.nodeConfig.withLinuxNodeConfigMixin
withLinuxNodeConfigMixin(linuxNodeConfig)
"Parameters used in creating the node pool. See google_container_cluster for schema."
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withLocalNvmeSsdBlockConfig
withLocalNvmeSsdBlockConfig(localNvmeSsdBlockConfig)
fn spec.initProvider.nodeConfig.withLocalNvmeSsdBlockConfigMixin
withLocalNvmeSsdBlockConfigMixin(localNvmeSsdBlockConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withLocalSsdCount
withLocalSsdCount(localSsdCount)
fn spec.initProvider.nodeConfig.withLoggingVariant
withLoggingVariant(loggingVariant)
fn spec.initProvider.nodeConfig.withMachineType
withMachineType(machineType)
fn spec.initProvider.nodeConfig.withMetadata
withMetadata(metadata)
fn spec.initProvider.nodeConfig.withMetadataMixin
withMetadataMixin(metadata)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withMinCpuPlatform
withMinCpuPlatform(minCpuPlatform)
fn spec.initProvider.nodeConfig.withNodeGroup
withNodeGroup(nodeGroup)
fn spec.initProvider.nodeConfig.withOauthScopes
withOauthScopes(oauthScopes)
fn spec.initProvider.nodeConfig.withOauthScopesMixin
withOauthScopesMixin(oauthScopes)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withPreemptible
withPreemptible(preemptible)
fn spec.initProvider.nodeConfig.withReservationAffinity
withReservationAffinity(reservationAffinity)
fn spec.initProvider.nodeConfig.withReservationAffinityMixin
withReservationAffinityMixin(reservationAffinity)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withResourceLabels
withResourceLabels(resourceLabels)
fn spec.initProvider.nodeConfig.withResourceLabelsMixin
withResourceLabelsMixin(resourceLabels)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withShieldedInstanceConfig
withShieldedInstanceConfig(shieldedInstanceConfig)
fn spec.initProvider.nodeConfig.withShieldedInstanceConfigMixin
withShieldedInstanceConfigMixin(shieldedInstanceConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withSpot
withSpot(spot)
fn spec.initProvider.nodeConfig.withTags
withTags(tags)
fn spec.initProvider.nodeConfig.withTagsMixin
withTagsMixin(tags)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withTaint
withTaint(taint)
fn spec.initProvider.nodeConfig.withTaintMixin
withTaintMixin(taint)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.withWorkloadMetadataConfig
withWorkloadMetadataConfig(workloadMetadataConfig)
fn spec.initProvider.nodeConfig.withWorkloadMetadataConfigMixin
withWorkloadMetadataConfigMixin(workloadMetadataConfig)
Note: This function appends passed data to existing values
obj spec.initProvider.nodeConfig.advancedMachineFeatures
fn spec.initProvider.nodeConfig.advancedMachineFeatures.withThreadsPerCore
withThreadsPerCore(threadsPerCore)
obj spec.initProvider.nodeConfig.ephemeralStorageLocalSsdConfig
fn spec.initProvider.nodeConfig.ephemeralStorageLocalSsdConfig.withLocalSsdCount
withLocalSsdCount(localSsdCount)
obj spec.initProvider.nodeConfig.gcfsConfig
fn spec.initProvider.nodeConfig.gcfsConfig.withEnabled
withEnabled(enabled)
obj spec.initProvider.nodeConfig.guestAccelerator
fn spec.initProvider.nodeConfig.guestAccelerator.withCount
withCount(count)
fn spec.initProvider.nodeConfig.guestAccelerator.withGpuPartitionSize
withGpuPartitionSize(gpuPartitionSize)
fn spec.initProvider.nodeConfig.guestAccelerator.withGpuSharingConfig
withGpuSharingConfig(gpuSharingConfig)
fn spec.initProvider.nodeConfig.guestAccelerator.withGpuSharingConfigMixin
withGpuSharingConfigMixin(gpuSharingConfig)
Note: This function appends passed data to existing values
fn spec.initProvider.nodeConfig.guestAccelerator.withType
withType(type)
"The type of the policy. Supports a single value: COMPACT. Specifying COMPACT placement policy type places node pool's nodes in a closer physical proximity in order to reduce network latency between nodes."
obj spec.initProvider.nodeConfig.guestAccelerator.gpuSharingConfig
fn spec.initProvider.nodeConfig.guestAccelerator.gpuSharingConfig.withGpuSharingStrategy
withGpuSharingStrategy(gpuSharingStrategy)
fn spec.initProvider.nodeConfig.guestAccelerator.gpuSharingConfig.withMaxSharedClientsPerGpu
withMaxSharedClientsPerGpu(maxSharedClientsPerGpu)
obj spec.initProvider.nodeConfig.gvnic
fn spec.initProvider.nodeConfig.gvnic.withEnabled
withEnabled(enabled)
obj spec.initProvider.nodeConfig.kubeletConfig
fn spec.initProvider.nodeConfig.kubeletConfig.withCpuCfsQuota
withCpuCfsQuota(cpuCfsQuota)
fn spec.initProvider.nodeConfig.kubeletConfig.withCpuCfsQuotaPeriod
withCpuCfsQuotaPeriod(cpuCfsQuotaPeriod)
fn spec.initProvider.nodeConfig.kubeletConfig.withCpuManagerPolicy
withCpuManagerPolicy(cpuManagerPolicy)
fn spec.initProvider.nodeConfig.kubeletConfig.withPodPidsLimit
withPodPidsLimit(podPidsLimit)
obj spec.initProvider.nodeConfig.linuxNodeConfig
"Parameters used in creating the node pool. See google_container_cluster for schema."
fn spec.initProvider.nodeConfig.linuxNodeConfig.withSysctls
withSysctls(sysctls)
fn spec.initProvider.nodeConfig.linuxNodeConfig.withSysctlsMixin
withSysctlsMixin(sysctls)
Note: This function appends passed data to existing values
obj spec.initProvider.nodeConfig.localNvmeSsdBlockConfig
fn spec.initProvider.nodeConfig.localNvmeSsdBlockConfig.withLocalSsdCount
withLocalSsdCount(localSsdCount)
obj spec.initProvider.nodeConfig.reservationAffinity
fn spec.initProvider.nodeConfig.reservationAffinity.withConsumeReservationType
withConsumeReservationType(consumeReservationType)
fn spec.initProvider.nodeConfig.reservationAffinity.withKey
withKey(key)
fn spec.initProvider.nodeConfig.reservationAffinity.withValues
withValues(values)
fn spec.initProvider.nodeConfig.reservationAffinity.withValuesMixin
withValuesMixin(values)
Note: This function appends passed data to existing values
obj spec.initProvider.nodeConfig.shieldedInstanceConfig
fn spec.initProvider.nodeConfig.shieldedInstanceConfig.withEnableIntegrityMonitoring
withEnableIntegrityMonitoring(enableIntegrityMonitoring)
fn spec.initProvider.nodeConfig.shieldedInstanceConfig.withEnableSecureBoot
withEnableSecureBoot(enableSecureBoot)
obj spec.initProvider.nodeConfig.taint
fn spec.initProvider.nodeConfig.taint.withEffect
withEffect(effect)
fn spec.initProvider.nodeConfig.taint.withKey
withKey(key)
fn spec.initProvider.nodeConfig.taint.withValue
withValue(value)
obj spec.initProvider.nodeConfig.workloadMetadataConfig
fn spec.initProvider.nodeConfig.workloadMetadataConfig.withMode
withMode(mode)
obj spec.initProvider.placementPolicy
"Specifies a custom placement policy for the nodes."
fn spec.initProvider.placementPolicy.withType
withType(type)
"The type of the policy. Supports a single value: COMPACT. Specifying COMPACT placement policy type places node pool's nodes in a closer physical proximity in order to reduce network latency between nodes."
obj spec.initProvider.upgradeSettings
"Specify node upgrade settings to change how GKE upgrades nodes. The maximum number of nodes upgraded simultaneously is limited to 20. Structure is documented below."
fn spec.initProvider.upgradeSettings.withBlueGreenSettings
withBlueGreenSettings(blueGreenSettings)
"The settings to adjust blue green upgrades. Structure is documented below"
fn spec.initProvider.upgradeSettings.withBlueGreenSettingsMixin
withBlueGreenSettingsMixin(blueGreenSettings)
"The settings to adjust blue green upgrades. Structure is documented below"
Note: This function appends passed data to existing values
fn spec.initProvider.upgradeSettings.withMaxSurge
withMaxSurge(maxSurge)
"The number of additional nodes that can be added to the node pool during an upgrade. Increasing max_surge raises the number of nodes that can be upgraded simultaneously. Can be set to 0 or greater."
fn spec.initProvider.upgradeSettings.withMaxUnavailable
withMaxUnavailable(maxUnavailable)
"The number of nodes that can be simultaneously unavailable during an upgrade. Increasing max_unavailable raises the number of nodes that can be upgraded in parallel. Can be set to 0 or greater."
fn spec.initProvider.upgradeSettings.withStrategy
withStrategy(strategy)
"(Default SURGE) The upgrade stragey to be used for upgrading the nodes."
obj spec.initProvider.upgradeSettings.blueGreenSettings
"The settings to adjust blue green upgrades. Structure is documented below"
fn spec.initProvider.upgradeSettings.blueGreenSettings.withNodePoolSoakDuration
withNodePoolSoakDuration(nodePoolSoakDuration)
"Time needed after draining the entire blue pool. After this period, the blue pool will be cleaned up."
fn spec.initProvider.upgradeSettings.blueGreenSettings.withStandardRolloutPolicy
withStandardRolloutPolicy(standardRolloutPolicy)
"Specifies the standard policy settings for blue-green upgrades."
fn spec.initProvider.upgradeSettings.blueGreenSettings.withStandardRolloutPolicyMixin
withStandardRolloutPolicyMixin(standardRolloutPolicy)
"Specifies the standard policy settings for blue-green upgrades."
Note: This function appends passed data to existing values
obj spec.initProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy
"Specifies the standard policy settings for blue-green upgrades."
fn spec.initProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy.withBatchNodeCount
withBatchNodeCount(batchNodeCount)
"Number of blue nodes to drain in a batch."
fn spec.initProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy.withBatchPercentage
withBatchPercentage(batchPercentage)
"Percentage of the blue pool nodes to drain in a batch."
fn spec.initProvider.upgradeSettings.blueGreenSettings.standardRolloutPolicy.withBatchSoakDuration
withBatchSoakDuration(batchSoakDuration)
"(Optionial) Soak time after each batch gets drained."
obj spec.providerConfigRef
"ProviderConfigReference specifies how the provider that will be used to create, observe, update, and delete this managed resource should be configured."
fn spec.providerConfigRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerConfigRef.policy
"Policies for referencing."
fn spec.providerConfigRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerConfigRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.providerRef
"ProviderReference specifies the provider that will be used to create, observe, update, and delete this managed resource. Deprecated: Please use ProviderConfigReference, i.e. providerConfigRef
"
fn spec.providerRef.withName
withName(name)
"Name of the referenced object."
obj spec.providerRef.policy
"Policies for referencing."
fn spec.providerRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.providerRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo
"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."
fn spec.publishConnectionDetailsTo.withName
withName(name)
"Name is the name of the connection secret."
obj spec.publishConnectionDetailsTo.configRef
"SecretStoreConfigRef specifies which secret store config should be used for this ConnectionSecret."
fn spec.publishConnectionDetailsTo.configRef.withName
withName(name)
"Name of the referenced object."
obj spec.publishConnectionDetailsTo.configRef.policy
"Policies for referencing."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolution
withResolution(resolution)
"Resolution specifies whether resolution of this reference is required. The default is 'Required', which means the reconcile will fail if the reference cannot be resolved. 'Optional' means this reference will be a no-op if it cannot be resolved."
fn spec.publishConnectionDetailsTo.configRef.policy.withResolve
withResolve(resolve)
"Resolve specifies when this reference should be resolved. The default is 'IfNotPresent', which will attempt to resolve the reference only when the corresponding field is not present. Use 'Always' to resolve the reference on every reconcile."
obj spec.publishConnectionDetailsTo.metadata
"Metadata is the metadata for connection secret."
fn spec.publishConnectionDetailsTo.metadata.withAnnotations
withAnnotations(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withAnnotationsMixin
withAnnotationsMixin(annotations)
"Annotations are the annotations to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.annotations\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withLabels
withLabels(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
fn spec.publishConnectionDetailsTo.metadata.withLabelsMixin
withLabelsMixin(labels)
"Labels are the labels/tags to be added to connection secret. - For Kubernetes secrets, this will be used as \"metadata.labels\". - It is up to Secret Store implementation for others store types."
Note: This function appends passed data to existing values
fn spec.publishConnectionDetailsTo.metadata.withType
withType(type)
"Type is the SecretType for the connection secret. - Only valid for Kubernetes Secret Stores."
obj spec.writeConnectionSecretToRef
"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."
fn spec.writeConnectionSecretToRef.withName
withName(name)
"Name of the secret."
fn spec.writeConnectionSecretToRef.withNamespace
withNamespace(namespace)
"Namespace of the secret."