Struct NodeConfig

#[non_exhaustive]
pub struct NodeConfig {

    pub machine_type: String,
    pub disk_size_gb: i32,
    pub oauth_scopes: Vec<String>,
    pub service_account: String,
    pub metadata: HashMap<String, String>,
    pub image_type: String,
    pub labels: HashMap<String, String>,
    pub local_ssd_count: i32,
    pub tags: Vec<String>,
    pub preemptible: bool,
    pub accelerators: Vec<AcceleratorConfig>,
    pub disk_type: String,
    pub min_cpu_platform: String,
    pub workload_metadata_config: Option<WorkloadMetadataConfig>,
    pub taints: Vec<NodeTaint>,
    pub sandbox_config: Option<SandboxConfig>,
    pub node_group: String,
    pub reservation_affinity: Option<ReservationAffinity>,
    pub shielded_instance_config: Option<ShieldedInstanceConfig>,
    pub linux_node_config: Option<LinuxNodeConfig>,
    pub kubelet_config: Option<NodeKubeletConfig>,
    pub boot_disk_kms_key: String,
    pub gcfs_config: Option<GcfsConfig>,
    pub advanced_machine_features: Option<AdvancedMachineFeatures>,
    pub gvnic: Option<VirtualNIC>,
    pub spot: bool,
    pub confidential_nodes: Option<ConfidentialNodes>,
    pub fast_socket: Option<FastSocket>,
    pub resource_labels: HashMap<String, String>,
    pub logging_config: Option<NodePoolLoggingConfig>,
    pub windows_node_config: Option<WindowsNodeConfig>,
    pub local_nvme_ssd_block_config: Option<LocalNvmeSsdBlockConfig>,
    pub ephemeral_storage_local_ssd_config: Option<EphemeralStorageLocalSsdConfig>,
    pub sole_tenant_config: Option<SoleTenantConfig>,
    pub containerd_config: Option<ContainerdConfig>,
    pub resource_manager_tags: Option<ResourceManagerTags>,
    pub enable_confidential_storage: bool,
    pub secondary_boot_disks: Vec<SecondaryBootDisk>,
    pub storage_pools: Vec<String>,
    pub secondary_boot_disk_update_strategy: Option<SecondaryBootDiskUpdateStrategy>,
    pub local_ssd_encryption_mode: Option<LocalSsdEncryptionMode>,
    pub effective_cgroup_mode: EffectiveCgroupMode,
}

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

machine_type: String

The name of a Google Compute Engine machine type

If unspecified, the default machine type is e2-medium.

disk_size_gb: i32

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.

oauth_scopes: Vec<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.

service_account: 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.

metadata: HashMap<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.

image_type: 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.

labels: HashMap<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/

local_ssd_count: i32

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.

tags: Vec<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.

preemptible: 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.

accelerators: Vec<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.

disk_type: 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’

min_cpu_platform: 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

workload_metadata_config: Option<WorkloadMetadataConfig>

The workload metadata configuration for this node.

taints: Vec<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/

sandbox_config: Option<SandboxConfig>

Sandbox configuration for this node.

node_group: 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.

reservation_affinity: Option<ReservationAffinity>

The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.

shielded_instance_config: Option<ShieldedInstanceConfig>

Shielded Instance options.

linux_node_config: Option<LinuxNodeConfig>

Parameters that can be configured on Linux nodes.

kubelet_config: Option<NodeKubeletConfig>

Node kubelet configs.

boot_disk_kms_key: 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

gcfs_config: Option<GcfsConfig>

Google Container File System (image streaming) configs.

advanced_machine_features: Option<AdvancedMachineFeatures>

Advanced features for the Compute Engine VM.

gvnic: Option<VirtualNIC>

Enable or disable gvnic in the node pool.

spot: bool

Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.

confidential_nodes: Option<ConfidentialNodes>

Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.

fast_socket: Option<FastSocket>

Enable or disable NCCL fast socket for the node pool.

resource_labels: HashMap<String, String>

The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

logging_config: Option<NodePoolLoggingConfig>

Logging configuration.

windows_node_config: Option<WindowsNodeConfig>

Parameters that can be configured on Windows nodes.

local_nvme_ssd_block_config: Option<LocalNvmeSsdBlockConfig>

Parameters for using raw-block Local NVMe SSDs.

ephemeral_storage_local_ssd_config: Option<EphemeralStorageLocalSsdConfig>

Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.

sole_tenant_config: Option<SoleTenantConfig>

Parameters for node pools to be backed by shared sole tenant node groups.

containerd_config: Option<ContainerdConfig>

Parameters for containerd customization.

resource_manager_tags: Option<ResourceManagerTags>

A map of resource manager tag keys and values to be attached to the nodes.

enable_confidential_storage: bool

Optional. Reserved for future use.

secondary_boot_disks: Vec<SecondaryBootDisk>

List of secondary boot disks attached to the nodes.

storage_pools: Vec<String>

List of Storage Pools where boot disks are provisioned.

secondary_boot_disk_update_strategy: Option<SecondaryBootDiskUpdateStrategy>

Secondary boot disk update strategy.

local_ssd_encryption_mode: Option<LocalSsdEncryptionMode>

Specifies which method should be used for encrypting the Local SSDs attahced to the node.

effective_cgroup_mode: EffectiveCgroupMode

Output only. effective_cgroup_mode is the cgroup mode actually used by the node pool. It is determined by the cgroup mode specified in the LinuxNodeConfig or the default cgroup mode based on the cluster creation version.

Implementations

impl NodeConfig

pub fn set_machine_type<T: Into<String>>(self, v: T) -> Self

Sets the value of machine_type.

pub fn set_disk_size_gb<T: Into<i32>>(self, v: T) -> Self

Sets the value of disk_size_gb.

