NodeConfig class

Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead.

Constructors

NodeConfig({Input<List<AcceleratorConfig>>? accelerators, Input<AdvancedMachineFeatures>? advancedMachineFeatures, Input<String>? bootDiskKmsKey, Input<ConfidentialNodes>? confidentialNodes, Input<int>? diskSizeGb, Input<String>? diskType, Input<EphemeralStorageLocalSsdConfig>? ephemeralStorageLocalSsdConfig, Input<FastSocket>? fastSocket, Input<GcfsConfig>? gcfsConfig, Input<VirtualNIC>? gvnic, Input<String>? imageType, Input<NodeKubeletConfig>? kubeletConfig, Input<Map<String, String>>? labels, Input<LinuxNodeConfig>? linuxNodeConfig, Input<LocalNvmeSsdBlockConfig>? localNvmeSsdBlockConfig, Input<int>? localSsdCount, Input<NodePoolLoggingConfig>? loggingConfig, Input<String>? machineType, Input<Map<String, String>>? metadata, Input<String>? minCpuPlatform, Input<String>? nodeGroup, Input<List<String>>? oauthScopes, Input<bool>? preemptible, Input<ReservationAffinity>? reservationAffinity, Input<Map<String, String>>? resourceLabels, Input<ResourceManagerTags>? resourceManagerTags, Input<SandboxConfig>? sandboxConfig, Input<String>? serviceAccount, Input<ShieldedInstanceConfig>? shieldedInstanceConfig, Input<SoleTenantConfig>? soleTenantConfig, Input<bool>? spot, Input<List<String>>? tags, Input<List<NodeTaint>>? taints, Input<WindowsNodeConfig>? windowsNodeConfig, Input<WorkloadMetadataConfig>? workloadMetadataConfig})
Creates a new NodeConfig. accelerators A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs. advancedMachineFeatures Advanced features for the Compute Engine VM. bootDiskKmsKey The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption confidentialNodes Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. diskSizeGb Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB. diskType Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard' ephemeralStorageLocalSsdConfig Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. fastSocket Enable or disable NCCL fast socket for the node pool. gcfsConfig Google Container File System (image streaming) configs. gvnic Enable or disable gvnic in the node pool. imageType The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types. kubeletConfig Node kubelet configs. labels The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/ linuxNodeConfig Parameters that can be configured on Linux nodes. localNvmeSsdBlockConfig Parameters for using raw-block Local NVMe SSDs. localSsdCount The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information. loggingConfig Logging configuration. machineType The name of a Google Compute Engine machine type If unspecified, the default machine type is e2-medium. metadata The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB. minCpuPlatform Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform nodeGroup Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes. oauthScopes The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes. * https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. preemptible Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances. reservationAffinity The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool. resourceLabels The resource labels for the node pool to use to annotate any related Google Compute Engine resources. resourceManagerTags A map of resource manager tag keys and values to be attached to the nodes. sandboxConfig Sandbox configuration for this node. serviceAccount The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used. shieldedInstanceConfig Shielded Instance options. soleTenantConfig Parameters for node pools to be backed by shared sole tenant node groups. spot Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. tags The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035. taints List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/ windowsNodeConfig Parameters that can be configured on Windows nodes. workloadMetadataConfig The workload metadata configuration for this node.
const
NodeConfig.fromMap(Map<String, dynamic> map)
factory

Properties

