Class: Google::Apis::ContainerV1::NodeConfig

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

Overview

Parameters that describe the nodes in a cluster. GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NodeConfig

Returns a new instance of NodeConfig.



5651
5652
5653
 
# File 'lib/google/apis/container_v1/classes.rb', line 5651

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

Instance Attribute Details

#accelerators ⇒ Array<Google::Apis::ContainerV1::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:



5347
5348
5349
 
# File 'lib/google/apis/container_v1/classes.rb', line 5347

def accelerators
  @accelerators
end

#advanced_machine_features ⇒ Google::Apis::ContainerV1::AdvancedMachineFeatures

Specifies options for controlling advanced machine features. Corresponds to the JSON property advancedMachineFeatures

Returns:



5352
5353
5354
 
# File 'lib/google/apis/container_v1/classes.rb', line 5352

def advanced_machine_features
  @advanced_machine_features
end

#boot_disk ⇒ Google::Apis::ContainerV1::BootDisk

BootDisk specifies the boot disk configuration for nodepools. Corresponds to the JSON property bootDisk

Returns:



5357
5358
5359
 
# File 'lib/google/apis/container_v1/classes.rb', line 5357

def boot_disk
  @boot_disk
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) 


5366
5367
5368
 
# File 'lib/google/apis/container_v1/classes.rb', line 5366

def boot_disk_kms_key
  @boot_disk_kms_key
end

#confidential_nodes ⇒ Google::Apis::ContainerV1::ConfidentialNodes

ConfidentialNodes is configuration for the confidential nodes feature, which makes nodes run on confidential VMs. Corresponds to the JSON property confidentialNodes

Returns:



5372
5373
5374
 
# File 'lib/google/apis/container_v1/classes.rb', line 5372

def confidential_nodes
  @confidential_nodes
end

#containerd_config ⇒ Google::Apis::ContainerV1::ContainerdConfig

ContainerdConfig contains configuration to customize containerd. Corresponds to the JSON property containerdConfig

Returns:



5377
5378
5379
 
# File 'lib/google/apis/container_v1/classes.rb', line 5377

def containerd_config
  @containerd_config
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) 


5383
5384
5385
 
# File 'lib/google/apis/container_v1/classes.rb', line 5383

def disk_size_gb
  @disk_size_gb
end

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

Returns:

  • (String) 


5389
5390
5391
 
# File 'lib/google/apis/container_v1/classes.rb', line 5389

def disk_type
  @disk_type
end

#effective_cgroup_mode ⇒ String

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

Returns:

  • (String) 


5397
5398
5399
 
# File 'lib/google/apis/container_v1/classes.rb', line 5397

def effective_cgroup_mode
  @effective_cgroup_mode
end

#enable_confidential_storage ⇒ Boolean Also known as: enable_confidential_storage?

Optional. Reserved for future use. Corresponds to the JSON property enableConfidentialStorage

Returns:

  • (Boolean) 


5402
5403
5404
 
# File 'lib/google/apis/container_v1/classes.rb', line 5402

def enable_confidential_storage
  @enable_confidential_storage
end

#ephemeral_storage_local_ssd_config ⇒ Google::Apis::ContainerV1::EphemeralStorageLocalSsdConfig

EphemeralStorageLocalSsdConfig contains configuration for the node ephemeral storage using Local SSDs. Corresponds to the JSON property ephemeralStorageLocalSsdConfig

Returns:



5409
5410
5411
 
# File 'lib/google/apis/container_v1/classes.rb', line 5409

def ephemeral_storage_local_ssd_config
  @ephemeral_storage_local_ssd_config
end

#fast_socket ⇒ Google::Apis::ContainerV1::FastSocket

Configuration of Fast Socket feature. Corresponds to the JSON property fastSocket

Returns:



5414
5415
5416
 
# File 'lib/google/apis/container_v1/classes.rb', line 5414

def fast_socket
  @fast_socket
end

#flex_start ⇒ Boolean Also known as: flex_start?

Flex Start flag for enabling Flex Start VM. Corresponds to the JSON property flexStart

Returns:

  • (Boolean) 


5419
5420
5421
 
# File 'lib/google/apis/container_v1/classes.rb', line 5419

def flex_start
  @flex_start
end

#gcfs_config ⇒ Google::Apis::ContainerV1::GcfsConfig

GcfsConfig contains configurations of Google Container File System (image streaming). Corresponds to the JSON property gcfsConfig

