Class: Google::Container::V1beta1::NodeConfig

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb

Overview

Parameters that describe the nodes in a cluster.

Instance Attribute Summary collapse

Instance Attribute Details

#accelerators ⇒ Array<Google::Container::V1beta1::AcceleratorConfig>

Returns 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:



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#disk_size_gb ⇒ Integer

Returns 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.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#disk_type ⇒ String

Returns Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

If unspecified, the default disk type is 'pd-standard'.

Returns:

  • (String) —

    Type of the disk attached to each node (e.g. 'pd-standard' or 'pd-ssd')

    If unspecified, the default disk type is 'pd-standard'



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#image_type ⇒ String

Returns The image type to use for this node. Note that for a given image type, the latest version of it will be used.

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.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#labels ⇒ Hash{String => String}

Returns 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:

  • (Hash{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/



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#local_ssd_count ⇒ Integer

Returns 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:



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#machine_type ⇒ String

Returns The name of a Google Compute Engine machine type (e.g. n1-standard-1).

If unspecified, the default machine type is n1-standard-1.

Returns:

  • (String) —

    The name of a Google Compute Engine machine type (e.g. n1-standard-1).

    If unspecified, the default machine type is n1-standard-1.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#metadata ⇒ Hash{String => String}

Returns 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-oslogin" "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" "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.

Returns:

  • (Hash{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-oslogin" "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" "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.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#min_cpu_platform ⇒ String

Returns 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 To unset the min cpu platform field pass "automatic" as field value.

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 To unset the min cpu platform field pass "automatic" as field value.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#oauth_scopes ⇒ Array<String>

Returns 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.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#preemptible ⇒ true, false

Returns Whether the nodes are created as preemptible VM instances. See: https://cloud.google.com/compute/docs/instances/preemptible for more inforamtion about preemptible VM instances.

Returns:



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#service_account ⇒ String

Returns The Google Cloud Platform Service Account to be used by the node VMs. 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. If no Service Account is specified, the "default" service account is used.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#shielded_instance_config ⇒ Google::Container::V1beta1::ShieldedInstanceConfig

Returns Shielded Instance options.

Returns:



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#tags ⇒ Array<String>

Returns 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.



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#taints ⇒ Array<Google::Container::V1beta1::NodeTaint>

Returns 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:



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end

#workload_metadata_config ⇒ Google::Container::V1beta1::WorkloadMetadataConfig

Returns The workload metadata configuration for this node.

Returns:



152
 
# File 'lib/google/cloud/container/v1beta1/doc/google/container/v1beta1/cluster_service.rb', line 152

class NodeConfig; end