Class NodeConfig

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

Inheritance

object

NodeConfig

Implements

IDirectResponseSchema

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Google.Apis.Container.v1beta1.Data

Assembly: Google.Apis.Container.v1beta1.dll

Syntax

public class NodeConfig : IDirectResponseSchema

Properties

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.

Declaration

[JsonProperty("accelerators")]
public virtual IList<AcceleratorConfig> Accelerators { get; set; }

Property Value

Type	Description
IList<AcceleratorConfig>

AdvancedMachineFeatures

Advanced features for the Compute Engine VM.

Declaration

[JsonProperty("advancedMachineFeatures")]
public virtual AdvancedMachineFeatures AdvancedMachineFeatures { get; set; }

Property Value

Type	Description
AdvancedMachineFeatures

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

Declaration

[JsonProperty("bootDiskKmsKey")]
public virtual string BootDiskKmsKey { get; set; }

Property Value

Type	Description
string

ConfidentialNodes

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

Declaration

[JsonProperty("confidentialNodes")]
public virtual ConfidentialNodes ConfidentialNodes { get; set; }

Property Value

Type	Description
ConfidentialNodes

ContainerdConfig

Parameters for containerd customization.

Declaration

[JsonProperty("containerdConfig")]
public virtual ContainerdConfig ContainerdConfig { get; set; }

Property Value

Type	Description
ContainerdConfig

DiskSizeGb

Size of the disk attached to each node, specified in GB. The smallest allowed disk size is 10GB. TODO(b/395671893) - Deprecate disk_size_gb and disk_type fields. If unspecified, the default disk size is 100GB.

Declaration

[JsonProperty("diskSizeGb")]
public virtual int? DiskSizeGb { get; set; }

Property Value

Type	Description
int?

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'

Declaration

[JsonProperty("diskType")]
public virtual string DiskType { get; set; }

Property Value

Type	Description
string

ETag

The ETag of the item.

Declaration

public virtual string ETag { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("effectiveCgroupMode")]
public virtual string EffectiveCgroupMode { get; set; }

Property Value

Type	Description
string

EnableConfidentialStorage

Optional. Reserved for future use.

Declaration

[JsonProperty("enableConfidentialStorage")]
public virtual bool? EnableConfidentialStorage { get; set; }

Property Value

Type	Description
bool?

EphemeralStorageConfig

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

Declaration

[JsonProperty("ephemeralStorageConfig")]
public virtual EphemeralStorageConfig EphemeralStorageConfig { get; set; }

Property Value

Type	Description
EphemeralStorageConfig

EphemeralStorageLocalSsdConfig

Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. This field is functionally equivalent to the ephemeral_storage_config

Declaration

[JsonProperty("ephemeralStorageLocalSsdConfig")]
public virtual EphemeralStorageLocalSsdConfig EphemeralStorageLocalSsdConfig { get; set; }

Property Value

Type	Description
EphemeralStorageLocalSsdConfig

FastSocket

Enable or disable NCCL fast socket for the node pool.

Declaration

[JsonProperty("fastSocket")]
public virtual FastSocket FastSocket { get; set; }

Property Value

Type	Description
FastSocket

FlexStart

Flex Start flag for enabling Flex Start VM.

Declaration

[JsonProperty("flexStart")]
public virtual bool? FlexStart { get; set; }

Property Value

Type	Description
bool?

GcfsConfig

GCFS (Google Container File System) configs.

Declaration

[JsonProperty("gcfsConfig")]
public virtual GcfsConfig GcfsConfig { get; set; }

Property Value

Type	Description
GcfsConfig

Gvnic

Enable or disable gvnic on the node pool.

Declaration

[JsonProperty("gvnic")]
public virtual VirtualNIC Gvnic { get; set; }

Property Value

Type	Description
VirtualNIC

HostMaintenancePolicy

HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.

Declaration

[JsonProperty("hostMaintenancePolicy")]
public virtual HostMaintenancePolicy HostMaintenancePolicy { get; set; }

Property Value

Type	Description
HostMaintenancePolicy

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.

Declaration

[JsonProperty("imageType")]
public virtual string ImageType { get; set; }

Property Value

Type	Description
string

KubeletConfig

Node kubelet configs.

Declaration

[JsonProperty("kubeletConfig")]
public virtual NodeKubeletConfig KubeletConfig { get; set; }

Property Value

Type	Description
NodeKubeletConfig

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/

Declaration

[JsonProperty("labels")]
public virtual IDictionary<string, string> Labels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

LinuxNodeConfig

Parameters that can be configured on Linux nodes.

Declaration

[JsonProperty("linuxNodeConfig")]
public virtual LinuxNodeConfig LinuxNodeConfig { get; set; }

Property Value

Type	Description
LinuxNodeConfig

LocalNvmeSsdBlockConfig

Parameters for using raw-block Local NVMe SSDs.

Declaration

[JsonProperty("localNvmeSsdBlockConfig")]
public virtual LocalNvmeSsdBlockConfig LocalNvmeSsdBlockConfig { get; set; }