Returns:



5426
5427
5428
 
# File 'lib/google/apis/container_v1/classes.rb', line 5426

def gcfs_config
  @gcfs_config
end

#gvnic ⇒ Google::Apis::ContainerV1::VirtualNic

Configuration of gVNIC feature. Corresponds to the JSON property gvnic

Returns:



5431
5432
5433
 
# File 'lib/google/apis/container_v1/classes.rb', line 5431

def gvnic
  @gvnic
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. Please see https://cloud.google.com/ kubernetes-engine/docs/concepts/node-images for available image types. Corresponds to the JSON property imageType

Returns:

  • (String) 


5438
5439
5440
 
# File 'lib/google/apis/container_v1/classes.rb', line 5438

def image_type
  @image_type
end

#kubelet_config ⇒ Google::Apis::ContainerV1::NodeKubeletConfig

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



5443
5444
5445
 
# File 'lib/google/apis/container_v1/classes.rb', line 5443

def kubelet_config
  @kubelet_config
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>) 


5454
5455
5456
 
# File 'lib/google/apis/container_v1/classes.rb', line 5454

def labels
  @labels
end

#linux_node_config ⇒ Google::Apis::ContainerV1::LinuxNodeConfig

Parameters that can be configured on Linux nodes. Corresponds to the JSON property linuxNodeConfig

Returns:



5459
5460
5461
 
# File 'lib/google/apis/container_v1/classes.rb', line 5459

def linux_node_config
  @linux_node_config
end

#local_nvme_ssd_block_config ⇒ Google::Apis::ContainerV1::LocalNvmeSsdBlockConfig

LocalNvmeSsdBlockConfig contains configuration for using raw-block local NVMe SSDs Corresponds to the JSON property localNvmeSsdBlockConfig

Returns:



5465
5466
5467
 
# File 'lib/google/apis/container_v1/classes.rb', line 5465

def local_nvme_ssd_block_config
  @local_nvme_ssd_block_config
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) 


5473
5474
5475
 
# File 'lib/google/apis/container_v1/classes.rb', line 5473

def local_ssd_count
  @local_ssd_count
end

#local_ssd_encryption_mode ⇒ String

Specifies which method should be used for encrypting the Local SSDs attached to the node. Corresponds to the JSON property localSsdEncryptionMode

Returns:

  • (String) 


5479
5480
5481
 
# File 'lib/google/apis/container_v1/classes.rb', line 5479

def local_ssd_encryption_mode
  @local_ssd_encryption_mode
end

#logging_config ⇒ Google::Apis::ContainerV1::NodePoolLoggingConfig

NodePoolLoggingConfig specifies logging configuration for nodepools. Corresponds to the JSON property loggingConfig

Returns:



5484
5485
5486
 
# File 'lib/google/apis/container_v1/classes.rb', line 5484

def logging_config
  @logging_config
end

#machine_type ⇒ String

The name of a Google Compute Engine machine type If unspecified, the default machine type is e2- medium. Corresponds to the JSON property machineType

Returns:

  • (String) 


5491
5492
5493
 
# File 'lib/google/apis/container_v1/classes.rb', line 5491

def machine_type
  @machine_type
end

#max_run_duration ⇒ String

The maximum duration for the nodes to exist. If unspecified, the nodes can exist indefinitely. Corresponds to the JSON property maxRunDuration

Returns:

  • (String) 


5497
5498
5499
 
# File 'lib/google/apis/container_v1/classes.rb', line 5497

def max_run_duration
  @max_run_duration
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-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. Corresponds to the JSON property metadata

Returns:

  • (Hash<String,String>) 


5515
5516
5517
 
# File 'lib/google/apis/container_v1/classes.rb', line 5515

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) 


5525
5526
5527
 
# File 'lib/google/apis/container_v1/classes.rb', line 5525

def min_cpu_platform
  @min_cpu_platform
end

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

Returns:

  • (String) 


5532
5533
5534
 
# File 'lib/google/apis/container_v1/classes.rb', line 5532

def node_group
  @node_group
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 Artifact 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>) 


5545
5546
5547
 
# File 'lib/google/apis/container_v1/classes.rb', line 5545

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 information about preemptible VM instances. Corresponds to the JSON property preemptible

Returns:

  • (Boolean) 


5552
5553
5554
 
# File 'lib/google/apis/container_v1/classes.rb', line 5552

