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.
Parameters | |
---|---|
Name | Description |
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 |
↳ 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: * |
↳ 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 |
↳ 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<Google\Cloud\Container\V1\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 |
↳ workload_metadata_config |
Google\Cloud\Container\V1\WorkloadMetadataConfig
The workload metadata configuration for this node. |
↳ taints |
array<Google\Cloud\Container\V1\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 |
Google\Cloud\Container\V1\SandboxConfig
Sandbox configuration for this node. |
↳ 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 |
Google\Cloud\Container\V1\ReservationAffinity
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool. |
↳ shielded_instance_config |
Google\Cloud\Container\V1\ShieldedInstanceConfig
Shielded Instance options. |
↳ linux_node_config |
Google\Cloud\Container\V1\LinuxNodeConfig
Parameters that can be configured on Linux nodes. |
↳ kubelet_config |
Google\Cloud\Container\V1\NodeKubeletConfig
Node kubelet configs. |
↳ 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 |
Google\Cloud\Container\V1\GcfsConfig
Google Container File System (image streaming) configs. |
↳ advanced_machine_features |
Google\Cloud\Container\V1\AdvancedMachineFeatures
Advanced features for the Compute Engine VM. |
↳ gvnic |
Google\Cloud\Container\V1\VirtualNIC
Enable or disable gvnic in the node pool. |
↳ spot |
bool
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. |
↳ confidential_nodes |
Google\Cloud\Container\V1\ConfidentialNodes
Confidential nodes config. All the nodes in the node pool will be Confidential VM once enabled. |
↳ fast_socket |
Google\Cloud\Container\V1\FastSocket
Enable or disable NCCL fast socket for the node pool. |
↳ 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 |
Google\Cloud\Container\V1\NodePoolLoggingConfig
Logging configuration. |
↳ windows_node_config |
Google\Cloud\Container\V1\WindowsNodeConfig
Parameters that can be configured on Windows nodes. |
↳ local_nvme_ssd_block_config |
Google\Cloud\Container\V1\LocalNvmeSsdBlockConfig
Parameters for using raw-block Local NVMe SSDs. |
↳ ephemeral_storage_local_ssd_config |
Google\Cloud\Container\V1\EphemeralStorageLocalSsdConfig
Parameters for the node ephemeral storage using Local SSDs. If unspecified, ephemeral storage is backed by the boot disk. |
↳ sole_tenant_config |
Google\Cloud\Container\V1\SoleTenantConfig
Parameters for node pools to be backed by shared sole tenant node groups. |
↳ containerd_config |
Google\Cloud\Container\V1\ContainerdConfig
Parameters for containerd customization. |
↳ resource_manager_tags |
Google\Cloud\Container\V1\ResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes. |
↳ enable_confidential_storage |
bool
Optional. Reserved for future use. |
↳ secondary_boot_disks |
array<Google\Cloud\Container\V1\SecondaryBootDisk>
List of secondary boot disks attached to the nodes. |
↳ storage_pools |
array
List of Storage Pools where boot disks are provisioned. |
↳ secondary_boot_disk_update_strategy |
Google\Cloud\Container\V1\SecondaryBootDiskUpdateStrategy
Secondary boot disk update strategy. |
↳ 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. |
getMachineType
The name of a Google Compute Engine machine
type
If unspecified, the default machine type is e2-medium
.
Returns | |
---|---|
Type | Description |
string |
setMachineType
The name of a Google Compute Engine machine
type
If unspecified, the default machine type is e2-medium
.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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/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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
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/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.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
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.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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/
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
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/
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
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.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
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.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Container\V1\AcceleratorConfig>
|
Returns | |
---|---|
Type | Description |
$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'
Returns | |
---|---|
Type | Description |
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'
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$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
Returns | |
---|---|
Type | Description |
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getWorkloadMetadataConfig
The workload metadata configuration for this node.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\WorkloadMetadataConfig|null |
hasWorkloadMetadataConfig
clearWorkloadMetadataConfig
setWorkloadMetadataConfig
The workload metadata configuration for this node.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\WorkloadMetadataConfig
|
Returns | |
---|---|
Type | Description |
$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/
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
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/
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Container\V1\NodeTaint>
|
Returns | |
---|---|
Type | Description |
$this |
getSandboxConfig
Sandbox configuration for this node.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\SandboxConfig|null |
hasSandboxConfig
clearSandboxConfig
setSandboxConfig
Sandbox configuration for this node.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\SandboxConfig
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getReservationAffinity
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\ReservationAffinity|null |
hasReservationAffinity
clearReservationAffinity
setReservationAffinity
The optional reservation affinity. Setting this field will apply the specified Zonal Compute Reservation to this node pool.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\ReservationAffinity
|
Returns | |
---|---|
Type | Description |
$this |
getShieldedInstanceConfig
Shielded Instance options.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\ShieldedInstanceConfig|null |
hasShieldedInstanceConfig
clearShieldedInstanceConfig
setShieldedInstanceConfig
Shielded Instance options.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\ShieldedInstanceConfig
|
Returns | |
---|---|
Type | Description |
$this |
getLinuxNodeConfig
Parameters that can be configured on Linux nodes.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\LinuxNodeConfig|null |
hasLinuxNodeConfig
clearLinuxNodeConfig
setLinuxNodeConfig
Parameters that can be configured on Linux nodes.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\LinuxNodeConfig
|
Returns | |
---|---|
Type | Description |
$this |
getKubeletConfig
Node kubelet configs.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\NodeKubeletConfig|null |
hasKubeletConfig
clearKubeletConfig
setKubeletConfig
Node kubelet configs.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\NodeKubeletConfig
|
Returns | |
---|---|
Type | Description |
$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
Returns | |
---|---|
Type | Description |
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
Parameter | |
---|---|
Name | Description |
var |
string
|
Returns | |
---|---|
Type | Description |
$this |
getGcfsConfig
Google Container File System (image streaming) configs.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\GcfsConfig|null |
hasGcfsConfig
clearGcfsConfig
setGcfsConfig
Google Container File System (image streaming) configs.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\GcfsConfig
|
Returns | |
---|---|
Type | Description |
$this |
getAdvancedMachineFeatures
Advanced features for the Compute Engine VM.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\AdvancedMachineFeatures|null |
hasAdvancedMachineFeatures
clearAdvancedMachineFeatures
setAdvancedMachineFeatures
Advanced features for the Compute Engine VM.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\AdvancedMachineFeatures
|
Returns | |
---|---|
Type | Description |
$this |
getGvnic
Enable or disable gvnic in the node pool.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\VirtualNIC|null |
hasGvnic
clearGvnic
setGvnic
Enable or disable gvnic in the node pool.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\VirtualNIC
|
Returns | |
---|---|
Type | Description |
$this |
getSpot
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
Returns | |
---|---|
Type | Description |
bool |
setSpot
Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getConfidentialNodes
Confidential nodes config.
All the nodes in the node pool will be Confidential VM once enabled.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\ConfidentialNodes|null |
hasConfidentialNodes
clearConfidentialNodes
setConfidentialNodes
Confidential nodes config.
All the nodes in the node pool will be Confidential VM once enabled.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\ConfidentialNodes
|
Returns | |
---|---|
Type | Description |
$this |
getFastSocket
Enable or disable NCCL fast socket for the node pool.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\FastSocket|null |
hasFastSocket
clearFastSocket
setFastSocket
Enable or disable NCCL fast socket for the node pool.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\FastSocket
|
Returns | |
---|---|
Type | Description |
$this |
getResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\MapField |
setResourceLabels
The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
Parameter | |
---|---|
Name | Description |
var |
array|Google\Protobuf\Internal\MapField
|
Returns | |
---|---|
Type | Description |
$this |
getLoggingConfig
Logging configuration.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\NodePoolLoggingConfig|null |
hasLoggingConfig
clearLoggingConfig
setLoggingConfig
Logging configuration.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\NodePoolLoggingConfig
|
Returns | |
---|---|
Type | Description |
$this |
getWindowsNodeConfig
Parameters that can be configured on Windows nodes.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\WindowsNodeConfig|null |
hasWindowsNodeConfig
clearWindowsNodeConfig
setWindowsNodeConfig
Parameters that can be configured on Windows nodes.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\WindowsNodeConfig
|
Returns | |
---|---|
Type | Description |
$this |
getLocalNvmeSsdBlockConfig
Parameters for using raw-block Local NVMe SSDs.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\LocalNvmeSsdBlockConfig|null |
hasLocalNvmeSsdBlockConfig
clearLocalNvmeSsdBlockConfig
setLocalNvmeSsdBlockConfig
Parameters for using raw-block Local NVMe SSDs.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\LocalNvmeSsdBlockConfig
|
Returns | |
---|---|
Type | Description |
$this |
getEphemeralStorageLocalSsdConfig
Parameters for the node ephemeral storage using Local SSDs.
If unspecified, ephemeral storage is backed by the boot disk.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\EphemeralStorageLocalSsdConfig|null |
hasEphemeralStorageLocalSsdConfig
clearEphemeralStorageLocalSsdConfig
setEphemeralStorageLocalSsdConfig
Parameters for the node ephemeral storage using Local SSDs.
If unspecified, ephemeral storage is backed by the boot disk.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\EphemeralStorageLocalSsdConfig
|
Returns | |
---|---|
Type | Description |
$this |
getSoleTenantConfig
Parameters for node pools to be backed by shared sole tenant node groups.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\SoleTenantConfig|null |
hasSoleTenantConfig
clearSoleTenantConfig
setSoleTenantConfig
Parameters for node pools to be backed by shared sole tenant node groups.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\SoleTenantConfig
|
Returns | |
---|---|
Type | Description |
$this |
getContainerdConfig
Parameters for containerd customization.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\ContainerdConfig|null |
hasContainerdConfig
clearContainerdConfig
setContainerdConfig
Parameters for containerd customization.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\ContainerdConfig
|
Returns | |
---|---|
Type | Description |
$this |
getResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\ResourceManagerTags|null |
hasResourceManagerTags
clearResourceManagerTags
setResourceManagerTags
A map of resource manager tag keys and values to be attached to the nodes.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\ResourceManagerTags
|
Returns | |
---|---|
Type | Description |
$this |
getEnableConfidentialStorage
Optional. Reserved for future use.
Returns | |
---|---|
Type | Description |
bool |
setEnableConfidentialStorage
Optional. Reserved for future use.
Parameter | |
---|---|
Name | Description |
var |
bool
|
Returns | |
---|---|
Type | Description |
$this |
getSecondaryBootDisks
List of secondary boot disks attached to the nodes.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setSecondaryBootDisks
List of secondary boot disks attached to the nodes.
Parameter | |
---|---|
Name | Description |
var |
array<Google\Cloud\Container\V1\SecondaryBootDisk>
|
Returns | |
---|---|
Type | Description |
$this |
getStoragePools
List of Storage Pools where boot disks are provisioned.
Returns | |
---|---|
Type | Description |
Google\Protobuf\Internal\RepeatedField |
setStoragePools
List of Storage Pools where boot disks are provisioned.
Parameter | |
---|---|
Name | Description |
var |
string[]
|
Returns | |
---|---|
Type | Description |
$this |
getSecondaryBootDiskUpdateStrategy
Secondary boot disk update strategy.
Returns | |
---|---|
Type | Description |
Google\Cloud\Container\V1\SecondaryBootDiskUpdateStrategy|null |
hasSecondaryBootDiskUpdateStrategy
clearSecondaryBootDiskUpdateStrategy
setSecondaryBootDiskUpdateStrategy
Secondary boot disk update strategy.
Parameter | |
---|---|
Name | Description |
var |
Google\Cloud\Container\V1\SecondaryBootDiskUpdateStrategy
|
Returns | |
---|---|
Type | Description |
$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.
Returns | |
---|---|
Type | Description |
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.
Parameter | |
---|---|
Name | Description |
var |
int
|
Returns | |
---|---|
Type | Description |
$this |