pub fn set_service_account<T: Into<String>>(self, v: T) -> Self

Sets the value of service_account.

pub fn set_image_type<T: Into<String>>(self, v: T) -> Self

Sets the value of image_type.

pub fn set_local_ssd_count<T: Into<i32>>(self, v: T) -> Self

Sets the value of local_ssd_count.

pub fn set_preemptible<T: Into<bool>>(self, v: T) -> Self

Sets the value of preemptible.

pub fn set_disk_type<T: Into<String>>(self, v: T) -> Self

Sets the value of disk_type.

pub fn set_min_cpu_platform<T: Into<String>>(self, v: T) -> Self

Sets the value of min_cpu_platform.

pub fn set_workload_metadata_config<T: Into<Option<WorkloadMetadataConfig>>>( self, v: T, ) -> Self

Sets the value of workload_metadata_config.

pub fn set_sandbox_config<T: Into<Option<SandboxConfig>>>(self, v: T) -> Self

Sets the value of sandbox_config.

pub fn set_node_group<T: Into<String>>(self, v: T) -> Self

Sets the value of node_group.

pub fn set_reservation_affinity<T: Into<Option<ReservationAffinity>>>( self, v: T, ) -> Self

Sets the value of reservation_affinity.

pub fn set_shielded_instance_config<T: Into<Option<ShieldedInstanceConfig>>>( self, v: T, ) -> Self

Sets the value of shielded_instance_config.

pub fn set_linux_node_config<T: Into<Option<LinuxNodeConfig>>>( self, v: T, ) -> Self

Sets the value of linux_node_config.

pub fn set_kubelet_config<T: Into<Option<NodeKubeletConfig>>>( self, v: T, ) -> Self

Sets the value of kubelet_config.

pub fn set_boot_disk_kms_key<T: Into<String>>(self, v: T) -> Self

Sets the value of boot_disk_kms_key.

pub fn set_gcfs_config<T: Into<Option<GcfsConfig>>>(self, v: T) -> Self

Sets the value of gcfs_config.

pub fn set_advanced_machine_features<T: Into<Option<AdvancedMachineFeatures>>>( self, v: T, ) -> Self

Sets the value of advanced_machine_features.

pub fn set_gvnic<T: Into<Option<VirtualNIC>>>(self, v: T) -> Self

Sets the value of gvnic.

pub fn set_spot<T: Into<bool>>(self, v: T) -> Self

Sets the value of spot.

pub fn set_confidential_nodes<T: Into<Option<ConfidentialNodes>>>( self, v: T, ) -> Self

Sets the value of confidential_nodes.

pub fn set_fast_socket<T: Into<Option<FastSocket>>>(self, v: T) -> Self

Sets the value of fast_socket.

pub fn set_logging_config<T: Into<Option<NodePoolLoggingConfig>>>( self, v: T, ) -> Self

Sets the value of logging_config.

pub fn set_windows_node_config<T: Into<Option<WindowsNodeConfig>>>( self, v: T, ) -> Self

Sets the value of windows_node_config.

pub fn set_local_nvme_ssd_block_config<T: Into<Option<LocalNvmeSsdBlockConfig>>>( self, v: T, ) -> Self

Sets the value of local_nvme_ssd_block_config.

pub fn set_ephemeral_storage_local_ssd_config<T: Into<Option<EphemeralStorageLocalSsdConfig>>>( self, v: T, ) -> Self

Sets the value of ephemeral_storage_local_ssd_config.

pub fn set_sole_tenant_config<T: Into<Option<SoleTenantConfig>>>( self, v: T, ) -> Self

Sets the value of sole_tenant_config.

pub fn set_containerd_config<T: Into<Option<ContainerdConfig>>>( self, v: T, ) -> Self

Sets the value of containerd_config.

pub fn set_resource_manager_tags<T: Into<Option<ResourceManagerTags>>>( self, v: T, ) -> Self

Sets the value of resource_manager_tags.

pub fn set_enable_confidential_storage<T: Into<bool>>(self, v: T) -> Self

Sets the value of enable_confidential_storage.

pub fn set_secondary_boot_disk_update_strategy<T: Into<Option<SecondaryBootDiskUpdateStrategy>>>( self, v: T, ) -> Self

Sets the value of secondary_boot_disk_update_strategy.

pub fn set_local_ssd_encryption_mode<T: Into<Option<LocalSsdEncryptionMode>>>( self, v: T, ) -> Self

Sets the value of local_ssd_encryption_mode.

pub fn set_effective_cgroup_mode<T: Into<EffectiveCgroupMode>>( self, v: T, ) -> Self

Sets the value of effective_cgroup_mode.

pub fn set_oauth_scopes<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of oauth_scopes.

pub fn set_tags<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of tags.

pub fn set_accelerators<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<AcceleratorConfig>,

Sets the value of accelerators.

pub fn set_taints<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<NodeTaint>,

Sets the value of taints.

pub fn set_secondary_boot_disks<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<SecondaryBootDisk>,

Sets the value of secondary_boot_disks.

pub fn set_storage_pools<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<String>,

Sets the value of storage_pools.

pub fn set_metadata<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of metadata.

pub fn set_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of labels.

pub fn set_resource_labels<T, K, V>(self, v: T) -> Self

where T: IntoIterator<Item = (K, V)>, K: Into<String>, V: Into<String>,

Sets the value of resource_labels.

Trait Implementations

impl Clone for NodeConfig

fn clone(&self) -> NodeConfig

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for NodeConfig

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for NodeConfig

fn default() -> NodeConfig

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for NodeConfig

where NodeConfig: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for NodeConfig

fn typename() -> &'static str

The typename of this message.

impl PartialEq for NodeConfig

fn eq(&self, other: &NodeConfig) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for NodeConfig

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for NodeConfig