Class: Google::Apis::ContainerV1beta1::NodeConfig

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/container_v1beta1/classes.rb,
generated/google/apis/container_v1beta1/representations.rb,
generated/google/apis/container_v1beta1/representations.rb

Overview

Parameters that describe the nodes in a cluster.

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ NodeConfig

Returns a new instance of NodeConfig.



2602
2603
2604
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2602

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#accelerators ⇒ Array<Google::Apis::ContainerV1beta1::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. Corresponds to the JSON property accelerators

Returns:



2427
2428
2429
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2427

def accelerators
  @accelerators
end

#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 Corresponds to the JSON property bootDiskKmsKey

Returns:

  • (String) 


2438
2439
2440
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2438

def boot_disk_kms_key
  @boot_disk_kms_key
end

#disk_size_gb ⇒ Fixnum

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. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


2445
2446
2447
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2445

def disk_size_gb
  @disk_size_gb
end

#disk_type ⇒ 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' Corresponds to the JSON property diskType

Returns:

  • (String) 


2451
2452
2453
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2451

def disk_type
  @disk_type
end

#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. Corresponds to the JSON property imageType

Returns:

  • (String) 


2457
2458
2459
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2457

def image_type
  @image_type
end

#labels ⇒ 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/ Corresponds to the JSON property labels

Returns:

  • (Hash<String,String>) 


2469
2470
2471
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2469

def labels
  @labels
end

#local_ssd_count ⇒ Fixnum

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. Corresponds to the JSON property localSsdCount

Returns:

  • (Fixnum) 


2478
2479
2480
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2478

def local_ssd_count
  @local_ssd_count
end

#machine_type ⇒ 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. Corresponds to the JSON property machineType

Returns:

  • (String) 


2487
2488
2489
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2487

def machine_type
  @machine_type
end

#metadata ⇒ 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. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


2520
2521
2522
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2520

def metadata
  @metadata
end

#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 Corresponds to the JSON property minCpuPlatform

Returns:

  • (String) 


2532
2533
2534
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2532

def min_cpu_platform
  @min_cpu_platform
end

#oauth_scopes ⇒ 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. Corresponds to the JSON property oauthScopes

Returns:

  • (Array<String>) 


2547
2548
2549
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2547

def oauth_scopes
  @oauth_scopes
end

#preemptible ⇒ Boolean Also known as: preemptible?

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. Corresponds to the JSON property preemptible

Returns:

  • (Boolean) 


2554
2555
2556
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2554

def preemptible
  @preemptible
end

#reservation_affinity ⇒ Google::Apis::ContainerV1beta1::ReservationAffinity

ReservationAffinity is the configuration of desired reservation which instances could take capacity from. Corresponds to the JSON property reservationAffinity

Returns:



2562
2563
2564
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2562

def reservation_affinity
  @reservation_affinity
end

#sandbox_config ⇒ Google::Apis::ContainerV1beta1::SandboxConfig

SandboxConfig contains configurations of the sandbox to use for the node. Corresponds to the JSON property sandboxConfig

Returns:



2567
2568
2569
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2567

def sandbox_config
  @sandbox_config
end

#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. Corresponds to the JSON property serviceAccount

Returns:

  • (String) 


2574
2575
2576
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2574

def 
  @service_account
end

#shielded_instance_config ⇒ Google::Apis::ContainerV1beta1::ShieldedInstanceConfig

A set of Shielded Instance options. Corresponds to the JSON property shieldedInstanceConfig

Returns:



2579
2580
2581
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2579

def shielded_instance_config
  @shielded_instance_config
end

#tags ⇒ 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. Corresponds to the JSON property tags

Returns:

  • (Array<String>) 


2587
2588
2589
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2587

def tags
  @tags
end

#taints ⇒ Array<Google::Apis::ContainerV1beta1::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/ Corresponds to the JSON property taints

Returns:



2594
2595
2596
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2594

def taints
  @taints
end

#workload_metadata_config ⇒ Google::Apis::ContainerV1beta1::WorkloadMetadataConfig

WorkloadMetadataConfig defines the metadata configuration to expose to workloads on the node pool. Corresponds to the JSON property workloadMetadataConfig

Returns:



2600
2601
2602
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2600

def workload_metadata_config
  @workload_metadata_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2607

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @boot_disk_kms_key = args[:boot_disk_kms_key] if args.key?(:boot_disk_kms_key)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @disk_type = args[:disk_type] if args.key?(:disk_type)
  @image_type = args[:image_type] if args.key?(:image_type)
  @labels = args[:labels] if args.key?(:labels)
  @local_ssd_count = args[:local_ssd_count] if args.key?(:local_ssd_count)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @metadata = args[:metadata] if args.key?(:metadata)
  @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
  @oauth_scopes = args[:oauth_scopes] if args.key?(:oauth_scopes)
  @preemptible = args[:preemptible] if args.key?(:preemptible)
  @reservation_affinity = args[:reservation_affinity] if args.key?(:reservation_affinity)
  @sandbox_config = args[:sandbox_config] if args.key?(:sandbox_config)
  @service_account = args[:service_account] if args.key?(:service_account)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @tags = args[:tags] if args.key?(:tags)
  @taints = args[:taints] if args.key?(:taints)
  @workload_metadata_config = args[:workload_metadata_config] if args.key?(:workload_metadata_config)
end