Parameters that describe the nodes in a cluster.
GKE Autopilot clusters do not recognize parameters in NodeConfig
. Use AutoprovisioningNodePoolDefaults
instead.
{ "machineType": string, "diskSizeGb": integer, "oauthScopes": [ string ], "serviceAccount": string, "metadata": { string: string, ... }, "imageType": string, "labels": { string: string, ... }, "localSsdCount": integer, "tags": [ string ], "preemptible": boolean, "accelerators": [ { object (FieldsAcceleratorConfig
) } ], "sandboxConfig": { object (SandboxConfig
) }, "nodeGroup": string, "reservationAffinity": { object (ReservationAffinity
) }, "diskType": string, "minCpuPlatform": string, "workloadMetadataConfig": { object (WorkloadMetadataConfig
) }, "taints": [ { object (NodeTaint
) } ], "bootDiskKmsKey": string, "shieldedInstanceConfig": { object (ShieldedInstanceConfig
) }, "linuxNodeConfig": { object (LinuxNodeConfig
) }, "kubeletConfig": { object (NodeKubeletConfig
) }, "ephemeralStorageConfig": { object (EphemeralStorageConfig
) }, "gcfsConfig": { object (GcfsConfig
) }, "advancedMachineFeatures": { object (AdvancedMachineFeatures
) }, "gvnic": { object (VirtualNIC
) }, "spot": boolean, "confidentialNodes": { object (ConfidentialNodes
) }, "resourceLabels": { string: string, ... }, "loggingConfig": { object (NodePoolLoggingConfig
) }, "windowsNodeConfig": { object (WindowsNodeConfig
) }, "localNvmeSsdBlockConfig": { object (LocalNvmeSsdBlockConfig
) }, "ephemeralStorageLocalSsdConfig": { object (EphemeralStorageLocalSsdConfig
) }, "soleTenantConfig": { object (SoleTenantConfig
) }, "containerdConfig": { object (ContainerdConfig
) }, "hostMaintenancePolicy": { object (HostMaintenancePolicy
) }, "resourceManagerTags": { object (ResourceManagerTags
) }, "enableConfidentialStorage": boolean, "secondaryBootDisks": [ { object (SecondaryBootDisk
) } ], "storagePools": [ string ], "maxRunDuration": string, "effectiveCgroupMode": enum (EffectiveCgroupMode
), "fastSocket": { object (FastSocket
) }, "secondaryBootDiskUpdateStrategy": { object (SecondaryBootDiskUpdateStrategy
) }, "localSsdEncryptionMode": enum (LocalSsdEncryptionMode
), "flexStart": boolean }
machineType
string
The name of a Google Compute Engine machine type.
If unspecified, the default machine type is e2-medium
.
diskSizeGb
integer
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.
oauthScopes[]
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.
serviceAccount
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
map (key: string, value: 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:
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.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
imageType
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://{$universe.dns_names.final_documentation_domain}/kubernetes-engine/docs/concepts/node-images for available image types.
labels
map (key: string, value: 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/
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
localSsdCount
integer
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://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
tags[]
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
boolean
Whether the nodes are created as preemptible VM instances. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/instances/preemptible for more information about preemptible VM instances.
accelerators[]
object (
AcceleratorConfig
)
A list of hardware accelerators to be attached to each node. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/gpus for more information about support for GPUs.
sandboxConfig
object (
SandboxConfig
)
Sandbox configuration for this node.
nodeGroup
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.
reservationAffinity
object (
ReservationAffinity
)
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
diskType
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'
minCpuPlatform
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.
workloadMetadataConfig
object (
WorkloadMetadataConfig
)
The workload metadata configuration for this node.
taints[]
object (
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/
bootDiskKmsKey
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://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/customer-managed-encryption
shieldedInstanceConfig
object (
ShieldedInstanceConfig
)
Shielded Instance options.
linuxNodeConfig
object (
LinuxNodeConfig
)
Parameters that can be configured on Linux nodes.
kubeletConfig
object (
NodeKubeletConfig
)
Node kubelet configs.
ephemeralStorageConfig
object (
EphemeralStorageConfig
)
Parameters for the ephemeral storage filesystem. If unspecified, ephemeral storage is backed by the boot disk.
gcfsConfig
object (
GcfsConfig
)
GCFS (Google Container File System) configs.
advancedMachineFeatures
object (
AdvancedMachineFeatures
)
Advanced features for the Compute Engine VM.
gvnic
object (
VirtualNIC
)
Enable or disable gvnic on the node pool.
spot
boolean
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
confidentialNodes
object (
ConfidentialNodes
)
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
resourceLabels
map (key: string, value: string)
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
An object containing a list of "key": value
pairs. Example: { "name": "wrench", "mass": "1.3kg", "count": "3" }
.
loggingConfig
object (
NodePoolLoggingConfig
)
Logging configuration.
windowsNodeConfig
object (
WindowsNodeConfig
)
Parameters that can be configured on Windows nodes.
localNvmeSsdBlockConfig
object (
LocalNvmeSsdBlockConfig
)
Parameters for using raw-block Local NVMe SSDs.
ephemeralStorageLocalSsdConfig
object (
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 ephemeralStorageConfig
soleTenantConfig
object (
SoleTenantConfig
)
Parameters for node pools to be backed by shared sole tenant node groups.
containerdConfig
object (
ContainerdConfig
)
Parameters for containerd customization.
hostMaintenancePolicy
object (
HostMaintenancePolicy
)
HostMaintenancePolicy contains the desired maintenance policy for the Google Compute Engine hosts.
resourceManagerTags
object (
ResourceManagerTags
)
A map of resource manager tag keys and values to be attached to the nodes.
enableConfidentialStorage
boolean
Optional. Reserved for future use.
secondaryBootDisks[]
object (
SecondaryBootDisk
)
List of secondary boot disks attached to the nodes.
storagePools[]
string
List of Storage Pools where boot disks are provisioned.
maxRunDuration
string (
Duration
format)
The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
A duration in seconds with up to nine fractional digits, ending with 's
'. Example: "3.5s"
.
effectiveCgroupMode
enum (
EffectiveCgroupMode
)
Output only. effectiveCgroupMode 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.
fastSocket
object (
FastSocket
)
Enable or disable NCCL fast socket for the node pool.
secondaryBootDiskUpdateStrategy
object (
SecondaryBootDiskUpdateStrategy
)
Secondary boot disk update strategy.
localSsdEncryptionMode
enum (
LocalSsdEncryptionMode
)
Specifies which method should be used for encrypting the Local SSDs attached to the node.
flexStart
boolean
Flex Start flag for enabling Flex Start VM.
AcceleratorConfigAcceleratorConfig represents a Hardware Accelerator request.
JSON representation{ "acceleratorCount": string, "acceleratorType": string, "gpuPartitionSize": string, "maxTimeSharedClientsPerGpu": string, "gpuSharingConfig": { object (FieldsGPUSharingConfig
) }, "gpuDriverInstallationConfig": { object (GPUDriverInstallationConfig
) } }
acceleratorCount
string (int64 format)
The number of the accelerator cards exposed to an instance.
acceleratorType
string
The accelerator type resource name. List of supported accelerators here
gpuPartitionSize
string
Size of partitions to create on the GPU. Valid values are described in the NVIDIA mig user guide.
gpuSharingConfig
object (
GPUSharingConfig
)
The configuration for GPU sharing options.
gpuDriverInstallationConfig
object (
GPUDriverInstallationConfig
)
The configuration for auto installation of GPU driver.
GPUSharingConfigGPUSharingConfig represents the GPU sharing configuration for Hardware Accelerators.
JSON representation{
"maxSharedClientsPerGpu": string,
"gpuSharingStrategy": enum (GPUSharingStrategy
)
}
Fields gpuSharingStrategy
enum (
GPUSharingStrategy
)
The type of GPU sharing strategy to enable on the GPU node.
GPUSharingStrategyThe type of GPU sharing strategy currently provided.
EnumsGPU_SHARING_STRATEGY_UNSPECIFIED
Default value. TIME_SHARING
GPUs are time-shared between containers. MPS
GPUs are shared between containers with NVIDIA MPS. GPUDriverInstallationConfig
GPUDriverInstallationConfig specifies the version of GPU driver to be auto installed.
FieldsgpuDriverVersion
enum (
GPUDriverVersion
)
Mode for how the GPU driver is installed.
GPUDriverVersionThe GPU driver version to install.
EnumsGPU_DRIVER_VERSION_UNSPECIFIED
Default value is to not install any GPU driver. INSTALLATION_DISABLED
Disable GPU driver auto installation and needs manual installation DEFAULT
"Default" GPU driver in COS and Ubuntu. LATEST
"Latest" GPU driver in COS. SandboxConfig
SandboxConfig contains configurations of the sandbox to use for the node.
JSON representation{
"sandboxType": string,
"type": enum (Type
)
}
Fields sandboxType
(deprecated)
string
This item is deprecated!
Type of the sandbox to use for the node (e.g. 'gvisor')
type
enum (
Type
)
Type of the sandbox to use for the node.
TypePossible types of sandboxes.
EnumsUNSPECIFIED
Default value. This should not be used. GVISOR
Run sandbox using gvisor. ReservationAffinity
ReservationAffinity is the configuration of desired reservation which instances could take capacity from.
JSON representation{
"consumeReservationType": enum (Type
),
"key": string,
"values": [
string
]
}
Fields consumeReservationType
enum (
Type
)
Corresponds to the type of reservation consumption.
key
string
Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "compute.googleapis.com/reservation-name" as the key and specify the name of your reservation as its value.
values[]
string
Corresponds to the label value(s) of reservation resource(s).
TypeIndicates whether to consume capacity from a reservation or not.
EnumsUNSPECIFIED
Default value. This should not be used. NO_RESERVATION
Do not consume from any reserved capacity. ANY_RESERVATION
Consume any reservation available. SPECIFIC_RESERVATION
Must consume from a specific reservation. Must specify key value fields for specifying the reservations.
WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.
JSON representation{ "nodeMetadata": enum (NodeMetadata
), "mode": enum (Mode
) }
NodeMetadata is the configuration for if and how to expose the node metadata to the workload running on the node.
ModeMode is the configuration for how to expose metadata to workloads running on the node.
EnumsMODE_UNSPECIFIED
Not set. GCE_METADATA
Expose all Compute Engine metadata to pods. GKE_METADATA
Run the GKE Metadata Server on this node. The GKE Metadata Server exposes a metadata API to workloads that is compatible with the V1 Compute Metadata APIs exposed by the Compute Engine and App Engine Metadata Servers. This feature can only be enabled if Workload Identity is enabled at the cluster level. NodeTaint
Kubernetes taint is composed of three fields: key, value, and effect. Effect can only be one of three types: NoSchedule, PreferNoSchedule or NoExecute.
See here for more information, including usage and the valid values.
JSON representation{
"key": string,
"value": string,
"effect": enum (Effect
)
}
Fields key
string
Key for taint.
value
string
Value for taint.
effect
enum (
Effect
)
Effect for taint.
EffectPossible values for Effect in taint.
EnumsEFFECT_UNSPECIFIED
Not set NO_SCHEDULE
NoSchedule PREFER_NO_SCHEDULE
PreferNoSchedule NO_EXECUTE
NoExecute EphemeralStorageConfig
EphemeralStorageConfig contains configuration for the ephemeral storage filesystem.
JSON representation{ "localSsdCount": integer }Fields
localSsdCount
integer
Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information.
A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
AdvancedMachineFeaturesSpecifies options for controlling advanced machine features.
JSON representation{
"threadsPerCore": string,
"enableNestedVirtualization": boolean,
"performanceMonitoringUnit": enum (PerformanceMonitoringUnit
)
}
Fields threadsPerCore
string (int64 format)
The number of threads per physical core. To disable simultaneous multithreading (SMT) set this to 1. If unset, the maximum number of threads supported per core by the underlying processor is assumed.
enableNestedVirtualization
boolean
Whether or not to enable nested virtualization (defaults to false).
performanceMonitoringUnit
enum (
PerformanceMonitoringUnit
)
Type of Performance Monitoring Unit (PMU) requested on node pool instances. If unset, PMU will not be available to the node.
PerformanceMonitoringUnitLevel of PMU access
EnumsPERFORMANCE_MONITORING_UNIT_UNSPECIFIED
PMU not enabled. ARCHITECTURAL
Architecturally defined non-LLC events. STANDARD
Most documented core/L2 events. ENHANCED
Most documented core/L2 and LLC events. VirtualNIC
Configuration of gVNIC feature.
JSON representation{ "enabled": boolean }Fields
enabled
boolean
Whether gVNIC features are enabled in the node pool.
FastSocketConfiguration of Fast Socket feature.
JSON representation{ "enabled": boolean }Fields
enabled
boolean
Whether Fast Socket features are enabled in the node pool.
WindowsNodeConfigParameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings.
JSON representation{
"osVersion": enum (OSVersion
)
}
Fields osVersion
enum (
OSVersion
)
OSVersion specifies the Windows node config to be used on the node.
OSVersionPossible OS version that can be used.
EnumsOS_VERSION_UNSPECIFIED
When OSVersion is not specified OS_VERSION_LTSC2019
LTSC2019 specifies to use LTSC2019 as the Windows Servercore Base Image. OS_VERSION_LTSC2022
LTSC2022 specifies to use LTSC2022 as the Windows Servercore Base Image. LocalNvmeSsdBlockConfig
LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs
JSON representation{ "localSsdCount": integer }EphemeralStorageLocalSsdConfig
EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs.
JSON representation{ "localSsdCount": integer, "dataCacheCount": integer }Fields
localSsdCount
integer
Number of local SSDs to use to back ephemeral storage. Uses NVMe interfaces.
A zero (or unset) value has different meanings depending on machine type being used: 1. For pre-Gen3 machines, which support flexible numbers of local ssds, zero (or unset) means to disable using local SSDs as ephemeral storage. The limit for this value is dependent upon the maximum number of disk available on a machine per zone. See: https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd for more information. 2. For Gen3 machines which dictate a specific number of local ssds, zero (or unset) means to use the default number of local ssds that goes with that machine type. For example, for a c3-standard-8-lssd machine, 2 local ssds would be provisioned. For c3-standard-8 (which doesn't support local ssds), 0 will be provisioned. See https://{$universe.dns_names.final_documentation_domain}/compute/docs/disks/local-ssd#choose_number_local_ssds for more info.
dataCacheCount
integer
Number of local SSDs to use for GKE Data Cache.
SoleTenantConfigSoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool.
JSON representation{
"nodeAffinities": [
{
object (NodeAffinity
)
}
]
}
Fields nodeAffinities[]
object (
NodeAffinity
)
NodeAffinities used to match to a shared sole tenant node group.
NodeAffinitySpecifies the NodeAffinity key, values, and affinity operator according to shared sole tenant node group affinities.
JSON representation{
"key": string,
"operator": enum (Operator
),
"values": [
string
]
}
Fields key
string
Key for NodeAffinity.
operator
enum (
Operator
)
Operator for NodeAffinity.
values[]
string
Values for NodeAffinity.
OperatorOperator allows user to specify affinity or anti-affinity for the given key values.
EnumsOPERATOR_UNSPECIFIED
Invalid or unspecified affinity operator. IN
Affinity operator. NOT_IN
Anti-affinity operator. SecondaryBootDisk
SecondaryBootDisk represents a persistent disk attached to a node with special configurations based on its mode.
JSON representation{
"mode": enum (Mode
),
"diskImage": string
}
Fields mode
enum (
Mode
)
Disk mode (container image cache, etc.)
diskImage
string
Fully-qualified resource ID for an existing disk image.
ModeMode specifies how the secondary boot disk will be used. This triggers mode-specified logic in the control plane.
EnumsMODE_UNSPECIFIED
MODE_UNSPECIFIED is when mode is not set. CONTAINER_IMAGE_CACHE
CONTAINER_IMAGE_CACHE is for using the secondary boot disk as a container image cache. SecondaryBootDiskUpdateStrategy
This type has no fields.
SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks.
LocalSsdEncryptionModeLocalSsdEncryptionMode specifies the method used for encrypting the Local SSDs attached to the node.
EnumsLOCAL_SSD_ENCRYPTION_MODE_UNSPECIFIED
The given node will be encrypted using keys managed by Google infrastructure and the keys will be deleted when the node is deleted. STANDARD_ENCRYPTION
The given node will be encrypted using keys managed by Google infrastructure and the keys will be deleted when the node is deleted. EPHEMERAL_KEY_ENCRYPTION
The given node will opt-in for using ephemeral key for encryption of Local SSDs. The Local SSDs will not be able to recover data in case of node crash. EffectiveCgroupMode
Possible effective cgroup modes for the node.
EnumsEFFECTIVE_CGROUP_MODE_UNSPECIFIED
EFFECTIVE_CGROUP_MODE_UNSPECIFIED means the cgroup configuration for the node pool is unspecified, i.e. the node pool is a Windows node pool. EFFECTIVE_CGROUP_MODE_V1
CGROUP_MODE_V1 means the node pool is configured to use cgroupv1 for the cgroup configuration. EFFECTIVE_CGROUP_MODE_V2
CGROUP_MODE_V2 means the node pool is configured to use cgroupv2 for the cgroup configuration.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4