Google Kubernetes Engine v1 API - Class NodeConfig (3.22.0)

public sealed class NodeConfig : IMessage<NodeConfig>, IEquatable<NodeConfig>, IDeepCloneable<NodeConfig>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Kubernetes Engine v1 API class NodeConfig.

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters in NodeConfig. Use [AutoprovisioningNodePoolDefaults][google.container.v1.AutoprovisioningNodePoolDefaults] instead.

Inheritance

object > NodeConfig

Implements

IMessage NodeConfig, IEquatable NodeConfig, IDeepCloneable NodeConfig, IBufferMessage, IMessage

Inherited Members

object.GetHashCode()

object.GetType()

object.ToString()

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Constructors

NodeConfig()

public NodeConfig()

NodeConfig(NodeConfig)

public NodeConfig(NodeConfig other)

Parameter
Name	Description
`other`	`NodeConfig`

Properties

Accelerators

public RepeatedField<AcceleratorConfig> Accelerators { get; }

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.

Property Value
Type	Description
`RepeatedFieldAcceleratorConfig`

AdvancedMachineFeatures

public AdvancedMachineFeatures AdvancedMachineFeatures { get; set; }

Advanced features for the Compute Engine VM.

Property Value
Type	Description
`AdvancedMachineFeatures`

BootDiskKmsKey

public string BootDiskKmsKey { get; set; }

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

Property Value
Type	Description
`string`

ConfidentialNodes

public ConfidentialNodes ConfidentialNodes { get; set; }

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

Property Value
Type	Description
`ConfidentialNodes`

DiskSizeGb

public int DiskSizeGb { get; set; }

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.

Property Value
Type	Description
`int`

DiskType

public string DiskType { get; set; }

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'

Property Value
Type	Description
`string`

EnableConfidentialStorage

public bool EnableConfidentialStorage { get; set; }

Optional. Reserved for future use.

Property Value
Type	Description
`bool`

EphemeralStorageLocalSsdConfig

public EphemeralStorageLocalSsdConfig EphemeralStorageLocalSsdConfig { get; set; }

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

Property Value
Type	Description
`EphemeralStorageLocalSsdConfig`

FastSocket

public FastSocket FastSocket { get; set; }

Enable or disable NCCL fast socket for the node pool.

Property Value
Type	Description
`FastSocket`

GcfsConfig

public GcfsConfig GcfsConfig { get; set; }

Google Container File System (image streaming) configs.

Property Value
Type	Description
`GcfsConfig`

Gvnic

public VirtualNIC Gvnic { get; set; }

Enable or disable gvnic in the node pool.

Property Value
Type	Description
`VirtualNIC`

ImageType

public string ImageType { get; set; }

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.

Property Value
Type	Description
`string`

KubeletConfig

public NodeKubeletConfig KubeletConfig { get; set; }

Node kubelet configs.

Property Value
Type	Description
`NodeKubeletConfig`

Labels

public MapField<string, string> Labels { get; }

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/

Property Value
Type	Description
`MapFieldstringstring`

LinuxNodeConfig

public LinuxNodeConfig LinuxNodeConfig { get; set; }

Parameters that can be configured on Linux nodes.

Property Value
Type	Description
`LinuxNodeConfig`

LocalNvmeSsdBlockConfig

public LocalNvmeSsdBlockConfig LocalNvmeSsdBlockConfig { get; set; }

Parameters for using raw-block Local NVMe SSDs.

Property Value
Type	Description
`LocalNvmeSsdBlockConfig`

LocalSsdCount

public int LocalSsdCount { get; set; }

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.

Property Value
Type	Description
`int`

LoggingConfig

public NodePoolLoggingConfig LoggingConfig { get; set; }

Logging configuration.

Property Value
Type	Description
`NodePoolLoggingConfig`

MachineType

public string MachineType { get; set; }

The name of a Google Compute Engine machine type

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

Property Value
Type	Description
`string`

Metadata

public MapField<string, string> Metadata { get; }

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.

Property Value
Type	Description
`MapFieldstringstring`

MinCpuPlatform

public string MinCpuPlatform { get; set; }

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

Property Value
Type	Description
`string`

NodeGroup

public string NodeGroup { get; set; }

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.

Property Value
Type	Description
`string`

OauthScopes

public RepeatedField<string> OauthScopes { get; }

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.

Property Value
Type	Description
`RepeatedFieldstring`

Preemptible

public bool Preemptible { get; set; }

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.

Property Value
Type	Description
`bool`

ReservationAffinity

public ReservationAffinity ReservationAffinity { get; set; }

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

Property Value
Type	Description
`ReservationAffinity`

ResourceLabels

public MapField<string, string> ResourceLabels { get; }

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

Property Value
Type	Description
`MapFieldstringstring`

ResourceManagerTags

public ResourceManagerTags ResourceManagerTags { get; set; }

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

Property Value
Type	Description
`ResourceManagerTags`

SandboxConfig

public SandboxConfig SandboxConfig { get; set; }

Sandbox configuration for this node.

Property Value
Type	Description
`SandboxConfig`

ServiceAccount

public string ServiceAccount { get; set; }

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.

Property Value
Type	Description
`string`

ShieldedInstanceConfig

public ShieldedInstanceConfig ShieldedInstanceConfig { get; set; }

Shielded Instance options.

Property Value
Type	Description
`ShieldedInstanceConfig`

SoleTenantConfig

public SoleTenantConfig SoleTenantConfig { get; set; }

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

Property Value
Type	Description
`SoleTenantConfig`

Spot

public bool Spot { get; set; }

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

Property Value
Type	Description
`bool`

Taints

public RepeatedField<NodeTaint> Taints { get; }

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/

Property Value
Type	Description
`RepeatedFieldNodeTaint`

WindowsNodeConfig

public WindowsNodeConfig WindowsNodeConfig { get; set; }

Parameters that can be configured on Windows nodes.

Property Value
Type	Description
`WindowsNodeConfig`

WorkloadMetadataConfig

public WorkloadMetadataConfig WorkloadMetadataConfig { get; set; }

The workload metadata configuration for this node.

Property Value
Type	Description
`WorkloadMetadataConfig`