def preemptible
  @preemptible
end

#reservation_affinity ⇒ Google::Apis::ContainerV1::ReservationAffinity

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

Returns:



5560
5561
5562
 
# File 'lib/google/apis/container_v1/classes.rb', line 5560

def reservation_affinity
  @reservation_affinity
end

#resource_labels ⇒ Hash<String,String>

The resource labels for the node pool to use to annotate any related Google Compute Engine resources. Corresponds to the JSON property resourceLabels

Returns:

  • (Hash<String,String>) 


5566
5567
5568
 
# File 'lib/google/apis/container_v1/classes.rb', line 5566

def resource_labels
  @resource_labels
end

#resource_manager_tags ⇒ Google::Apis::ContainerV1::ResourceManagerTags

A map of resource manager tag keys and values to be attached to the nodes for managing Compute Engine firewalls using Network Firewall Policies. Tags must be according to specifications in https://cloud.google.com/vpc/docs/tags- firewalls-overview#specifications. A maximum of 5 tag key-value pairs can be specified. Existing tags will be replaced with new values. Corresponds to the JSON property resourceManagerTags

Returns:



5575
5576
5577
 
# File 'lib/google/apis/container_v1/classes.rb', line 5575

def resource_manager_tags
  @resource_manager_tags
end

#sandbox_config ⇒ Google::Apis::ContainerV1::SandboxConfig

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

Returns:



5580
5581
5582
 
# File 'lib/google/apis/container_v1/classes.rb', line 5580

def sandbox_config
  @sandbox_config
end

#secondary_boot_disk_update_strategy ⇒ Google::Apis::ContainerV1::SecondaryBootDiskUpdateStrategy

SecondaryBootDiskUpdateStrategy is a placeholder which will be extended in the future to define different options for updating secondary boot disks. Corresponds to the JSON property secondaryBootDiskUpdateStrategy

Returns:



5586
5587
5588
 
# File 'lib/google/apis/container_v1/classes.rb', line 5586

def secondary_boot_disk_update_strategy
  @secondary_boot_disk_update_strategy
end

#secondary_boot_disks ⇒ Array<Google::Apis::ContainerV1::SecondaryBootDisk>

List of secondary boot disks attached to the nodes. Corresponds to the JSON property secondaryBootDisks

Returns:



5591
5592
5593
 
# File 'lib/google/apis/container_v1/classes.rb', line 5591

def secondary_boot_disks
  @secondary_boot_disks
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) 


5598
5599
5600
 
# File 'lib/google/apis/container_v1/classes.rb', line 5598

def 
  @service_account
end

#shielded_instance_config ⇒ Google::Apis::ContainerV1::ShieldedInstanceConfig

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

Returns:



5603
5604
5605
 
# File 'lib/google/apis/container_v1/classes.rb', line 5603

def shielded_instance_config
  @shielded_instance_config
end

#sole_tenant_config ⇒ Google::Apis::ContainerV1::SoleTenantConfig

SoleTenantConfig contains the NodeAffinities to specify what shared sole tenant node groups should back the node pool. Corresponds to the JSON property soleTenantConfig

Returns:



5609
5610
5611
 
# File 'lib/google/apis/container_v1/classes.rb', line 5609

def sole_tenant_config
  @sole_tenant_config
end

#spot ⇒ Boolean Also known as: spot?

Spot flag for enabling Spot VM, which is a rebrand of the existing preemptible flag. Corresponds to the JSON property spot

Returns:

  • (Boolean) 


5615
5616
5617
 
# File 'lib/google/apis/container_v1/classes.rb', line 5615

def spot
  @spot
end

#storage_pools ⇒ Array<String>

List of Storage Pools where boot disks are provisioned. Corresponds to the JSON property storagePools

Returns:

  • (Array<String>) 


5621
5622
5623
 
# File 'lib/google/apis/container_v1/classes.rb', line 5621

def storage_pools
  @storage_pools
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>) 


5629
5630
5631
 
# File 'lib/google/apis/container_v1/classes.rb', line 5629

def tags
  @tags
end

#taints ⇒ Array<Google::Apis::ContainerV1::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:



5636
5637
5638
 
# File 'lib/google/apis/container_v1/classes.rb', line 5636

def taints
  @taints
end

#windows_node_config ⇒ Google::Apis::ContainerV1::WindowsNodeConfig

