- JSON representation
- AcceleratorConfig
- WorkloadMetadataConfig
- Mode
- NodeTaint
- Effect
- SandboxConfig
- Type
- ReservationAffinity
- Type
Parameters that describe the nodes in a cluster.
JSON representation | |
---|---|
{ "machineType": string, "diskSizeGb": integer, "oauthScopes": [ string ], "serviceAccount": string, "metadata": { string: string, ... }, "imageType": string, "labels": { string: string, ... }, "localSsdCount": integer, "tags": [ string ], "preemptible": boolean, "accelerators": [ { object ( |
Fields | |
---|---|
machineType |
The name of a Google Compute Engine machine type If unspecified, the default machine type is |
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. |
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:
If unspecified, no scopes are added, unless Cloud Logging or Cloud Monitoring are enabled, in which case their required scopes will be added. |
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. |
metadata |
The metadata key/value pairs assigned to instances in the cluster. Keys must conform to the regexp The following keys are reserved for Windows nodes: - "serial-port-logging-enable" 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 |
imageType |
The image type to use for this node. Note that for a given image type, the latest version of it will be used. |
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/ An object containing a list of |
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. |
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. |
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. |
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. |
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' |
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 |
workloadMetadataConfig |
The workload metadata configuration for this node. |
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/ |
sandboxConfig |
Sandbox configuration for this node. |
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. |
reservationAffinity |
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool. |
shieldedInstanceConfig |
Shielded Instance options. |
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 |
AcceleratorConfig
AcceleratorConfig represents a Hardware Accelerator request.
JSON representation | |
---|---|
{ "acceleratorCount": string, "acceleratorType": string } |
Fields | |
---|---|
acceleratorCount |
The number of the accelerator cards exposed to an instance. |
acceleratorType |
The accelerator type resource name. List of supported accelerators here |
WorkloadMetadataConfig
WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool.
JSON representation | |
---|---|
{
"mode": enum ( |
Fields | |
---|---|
mode |
Mode is the configuration for how to expose metadata to workloads running on the node pool. |
Mode
Mode is the configuration for how to expose metadata to workloads running on the node.
Enums | |
---|---|
MODE_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 comprised 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 ( |
Fields | |
---|---|
key |
Key for taint. |
value |
Value for taint. |
effect |
Effect for taint. |
Effect
Possible values for Effect in taint.
Enums | |
---|---|
EFFECT_UNSPECIFIED |
Not set |
NO_SCHEDULE |
NoSchedule |
PREFER_NO_SCHEDULE |
PreferNoSchedule |
NO_EXECUTE |
NoExecute |
SandboxConfig
SandboxConfig contains configurations of the sandbox to use for the node.
JSON representation | |
---|---|
{
"type": enum ( |
Fields | |
---|---|
type |
Type of the sandbox to use for the node. |
Type
Possible types of sandboxes.
Enums | |
---|---|
UNSPECIFIED |
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 ( |
Fields | |
---|---|
consumeReservationType |
Corresponds to the type of reservation consumption. |
key |
Corresponds to the label key of a reservation resource. To target a SPECIFIC_RESERVATION by name, specify "googleapis.com/reservation-name" as the key and specify the name of your reservation as its value. |
values[] |
Corresponds to the label value(s) of reservation resource(s). |
Type
Indicates whether to consume capacity from a reservation or not.
Enums | |
---|---|
UNSPECIFIED |
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. |