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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
lib/google/apis/container_v1beta1/classes.rb,
lib/google/apis/container_v1beta1/representations.rb,
lib/google/apis/container_v1beta1/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.



3727
3728
3729
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3727

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:



3516
3517
3518
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3516

def accelerators
  @accelerators
end

#advanced_machine_features ⇒ Google::Apis::ContainerV1beta1::AdvancedMachineFeatures

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

Returns:



3521
3522
3523
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3521

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


3530
3531
3532
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3530

def boot_disk_kms_key
  @boot_disk_kms_key
end

#confidential_nodes ⇒ Google::Apis::ContainerV1beta1::ConfidentialNodes

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

Returns:



3536
3537
3538
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3536

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


3542
3543
3544
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3542

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) 


3548
3549
3550
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3548

def disk_type
  @disk_type
end

#ephemeral_storage_config ⇒ Google::Apis::ContainerV1beta1::EphemeralStorageConfig

EphemeralStorageConfig contains configuration for the ephemeral storage filesystem. Corresponds to the JSON property ephemeralStorageConfig

Returns:



3554
3555
3556
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3554

def ephemeral_storage_config
  @ephemeral_storage_config
end

#gcfs_config ⇒ Google::Apis::ContainerV1beta1::GcfsConfig

GcfsConfig contains configurations of Google Container File System. Corresponds to the JSON property gcfsConfig

Returns:



3559
3560
3561
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3559

def gcfs_config
  @gcfs_config
end

#gvnic ⇒ Google::Apis::ContainerV1beta1::VirtualNic

Configuration of gVNIC feature. Corresponds to the JSON property gvnic

Returns:



3564
3565
3566
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3564

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

Returns:

  • (String) 


3570
3571
3572
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3570

def image_type
  @image_type
end

#kubelet_config ⇒ Google::Apis::ContainerV1beta1::NodeKubeletConfig

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



3575
3576
3577
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3575

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>) 


3586
3587
3588
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3586

def labels
  @labels
end

#linux_node_config ⇒ Google::Apis::ContainerV1beta1::LinuxNodeConfig

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

Returns:



3591
3592
3593
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3591

def linux_node_config
  @linux_node_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) 


3599
3600
3601
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3599

def local_ssd_count
  @local_ssd_count
end

#logging_config ⇒ Google::Apis::ContainerV1beta1::NodePoolLoggingConfig

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

Returns:



3604
3605
3606
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3604

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) 


3611
3612
3613
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3611

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" 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>) 


3629
3630
3631
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3629

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) 


3639
3640
3641
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3639

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) 


3646
3647
3648
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3646

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 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>) 


3659
3660
3661
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3659

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) 


3666
3667
3668
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3666

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:



3674
3675
3676
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3674

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>) 


3680
3681
3682
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3680

def resource_labels
  @resource_labels
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:



3685
3686
3687
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3685

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) 


3692
3693
3694
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3692

def 
  @service_account
end

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

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

Returns:



3697
3698
3699
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3697

def shielded_instance_config
  @shielded_instance_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) 


3703
3704
3705
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3703

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


3712
3713
3714
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3712

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:



3719
3720
3721
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3719

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:



3725
3726
3727
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3725

def workload_metadata_config
  @workload_metadata_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3732

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_kms_key = args[:boot_disk_kms_key] if args.key?(:boot_disk_kms_key)
  @confidential_nodes = args[:confidential_nodes] if args.key?(:confidential_nodes)
  @disk_size_gb = args[:disk_size_gb] if args.key?(:disk_size_gb)
  @disk_type = args[:disk_type] if args.key?(:disk_type)
  @ephemeral_storage_config = args[:ephemeral_storage_config] if args.key?(:ephemeral_storage_config)
  @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_ssd_count = args[:local_ssd_count] if args.key?(:local_ssd_count)
  @logging_config = args[:logging_config] if args.key?(:logging_config)
  @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)
  @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)
  @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)
  @spot = args[:spot] if args.key?(:spot)
  @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