Reference documentation and code samples for the Google Cloud Container V1 Client class NodeConfig.
Parameters that describe the nodes in a cluster.
GKE Autopilot clusters do not
recognize parameters in NodeConfig
. Use AutoprovisioningNodePoolDefaults
instead.
Generated from protobuf message google.container.v1.NodeConfig
Namespace
Google \ Cloud \ Container \ V1Methods
__construct
Constructor.
data
array
Optional. Data for populating the Message object.
↳ machine_type
string
The name of a Google Compute Engine machine type
If unspecified, the default machine type is e2-medium
.
↳ disk_size_gb
int
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
array
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
array| Google\Protobuf\Internal\MapField
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
array| Google\Protobuf\Internal\MapField
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
int
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
array
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
array< 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
↳ taints
array< 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
↳ 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
ReservationAffinity
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
↳ shielded_instance_config
↳ linux_node_config
↳ kubelet_config
↳ 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
↳ advanced_machine_features
↳ gvnic
↳ spot
bool
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
↳ confidential_nodes
ConfidentialNodes
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled.
↳ fast_socket
↳ resource_labels
array| Google\Protobuf\Internal\MapField
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
↳ logging_config
↳ windows_node_config
↳ local_nvme_ssd_block_config
↳ ephemeral_storage_local_ssd_config
EphemeralStorageLocalSsdConfig
Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk.
↳ sole_tenant_config
↳ containerd_config
↳ resource_manager_tags
↳ enable_confidential_storage
bool
Optional. Reserved for future use.
↳ secondary_boot_disks
↳ storage_pools
array
List of Storage Pools where boot disks are provisioned.
↳ secondary_boot_disk_update_strategy
↳ max_run_duration
Google\Protobuf\Duration
The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely.
↳ local_ssd_encryption_mode
int
Specifies which method should be used for encrypting the Local SSDs attached to the node.
↳ effective_cgroup_mode
int
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.
↳ flex_start
bool
Flex Start flag for enabling Flex Start VM.
↳ boot_disk
getMachineType
The name of a Google Compute Engine machine
type
If unspecified, the default machine type is e2-medium
.
string
setMachineType
The name of a Google Compute Engine machine
type
If unspecified, the default machine type is e2-medium
.
var
string
$this
getDiskSizeGb
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.
int
setDiskSizeGb
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.
var
int
$this
getOauthScopes
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/computeis required for mounting persistent storage on your nodes. -
https://www.googleapis.com/auth/devstorage.read_onlyis 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.
setOauthScopes
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/computeis required for mounting persistent storage on your nodes. -
https://www.googleapis.com/auth/devstorage.read_onlyis 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.
var
string[]
$this
getServiceAccount
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.
string
setServiceAccount
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.
var
string
$this
getMetadata
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.
setMetadata
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.
$this
getImageType
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.
string
setImageType
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.
var
string
$this
getLabels
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/
setLabels
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/
$this
getLocalSsdCount
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.
int
setLocalSsdCount
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.
var
int
$this
getTags
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.
setTags
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.
var
string[]
$this
getPreemptible
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.
bool
setPreemptible
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.
var
bool
$this
getAccelerators
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.
setAccelerators
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.
$this
getDiskType
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'
string
setDiskType
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'
var
string
$this
getMinCpuPlatform
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
string
setMinCpuPlatform
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
var
string
$this
getWorkloadMetadataConfig
The workload metadata configuration for this node.
hasWorkloadMetadataConfig
clearWorkloadMetadataConfig
setWorkloadMetadataConfig
The workload metadata configuration for this node.
$this
getTaints
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/
setTaints
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/
$this
getSandboxConfig
Sandbox configuration for this node.
hasSandboxConfig
clearSandboxConfig
setSandboxConfig
Sandbox configuration for this node.
$this
getNodeGroup
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 .
string
setNodeGroup
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 .
var
string
$this
getReservationAffinity
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
hasReservationAffinity
clearReservationAffinity
setReservationAffinity
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
$this
getShieldedInstanceConfig
Shielded Instance options.
hasShieldedInstanceConfig
clearShieldedInstanceConfig
setShieldedInstanceConfig
Shielded Instance options.
$this
getLinuxNodeConfig
Parameters that can be configured on Linux nodes.
hasLinuxNodeConfig
clearLinuxNodeConfig
setLinuxNodeConfig
Parameters that can be configured on Linux nodes.
$this
getKubeletConfig
Node kubelet configs.
hasKubeletConfig
clearKubeletConfig
setKubeletConfig
Node kubelet configs.
$this
getBootDiskKmsKey
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
string
setBootDiskKmsKey
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
var
string
$this
getGcfsConfig
Google Container File System (image streaming) configs.
hasGcfsConfig
clearGcfsConfig
setGcfsConfig
Google Container File System (image streaming) configs.
$this
getAdvancedMachineFeatures
Advanced features for the Compute Engine VM.
hasAdvancedMachineFeatures
clearAdvancedMachineFeatures
setAdvancedMachineFeatures
Advanced features for the Compute Engine VM.
$this
getGvnic
Enable or disable gvnic in the node pool.
hasGvnic
clearGvnic
setGvnic
Enable or disable gvnic in the node pool.
$this
getSpot
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
bool
setSpot
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
var
bool
$this
getConfidentialNodes
Confidential nodes config.
All the nodes in the node pool will be Confidential VM once enabled.
hasConfidentialNodes
clearConfidentialNodes
setConfidentialNodes
Confidential nodes config.
All the nodes in the node pool will be Confidential VM once enabled.
$this
getFastSocket
Enable or disable NCCL fast socket for the node pool.
hasFastSocket
clearFastSocket
setFastSocket
Enable or disable NCCL fast socket for the node pool.
$this
getResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
setResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
$this
getLoggingConfig
Logging configuration.
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration.
$this
getWindowsNodeConfig
Parameters that can be configured on Windows nodes.
hasWindowsNodeConfig
clearWindowsNodeConfig
setWindowsNodeConfig
Parameters that can be configured on Windows nodes.
$this
getLocalNvmeSsdBlockConfig
Parameters for using raw-block Local NVMe SSDs.
hasLocalNvmeSsdBlockConfig
clearLocalNvmeSsdBlockConfig
setLocalNvmeSsdBlockConfig
Parameters for using raw-block Local NVMe SSDs.
$this
getEphemeralStorageLocalSsdConfig
Parameters for the node ephemeral storage using Local SSDs.
If unspecified, ephemeral storage is backed by the boot disk.
hasEphemeralStorageLocalSsdConfig
clearEphemeralStorageLocalSsdConfig
setEphemeralStorageLocalSsdConfig
Parameters for the node ephemeral storage using Local SSDs.
If unspecified, ephemeral storage is backed by the boot disk.
$this
getSoleTenantConfig
Parameters for node pools to be backed by shared sole tenant node groups.
hasSoleTenantConfig
clearSoleTenantConfig
setSoleTenantConfig
Parameters for node pools to be backed by shared sole tenant node groups.
$this
getContainerdConfig
Parameters for containerd customization.
hasContainerdConfig
clearContainerdConfig
setContainerdConfig
Parameters for containerd customization.
$this
getResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes.
hasResourceManagerTags
clearResourceManagerTags
setResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes.
$this
getEnableConfidentialStorage
Optional. Reserved for future use.
bool
setEnableConfidentialStorage
Optional. Reserved for future use.
var
bool
$this
getSecondaryBootDisks
List of secondary boot disks attached to the nodes.
setSecondaryBootDisks
List of secondary boot disks attached to the nodes.
$this
getStoragePools
List of Storage Pools where boot disks are provisioned.
setStoragePools
List of Storage Pools where boot disks are provisioned.
var
string[]
$this
getSecondaryBootDiskUpdateStrategy
Secondary boot disk update strategy.
hasSecondaryBootDiskUpdateStrategy
clearSecondaryBootDiskUpdateStrategy
setSecondaryBootDiskUpdateStrategy
Secondary boot disk update strategy.
$this
getMaxRunDuration
The maximum duration for the nodes to exist.
If unspecified, the nodes can exist indefinitely.
hasMaxRunDuration
clearMaxRunDuration
setMaxRunDuration
The maximum duration for the nodes to exist.
If unspecified, the nodes can exist indefinitely.
$this
getLocalSsdEncryptionMode
Specifies which method should be used for encrypting the Local SSDs attached to the node.
int
hasLocalSsdEncryptionMode
clearLocalSsdEncryptionMode
setLocalSsdEncryptionMode
Specifies which method should be used for encrypting the Local SSDs attached to the node.
var
int
$this
getEffectiveCgroupMode
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.
int
setEffectiveCgroupMode
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.
var
int
$this
getFlexStart
Flex Start flag for enabling Flex Start VM.
bool
hasFlexStart
clearFlexStart
setFlexStart
Flex Start flag for enabling Flex Start VM.
var
bool
$this
getBootDisk
The boot disk configuration for the node pool.
hasBootDisk
clearBootDisk
setBootDisk
The boot disk configuration for the node pool.
$this