Parameters that can be configured on Windows nodes. Windows Node Config that define the parameters that will be used to configure the Windows node pool settings. Corresponds to the JSON property windowsNodeConfig

Returns:



5643
5644
5645
 
# File 'lib/google/apis/container_v1/classes.rb', line 5643

def windows_node_config
  @windows_node_config
end

#workload_metadata_config ⇒ Google::Apis::ContainerV1::WorkloadMetadataConfig

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

Returns:



5649
5650
5651
 
# File 'lib/google/apis/container_v1/classes.rb', line 5649

def workload_metadata_config
  @workload_metadata_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5656
5657
5658
5659
5660
5661
5662
5663
5664
5665
5666
5667
5668
5669
5670
5671
5672
5673
5674
5675
5676
5677
5678
5679
5680
5681
5682
5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
5694
5695
5696
5697
5698
5699
5700
5701
5702
 
# File 'lib/google/apis/container_v1/classes.rb', line 5656

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @advanced_machine_features = args[:advanced_machine_features] if args.key?(:advanced_machine_features)
  @boot_disk = args[:boot_disk] if args.key?(:boot_disk)
  @boot_disk_kms_key = args[:boot_disk_kms_key] if args.key?(:boot_disk_kms_key)
  @confidential_nodes = args[:confidential_nodes] if args.key?(:confidential_nodes)
  @containerd_config = args[:containerd_config] if args.key?(:containerd_config)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @disk_type = args[:disk_type] if args.key?(:disk_type)
  @effective_cgroup_mode = args[:effective_cgroup_mode] if args.key?(:effective_cgroup_mode)
  @enable_confidential_storage = args[:enable_confidential_storage] if args.key?(:enable_confidential_storage)
  @ephemeral_storage_local_ssd_config = args[:ephemeral_storage_local_ssd_config] if args.key?(:ephemeral_storage_local_ssd_config)
  @fast_socket = args[:fast_socket] if args.key?(:fast_socket)
  @flex_start = args[:flex_start] if args.key?(:flex_start)
  @gcfs_config = args[:gcfs_config] if args.key?(:gcfs_config)
  @gvnic = args[:gvnic] if args.key?(:gvnic)
  @image_type = args[:image_type] if args.key?(:image_type)
  @kubelet_config = args[:kubelet_config] if args.key?(:kubelet_config)
  @labels = args[:labels] if args.key?(:labels)
  @linux_node_config = args[:linux_node_config] if args.key?(:linux_node_config)
  @local_nvme_ssd_block_config = args[:local_nvme_ssd_block_config] if args.key?(:local_nvme_ssd_block_config)
  @local_ssd_count = args[:local_ssd_count] if args.key?(:local_ssd_count)
  @local_ssd_encryption_mode = args[:local_ssd_encryption_mode] if args.key?(:local_ssd_encryption_mode)
  @logging_config = args[:logging_config] if args.key?(:logging_config)
  @machine_type = args[:machine_type] if args.key?(:machine_type)
  @max_run_duration = args[:max_run_duration] if args.key?(:max_run_duration)
  @metadata = args[:metadata] if args.key?(:metadata)
  @min_cpu_platform = args[:min_cpu_platform] if args.key?(:min_cpu_platform)
  @node_group = args[:node_group] if args.key?(:node_group)
  @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)
  @resource_labels = args[:resource_labels] if args.key?(:resource_labels)
  @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags)
  @sandbox_config = args[:sandbox_config] if args.key?(:sandbox_config)
  @secondary_boot_disk_update_strategy = args[:secondary_boot_disk_update_strategy] if args.key?(:secondary_boot_disk_update_strategy)
  @secondary_boot_disks = args[:secondary_boot_disks] if args.key?(:secondary_boot_disks)
  @service_account = args[:service_account] if args.key?(:service_account)
  @shielded_instance_config = args[:shielded_instance_config] if args.key?(:shielded_instance_config)
  @sole_tenant_config = args[:sole_tenant_config] if args.key?(:sole_tenant_config)
  @spot = args[:spot] if args.key?(:spot)
  @storage_pools = args[:storage_pools] if args.key?(:storage_pools)
  @tags = args[:tags] if args.key?(:tags)
  @taints = args[:taints] if args.key?(:taints)
  @windows_node_config = args[:windows_node_config] if args.key?(:windows_node_config)
  @workload_metadata_config = args[:workload_metadata_config] if args.key?(:workload_metadata_config)
end