Property Value

Type	Description
LocalNvmeSsdBlockConfig

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.

Declaration

[JsonProperty("localSsdCount")]
public virtual int? LocalSsdCount { get; set; }

Property Value

Type	Description
int?

LocalSsdEncryptionMode

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

Declaration

[JsonProperty("localSsdEncryptionMode")]
public virtual string LocalSsdEncryptionMode { get; set; }

Property Value

Type	Description
string

LoggingConfig

Logging configuration.

Declaration

[JsonProperty("loggingConfig")]
public virtual NodePoolLoggingConfig LoggingConfig { get; set; }

Property Value

Type	Description
NodePoolLoggingConfig

MachineType

The name of a Google Compute Engine machine type. If unspecified, the default machine type is e2-medium.

Declaration

[JsonProperty("machineType")]
public virtual string MachineType { get; set; }

Property Value

Type	Description
string

MaxRunDuration

The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.

Declaration

[JsonProperty("maxRunDuration")]
public virtual object MaxRunDuration { get; set; }

Property Value

Type	Description
object

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-oslogin" - "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.

Declaration

[JsonProperty("metadata")]
public virtual IDictionary<string, string> Metadata { get; set; }

Property Value

Type	Description
IDictionary<string, string>

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.

Declaration

[JsonProperty("minCpuPlatform")]
public virtual string MinCpuPlatform { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("nodeGroup")]
public virtual string NodeGroup { get; set; }

Property Value

Type	Description
string

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.

Declaration

[JsonProperty("oauthScopes")]
public virtual IList<string> OauthScopes { get; set; }

Property Value

Type	Description
IList<string>

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.

Declaration

[JsonProperty("preemptible")]
public virtual bool? Preemptible { get; set; }

Property Value

Type	Description
bool?

ReservationAffinity

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

Declaration

[JsonProperty("reservationAffinity")]
public virtual ReservationAffinity ReservationAffinity { get; set; }

Property Value

Type	Description
ReservationAffinity

ResourceLabels

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

Declaration

[JsonProperty("resourceLabels")]
public virtual IDictionary<string, string> ResourceLabels { get; set; }

Property Value

Type	Description
IDictionary<string, string>

ResourceManagerTags

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

Declaration

[JsonProperty("resourceManagerTags")]
public virtual ResourceManagerTags ResourceManagerTags { get; set; }

Property Value

Type	Description
ResourceManagerTags

SandboxConfig

Sandbox configuration for this node.

Declaration

[JsonProperty("sandboxConfig")]
public virtual SandboxConfig SandboxConfig { get; set; }

Property Value

Type	Description
SandboxConfig

SecondaryBootDiskUpdateStrategy

Secondary boot disk update strategy.

Declaration

[JsonProperty("secondaryBootDiskUpdateStrategy")]
public virtual SecondaryBootDiskUpdateStrategy SecondaryBootDiskUpdateStrategy { get; set; }

Property Value

Type	Description
SecondaryBootDiskUpdateStrategy

SecondaryBootDisks

List of secondary boot disks attached to the nodes.

Declaration

[JsonProperty("secondaryBootDisks")]
public virtual IList<SecondaryBootDisk> SecondaryBootDisks { get; set; }

Property Value

Type	Description
IList<SecondaryBootDisk>

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.

Declaration

[JsonProperty("serviceAccount")]
public virtual string ServiceAccount { get; set; }

Property Value

Type	Description
string

ShieldedInstanceConfig

Shielded Instance options.

Declaration

[JsonProperty("shieldedInstanceConfig")]
public virtual ShieldedInstanceConfig ShieldedInstanceConfig { get; set; }

Property Value

Type	Description
ShieldedInstanceConfig

SoleTenantConfig

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

Declaration

[JsonProperty("soleTenantConfig")]
public virtual SoleTenantConfig SoleTenantConfig { get; set; }

Property Value

Type	Description
SoleTenantConfig

Spot

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

Declaration

[JsonProperty("spot")]
public virtual bool? Spot { get; set; }

Property Value

Type	Description
bool?

StoragePools

List of Storage Pools where boot disks are provisioned.

Declaration

[JsonProperty("storagePools")]
public virtual IList<string> StoragePools { get; set; }

Property Value

Type	Description
IList<string>

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/

Declaration

[JsonProperty("taints")]
public virtual IList<NodeTaint> Taints { get; set; }

Property Value

Type	Description
IList<NodeTaint>

WindowsNodeConfig

Parameters that can be configured on Windows nodes.

Declaration

[JsonProperty("windowsNodeConfig")]
public virtual WindowsNodeConfig WindowsNodeConfig { get; set; }

Property Value

Type	Description
WindowsNodeConfig

WorkloadMetadataConfig

The workload metadata configuration for this node.

Declaration

[JsonProperty("workloadMetadataConfig")]
public virtual WorkloadMetadataConfig WorkloadMetadataConfig { get; set; }

Property Value

Type	Description
WorkloadMetadataConfig

Implements

IDirectResponseSchema