accelerators → Input<List<AcceleratorConfig>>?
A list of hardware accelerators to be attached to each node. See https://cloud.google.com/compute/docs/gpus for more information about support for GPUs.
final
advancedMachineFeatures → Input<AdvancedMachineFeatures>?
Advanced features for the Compute Engine VM.
final
bootDiskKmsKey → Input<String>?
The Customer Managed Encryption Key used to encrypt the boot disk attached to each node in the node pool. This should be of the form projects/KEY_PROJECT_ID/locations/LOCATION/keyRings/RING_NAME/cryptoKeys/KEY_NAME. For more information about protecting resources with Cloud KMS Keys please see: https://cloud.google.com/compute/docs/disks/customer-managed-encryption
final
confidentialNodes → Input<ConfidentialNodes>?
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
final
diskSizeGb → Input<int>?
Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. If unspecified, the default disk size is 100GB.
final
diskType → Input<String>?
Type of the disk attached to each node (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') If unspecified, the default disk type is 'pd-standard'
final
ephemeralStorageLocalSsdConfig → Input<EphemeralStorageLocalSsdConfig>?
Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
final
fastSocket → Input<FastSocket>?
Enable or disable NCCL fast socket for the node pool.
final
gcfsConfig → Input<GcfsConfig>?
Google Container File System (image streaming) configs.
final
gvnic → Input<VirtualNIC>?
Enable or disable gvnic in the node pool.
final
hashCode → int
The hash code for this object.
no setterinherited
imageType → Input<String>?
The image type to use for this node. Note that for a given image type, the latest version of it will be used. Please see https://cloud.google.com/kubernetes-engine/docs/concepts/node-images for available image types.
final
kubeletConfig → Input<NodeKubeletConfig>?
Node kubelet configs.
final
labels → Input<Map<String, String>>?
The map of Kubernetes labels (key/value pairs) to be applied to each node. These will added in addition to any default label(s) that Kubernetes may apply to the node. In case of conflict in label keys, the applied set may differ depending on the Kubernetes version -- it's best to assume the behavior is undefined and conflicts should be avoided. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
final
linuxNodeConfig → Input<LinuxNodeConfig>?
Parameters that can be configured on Linux nodes.
final
localNvmeSsdBlockConfig → Input<LocalNvmeSsdBlockConfig>?
Parameters for using raw-block Local NVMe SSDs.
final
localSsdCount → Input<int>?
The number of local SSD disks to be attached to the node. The limit for this value is dependent upon the maximum number of disks available on a machine per zone. See: https://cloud.google.com/compute/docs/disks/local-ssd for more information.
final
loggingConfig → Input<NodePoolLoggingConfig>?
Logging configuration.
final
machineType → Input<String>?
The name of a Google Compute Engine machine type If unspecified, the default machine type is e2-medium.
final
metadata → Input<Map<String, String>>?
The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp [a-zA-Z0-9-_]+ and be less than 128 bytes in length. These are reflected as part of a URL in the metadata server. Additionally, to avoid ambiguity, keys must not conflict with any other metadata keys for the project or be one of the reserved keys: - "cluster-location" - "cluster-name" - "cluster-uid" - "configure-sh" - "containerd-configure-sh" - "enable-os-login" - "gci-ensure-gke-docker" - "gci-metrics-enabled" - "gci-update-strategy" - "instance-template" - "kube-env" - "startup-script" - "user-data" - "disable-address-manager" - "windows-startup-script-ps1" - "common-psm1" - "k8s-node-setup-psm1" - "install-ssh-psm1" - "user-profile-psm1" Values are free-form strings, and only have meaning as interpreted by the image running in the instance. The only restriction placed on them is that each value's size must be less than or equal to 32 KB. The total size of all keys and values must be less than 512 KB.
final
minCpuPlatform → Input<String>?
Minimum CPU platform to be used by this instance. The instance may be scheduled on the specified or newer CPU platform. Applicable values are the friendly names of CPU platforms, such as minCpuPlatform: "Intel Haswell" or minCpuPlatform: "Intel Sandy Bridge". For more information, read how to specify min CPU platform
final
nodeGroup → Input<String>?
Setting this field will assign instances of this pool to run on the specified node group. This is useful for running workloads on sole tenant nodes.
final
oauthScopes → Input<List<String>>?
The set of Google API scopes to be made available on all of the node VMs under the "default" service account. The following scopes are recommended, but not required, and by default are not included: * https://www.googleapis.com/auth/compute is required for mounting persistent storage on your nodes. * https://www.googleapis.com/auth/devstorage.read_only is required for communicating with gcr.io (the Google Container Registry). If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added.
final
preemptible → Input<bool>?
Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more information about preemptible VM instances.
final
reservationAffinity → Input<ReservationAffinity>?
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
final
resourceLabels → Input<Map<String, String>>?
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
final
resourceManagerTags → Input<ResourceManagerTags>?
A map of resource manager tag keys and values to be attached to the nodes.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
sandboxConfig → Input<SandboxConfig>?
Sandbox configuration for this node.
final
serviceAccount → Input<String>?
The Google Cloud Platform Service Account to be used by the node VMs. Specify the email address of the Service Account; otherwise, if no Service Account is specified, the "default" service account is used.
final
shieldedInstanceConfig → Input<ShieldedInstanceConfig>?
Shielded Instance options.
final
soleTenantConfig → Input<SoleTenantConfig>?
Parameters for node pools to be backed by shared sole tenant node groups.
final
spot → Input<bool>?
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
final
tags → Input<List<String>>?
The list of instance tags applied to all nodes. Tags are used to identify valid sources or targets for network firewalls and are specified by the client during cluster or node pool creation. Each tag within the list must comply with RFC1035.
final
taints → Input<List<NodeTaint>>?
List of kubernetes taints to be applied to each node. For more information, including usage and the valid values, see: https://kubernetes.io/docs/concepts/configuration/taint-and-toleration/
final
windowsNodeConfig → Input<WindowsNodeConfig>?
Parameters that can be configured on Windows nodes.
final
workloadMetadataConfig → Input<WorkloadMetadataConfig>?
The workload metadata configuration for this node.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited