Kubernetes Engine V1 API - Class Google::Cloud::Container::V1::NodeConfig (v0.40.0)

Reference documentation and code samples for the Kubernetes Engine V1 API class Google::Cloud::Container::V1::NodeConfig.

Parameters that describe the nodes in a cluster.

GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#accelerators

def accelerators() -> ::Array<::Google::Cloud::Container::V1::AcceleratorConfig>
Returns

#accelerators=

def accelerators=(value) -> ::Array<::Google::Cloud::Container::V1::AcceleratorConfig>
Parameter
Returns

#advanced_machine_features

def advanced_machine_features() -> ::Google::Cloud::Container::V1::AdvancedMachineFeatures
Returns

#advanced_machine_features=

def advanced_machine_features=(value) -> ::Google::Cloud::Container::V1::AdvancedMachineFeatures
Parameter
Returns

#boot_disk_kms_key

def boot_disk_kms_key() -> ::String
Returns
  • (::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

#boot_disk_kms_key=

def boot_disk_kms_key=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#confidential_nodes

def confidential_nodes() -> ::Google::Cloud::Container::V1::ConfidentialNodes
Returns

#confidential_nodes=

def confidential_nodes=(value) -> ::Google::Cloud::Container::V1::ConfidentialNodes
Parameter
Returns

#disk_size_gb

def disk_size_gb() -> ::Integer
Returns
  • (::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.

#disk_size_gb=

def disk_size_gb=(value) -> ::Integer
Parameter
  • value (::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.

Returns
  • (::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.

#disk_type

def disk_type() -> ::String
Returns
  • (::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'

#disk_type=

def disk_type=(value) -> ::String
Parameter
  • value (::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'

Returns
  • (::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'

#enable_confidential_storage

def enable_confidential_storage() -> ::Boolean
Returns
  • (::Boolean) — Optional. Reserved for future use.

#enable_confidential_storage=

def enable_confidential_storage=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Optional. Reserved for future use.
Returns
  • (::Boolean) — Optional. Reserved for future use.

#ephemeral_storage_local_ssd_config

def ephemeral_storage_local_ssd_config() -> ::Google::Cloud::Container::V1::EphemeralStorageLocalSsdConfig
Returns

#ephemeral_storage_local_ssd_config=

def ephemeral_storage_local_ssd_config=(value) -> ::Google::Cloud::Container::V1::EphemeralStorageLocalSsdConfig
Parameter
Returns

#fast_socket

def fast_socket() -> ::Google::Cloud::Container::V1::FastSocket
Returns

#fast_socket=

def fast_socket=(value) -> ::Google::Cloud::Container::V1::FastSocket
Parameter
Returns

#gcfs_config

def gcfs_config() -> ::Google::Cloud::Container::V1::GcfsConfig
Returns

#gcfs_config=

def gcfs_config=(value) -> ::Google::Cloud::Container::V1::GcfsConfig
Parameter
Returns

#gvnic

def gvnic() -> ::Google::Cloud::Container::V1::VirtualNIC
Returns

#gvnic=

def gvnic=(value) -> ::Google::Cloud::Container::V1::VirtualNIC
Parameter
Returns

#image_type

def image_type() -> ::String
Returns
  • (::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.

#image_type=

def image_type=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#kubelet_config

def kubelet_config() -> ::Google::Cloud::Container::V1::NodeKubeletConfig
Returns

#kubelet_config=

def kubelet_config=(value) -> ::Google::Cloud::Container::V1::NodeKubeletConfig
Parameter
Returns

#labels

def labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::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/

#labels=

def labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::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/
Returns
  • (::Google::Protobuf::Map{::String => ::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/

#linux_node_config

def linux_node_config() -> ::Google::Cloud::Container::V1::LinuxNodeConfig
Returns

#linux_node_config=

def linux_node_config=(value) -> ::Google::Cloud::Container::V1::LinuxNodeConfig
Parameter
Returns

#local_nvme_ssd_block_config

def local_nvme_ssd_block_config() -> ::Google::Cloud::Container::V1::LocalNvmeSsdBlockConfig
Returns

#local_nvme_ssd_block_config=

def local_nvme_ssd_block_config=(value) -> ::Google::Cloud::Container::V1::LocalNvmeSsdBlockConfig
Parameter
Returns

#local_ssd_count

def local_ssd_count() -> ::Integer
Returns
  • (::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://cloud.google.com/compute/docs/disks/local-ssd for more information.

#local_ssd_count=

def local_ssd_count=(value) -> ::Integer
Parameter
  • value (::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://cloud.google.com/compute/docs/disks/local-ssd for more information.

Returns
  • (::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://cloud.google.com/compute/docs/disks/local-ssd for more information.

#logging_config

def logging_config() -> ::Google::Cloud::Container::V1::NodePoolLoggingConfig
Returns

#logging_config=

def logging_config=(value) -> ::Google::Cloud::Container::V1::NodePoolLoggingConfig
Parameter
Returns

#machine_type

def machine_type() -> ::String
Returns
  • (::String) — The name of a Google Compute Engine machine type

    If unspecified, the default machine type is e2-medium.

#machine_type=

def machine_type=(value) -> ::String
Parameter
  • value (::String) — The name of a Google Compute Engine machine type

    If unspecified, the default machine type is e2-medium.

Returns
  • (::String) — The name of a Google Compute Engine machine type

    If unspecified, the default machine type is e2-medium.

#metadata

def metadata() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::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:

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

#metadata=

def metadata=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::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:

    • "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
  • (::Google::Protobuf::Map{::String => ::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:

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

#min_cpu_platform

def min_cpu_platform() -> ::String
Returns
  • (::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

#min_cpu_platform=

def min_cpu_platform=(value) -> ::String
Parameter
  • value (::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
Returns
  • (::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

#node_group

def node_group() -> ::String
Returns
  • (::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.

#node_group=

def node_group=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#oauth_scopes

def oauth_scopes() -> ::Array<::String>
Returns
  • (::Array<::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.

#oauth_scopes=

def oauth_scopes=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.

Returns
  • (::Array<::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.

#preemptible

def preemptible() -> ::Boolean
Returns
  • (::Boolean) — 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.

#preemptible=

def preemptible=(value) -> ::Boolean
Parameter
  • value (::Boolean) — 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
  • (::Boolean) — 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.

#reservation_affinity

def reservation_affinity() -> ::Google::Cloud::Container::V1::ReservationAffinity
Returns

#reservation_affinity=

def reservation_affinity=(value) -> ::Google::Cloud::Container::V1::ReservationAffinity
Parameter
Returns

#resource_labels

def resource_labels() -> ::Google::Protobuf::Map{::String => ::String}
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

#resource_labels=

def resource_labels=(value) -> ::Google::Protobuf::Map{::String => ::String}
Parameter
  • value (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the node pool to use to annotate any related Google Compute Engine resources.
Returns
  • (::Google::Protobuf::Map{::String => ::String}) — The resource labels for the node pool to use to annotate any related Google Compute Engine resources.

#resource_manager_tags

def resource_manager_tags() -> ::Google::Cloud::Container::V1::ResourceManagerTags
Returns

#resource_manager_tags=

def resource_manager_tags=(value) -> ::Google::Cloud::Container::V1::ResourceManagerTags
Parameter
Returns

#sandbox_config

def sandbox_config() -> ::Google::Cloud::Container::V1::SandboxConfig
Returns

#sandbox_config=

def sandbox_config=(value) -> ::Google::Cloud::Container::V1::SandboxConfig
Parameter
Returns

#secondary_boot_disk_update_strategy

def secondary_boot_disk_update_strategy() -> ::Google::Cloud::Container::V1::SecondaryBootDiskUpdateStrategy
Returns

#secondary_boot_disk_update_strategy=

def secondary_boot_disk_update_strategy=(value) -> ::Google::Cloud::Container::V1::SecondaryBootDiskUpdateStrategy
Parameter
Returns

#secondary_boot_disks

def secondary_boot_disks() -> ::Array<::Google::Cloud::Container::V1::SecondaryBootDisk>
Returns

#secondary_boot_disks=

def secondary_boot_disks=(value) -> ::Array<::Google::Cloud::Container::V1::SecondaryBootDisk>
Parameter
Returns

#service_account

def service_account() -> ::String
Returns
  • (::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.

#service_account=

def service_account=(value) -> ::String
Parameter
  • value (::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.
Returns
  • (::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.

#shielded_instance_config

def shielded_instance_config() -> ::Google::Cloud::Container::V1::ShieldedInstanceConfig
Returns

#shielded_instance_config=

def shielded_instance_config=(value) -> ::Google::Cloud::Container::V1::ShieldedInstanceConfig
Parameter
Returns

#sole_tenant_config

def sole_tenant_config() -> ::Google::Cloud::Container::V1::SoleTenantConfig
Returns

#sole_tenant_config=

def sole_tenant_config=(value) -> ::Google::Cloud::Container::V1::SoleTenantConfig
Parameter
Returns

#spot

def spot() -> ::Boolean
Returns
  • (::Boolean) — Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.

#spot=

def spot=(value) -> ::Boolean
Parameter
  • value (::Boolean) — Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.
Returns
  • (::Boolean) — Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag.

#tags

def tags() -> ::Array<::String>
Returns
  • (::Array<::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.

#tags=

def tags=(value) -> ::Array<::String>
Parameter
  • value (::Array<::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.
Returns
  • (::Array<::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.

#taints

def taints() -> ::Array<::Google::Cloud::Container::V1::NodeTaint>
Returns
  • (::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/

#taints=

def taints=(value) -> ::Array<::Google::Cloud::Container::V1::NodeTaint>
Parameter
  • value (::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/

Returns
  • (::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/

#windows_node_config

def windows_node_config() -> ::Google::Cloud::Container::V1::WindowsNodeConfig
Returns

#windows_node_config=

def windows_node_config=(value) -> ::Google::Cloud::Container::V1::WindowsNodeConfig
Parameter
Returns

#workload_metadata_config

def workload_metadata_config() -> ::Google::Cloud::Container::V1::WorkloadMetadataConfig
Returns

#workload_metadata_config=

def workload_metadata_config=(value) -> ::Google::Cloud::Container::V1::WorkloadMetadataConfig
Parameter
Returns