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.



3843
3844
3845
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3843

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:



3608
3609
3610
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3608

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:



3613
3614
3615
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3613

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) 


3622
3623
3624
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3622

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:



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

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) 


3634
3635
3636
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3634

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) 


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

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:



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

def ephemeral_storage_config
  @ephemeral_storage_config
end

#ephemeral_storage_local_ssd_config ⇒ Google::Apis::ContainerV1beta1::EphemeralStorageLocalSsdConfig

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

Returns:



3652
3653
3654
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3652

def ephemeral_storage_local_ssd_config
  @ephemeral_storage_local_ssd_config
end

#fast_socket ⇒ Google::Apis::ContainerV1beta1::FastSocket

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

Returns:



3657
3658
3659
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3657

def fast_socket
  @fast_socket
end

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

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

Returns:



3662
3663
3664
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3662

def gcfs_config
  @gcfs_config
end

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

Configuration of gVNIC feature. Corresponds to the JSON property gvnic

Returns:



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

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) 


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

def image_type
  @image_type
end

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

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



3678
3679
3680
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3678

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


3689
3690
3691
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3689

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:



3694
3695
3696
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3694

def linux_node_config
  @linux_node_config
end

#local_nvme_ssd_block_config ⇒ Google::Apis::ContainerV1beta1::LocalNvmeSsdBlockConfig

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

Returns:



3700
3701
3702
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3700

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) 


3708
3709
3710
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3708

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:



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

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) 


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

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


3738
3739
3740
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3738

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) 


3748
3749
3750
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3748

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) 


3755
3756
3757
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3755

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


3768
3769
3770
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3768

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) 


3775
3776
3777
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3775

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:



3783
3784
3785
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3783

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


3789
3790
3791
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3789

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:



3794
3795
3796
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3794

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) 


3801
3802
3803
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3801

def 
  @service_account
end

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

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

Returns:



3806
3807
3808
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3806

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) 


3812
3813
3814
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3812

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


3821
3822
3823
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3821

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:



3828
3829
3830
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3828

def taints
  @taints
end

#windows_node_config ⇒ Google::Apis::ContainerV1beta1::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:



3835
3836
3837
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3835

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



3841
3842
3843
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3841

def workload_metadata_config
  @workload_metadata_config
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3848
3849
3850
3851
3852
3853
3854
3855
3856
3857
3858
3859
3860
3861
3862
3863
3864
3865
3866
3867
3868
3869
3870
3871
3872
3873
3874
3875
3876
3877
3878
3879
3880
3881
3882
3883
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3848

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