Class: Google::Apis::ContainerV1beta1::UpdateNodePoolRequest

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

SetNodePoolVersionRequest updates the version of a node pool.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UpdateNodePoolRequest

Returns a new instance of UpdateNodePoolRequest.



11302
11303
11304
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11302

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:



11021
11022
11023
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11021

def accelerators
  @accelerators
end

#boot_disk ⇒ Google::Apis::ContainerV1beta1::BootDisk

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

Returns:



11026
11027
11028
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11026

def boot_disk
  @boot_disk
end

#cluster_id ⇒ String

Deprecated. The name of the cluster to upgrade. This field has been deprecated and replaced by the name field. Corresponds to the JSON property clusterId

Returns:

  • (String) 


11032
11033
11034
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11032

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



11038
11039
11040
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11038

def confidential_nodes
  @confidential_nodes
end

#consolidation_delay ⇒ String

Consolidation delay defines duration after which the Cluster Autoscaler can scale down underutilized nodes. If not set, nodes are scaled down by default behavior, i.e. according to the chosen autoscaling profile. Corresponds to the JSON property consolidationDelay

Returns:

  • (String) 


11045
11046
11047
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11045

def consolidation_delay
  @consolidation_delay
end

#containerd_config ⇒ Google::Apis::ContainerV1beta1::ContainerdConfig

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

Returns:



11050
11051
11052
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11050

def containerd_config
  @containerd_config
end

#disk_size_gb ⇒ Fixnum

Optional. The desired disk size for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk size. Corresponds to the JSON property diskSizeGb

Returns:

  • (Fixnum) 


11057
11058
11059
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11057

def disk_size_gb
  @disk_size_gb
end

#disk_type ⇒ String

Optional. The desired disk type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified disk type. Corresponds to the JSON property diskType

Returns:

  • (String) 


11064
11065
11066
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11064

def disk_type
  @disk_type
end

#etag ⇒ String

The current etag of the node pool. If an etag is provided and does not match the current etag of the node pool, update will be blocked and an ABORTED error will be returned. Corresponds to the JSON property etag

Returns:

  • (String) 


11071
11072
11073
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11071

def etag
  @etag
end

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

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

Returns:



11076
11077
11078
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11076

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) 


11081
11082
11083
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11081

def flex_start
  @flex_start
end

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

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

Returns:



11087
11088
11089
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11087

def gcfs_config
  @gcfs_config
end

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

Configuration of gVNIC feature. Corresponds to the JSON property gvnic

Returns:



11092
11093
11094
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11092

def gvnic
  @gvnic
end

#image ⇒ String

The desired name of the image name to use for this node. This is used to create clusters using a custom image. Corresponds to the JSON property image

Returns:

  • (String) 


11098
11099
11100
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11098

def image
  @image
end

#image_project ⇒ String

The project containing the desired image to use for this node pool. This is used to create clusters using a custom image. Corresponds to the JSON property imageProject

Returns:

  • (String) 


11104
11105
11106
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11104

def image_project
  @image_project
end

#image_type ⇒ String

Required. The desired image type for the node pool. Please see https://cloud. google.com/kubernetes-engine/docs/concepts/node-images for available image types. Corresponds to the JSON property imageType

Returns:

  • (String) 


11111
11112
11113
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11111

def image_type
  @image_type
end

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

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



11116
11117
11118
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11116

def kubelet_config
  @kubelet_config
end

#labels ⇒ Google::Apis::ContainerV1beta1::NodeLabels

Collection of node-level Kubernetes labels. Corresponds to the JSON property labels

Returns:



11122
11123
11124
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11122

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:



11127
11128
11129
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11127

def linux_node_config
  @linux_node_config
end

#locations ⇒ Array<String>

The desired list of Google Compute Engine zones in which the node pool's nodes should be located. Changing the locations for a node pool will result in nodes being either created or removed from the node pool, depending on whether locations are being added or removed. Warning: It is recommended to update node pool locations in a standalone API call. Do not combine a location update with changes to other fields (such as tags, labels, taints, etc.) in the same request. Otherwise, the API performs a structural modification where changes to other fields will only apply to newly created nodes and will not be applied to existing nodes in the node pool. To ensure all nodes are updated consistently, use a separate API call for location changes. Corresponds to the JSON property locations

Returns:

  • (Array<String>) 


11142
11143
11144
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11142

def locations
  @locations
end

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

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

Returns:



11147
11148
11149
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11147

def logging_config
  @logging_config
end

#machine_type ⇒ String

Optional. The desired machine type for nodes in the node pool. Initiates an upgrade operation that migrates the nodes in the node pool to the specified machine type. Corresponds to the JSON property machineType

Returns:

  • (String) 


11154
11155
11156
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11154

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) 


11160
11161
11162
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11160

def max_run_duration
  @max_run_duration
end

#name ⇒ String

The name (project, location, cluster, node pool) of the node pool to update. Specified in the format projects/*/locations/*/clusters/*/nodePools/*. Corresponds to the JSON property name

Returns:

  • (String) 


11166
11167
11168
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11166

def name
  @name
end

#node_drain_config ⇒ Google::Apis::ContainerV1beta1::NodeDrainConfig

NodeDrainConfig contains the node drain related configurations for this node pool. Corresponds to the JSON property nodeDrainConfig

Returns:



11172
11173
11174
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11172

def node_drain_config
  @node_drain_config
end

#node_network_config ⇒ Google::Apis::ContainerV1beta1::NodeNetworkConfig

Parameters for node pool-level network config. Corresponds to the JSON property nodeNetworkConfig

Returns:



11177
11178
11179
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11177

def node_network_config
  @node_network_config
end

#node_pool_id ⇒ String

Deprecated. The name of the node pool to upgrade. This field has been deprecated and replaced by the name field. Corresponds to the JSON property nodePoolId

Returns:

  • (String) 


11183
11184
11185
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11183

def node_pool_id
  @node_pool_id
end

#node_version ⇒ String

Required. The Kubernetes version to change the nodes to (typically an upgrade). Users may specify either explicit versions offered by Kubernetes Engine or version aliases, which have the following behavior: - "latest": picks the highest valid Kubernetes version - "1.X": picks the highest valid patch+gke.N patch in the 1.X version - "1.X.Y": picks the highest valid gke.N patch in the 1.X.Y version - "1.X.Y-gke.N": picks an explicit Kubernetes version - "-": picks the Kubernetes master version Corresponds to the JSON property nodeVersion

Returns:

  • (String) 


11194
11195
11196
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11194

def node_version
  @node_version
end

#project_id ⇒ String

Deprecated. The Google Developers Console project ID or project number. This field has been deprecated and replaced by the name field. Corresponds to the JSON property projectId

Returns:

  • (String) 


11201
11202
11203
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11201

def project_id
  @project_id
end

#queued_provisioning ⇒ Google::Apis::ContainerV1beta1::QueuedProvisioning

QueuedProvisioning defines the queued provisioning used by the node pool. Corresponds to the JSON property queuedProvisioning

Returns:



11206
11207
11208
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11206

def queued_provisioning
  @queued_provisioning
end

#resource_labels ⇒ Google::Apis::ContainerV1beta1::ResourceLabels

Collection of Resource Manager labels. Corresponds to the JSON property resourceLabels

Returns:



11212
11213
11214
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11212

def resource_labels
  @resource_labels
end

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



11221
11222
11223
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11221

def resource_manager_tags
  @resource_manager_tags
end

#storage_pools ⇒ Array<String>

List of Storage Pools where boot disks are provisioned. Existing Storage Pools will be replaced with storage-pools. Corresponds to the JSON property storagePools

Returns:

  • (Array<String>) 


11227
11228
11229
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11227

def storage_pools
  @storage_pools
end

#tags ⇒ Google::Apis::ContainerV1beta1::NetworkTags

Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. (See tags field in NodeConfig). Corresponds to the JSON property tags

Returns:



11234
11235
11236
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11234

def tags
  @tags
end

#taint_config ⇒ Google::Apis::ContainerV1beta1::TaintConfig

TaintConfig contains the configuration for the taints of the node pool. Corresponds to the JSON property taintConfig

Returns:



11239
11240
11241
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11239

def taint_config
  @taint_config
end

#taints ⇒ Google::Apis::ContainerV1beta1::NodeTaints

Collection of Kubernetes node taints. Corresponds to the JSON property taints

Returns:



11245
11246
11247
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11245

def taints
  @taints
end

#upgrade_settings ⇒ Google::Apis::ContainerV1beta1::UpgradeSettings

These upgrade settings control the level of parallelism and the level of disruption caused by an upgrade. maxUnavailable controls the number of nodes that can be simultaneously unavailable. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). Note: upgrades inevitably introduce some disruption since workloads need to be moved from old nodes to new, upgraded ones. Even if maxUnavailable=0, this holds true. (Disruption stays within the limits of PodDisruptionBudget, if it is configured.) Consider a hypothetical node pool with 5 nodes having maxSurge=2, maxUnavailable=1. This means the upgrade process upgrades 3 nodes simultaneously. It creates 2 additional ( upgraded) nodes, then it brings down 3 old (not yet upgraded) nodes at the same time. This ensures that there are always at least 4 nodes available. These upgrade settings configure the upgrade strategy for the node pool. Use strategy to switch between the strategies applied to the node pool. If the strategy is SURGE, use max_surge and max_unavailable to control the level of parallelism and the level of disruption caused by upgrade. 1. maxSurge controls the number of additional nodes that can be added to the node pool temporarily for the time of the upgrade to increase the number of available nodes. 2. maxUnavailable controls the number of nodes that can be simultaneously unavailable. 3. (maxUnavailable + maxSurge) determines the level of parallelism (how many nodes are being upgraded at the same time). If the strategy is BLUE_GREEN, use blue_green_settings to configure the blue- green upgrade related settings. 1. standard_rollout_policy is the default policy. The policy is used to control the way blue pool gets drained. The draining is executed in the batch mode. The batch size could be specified as either percentage of the node pool size or the number of nodes. batch_soak_duration is the soak time after each batch gets drained. 2. node_pool_soak_duration is the soak time after all blue nodes are drained. After this period, the blue pool nodes will be deleted. Corresponds to the JSON property upgradeSettings

Returns:



11280
11281
11282
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11280

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



11287
11288
11289
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11287

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:



11293
11294
11295
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11293

def workload_metadata_config
  @workload_metadata_config
end

#zone ⇒ String

Deprecated. The name of the Google Compute Engine zone in which the cluster resides. This field has been deprecated and replaced by the name field. Corresponds to the JSON property zone

Returns:

  • (String) 


11300
11301
11302
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11300

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11307
11308
11309
11310
11311
11312
11313
11314
11315
11316
11317
11318
11319
11320
11321
11322
11323
11324
11325
11326
11327
11328
11329
11330
11331
11332
11333
11334
11335
11336
11337
11338
11339
11340
11341
11342
11343
11344
11345
11346
11347
11348
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 11307

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @boot_disk = args[:boot_disk] if args.key?(:boot_disk)
  @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
  @confidential_nodes = args[:confidential_nodes] if args.key?(:confidential_nodes)
  @consolidation_delay = args[:consolidation_delay] if args.key?(:consolidation_delay)
  @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)
  @etag = args[:etag] if args.key?(:etag)
  @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 = args[:image] if args.key?(:image)
  @image_project = args[:image_project] if args.key?(:image_project)
  @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)
  @locations = args[:locations] if args.key?(:locations)
  @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)
  @name = args[:name] if args.key?(:name)
  @node_drain_config = args[:node_drain_config] if args.key?(:node_drain_config)
  @node_network_config = args[:node_network_config] if args.key?(:node_network_config)
  @node_pool_id = args[:node_pool_id] if args.key?(:node_pool_id)
  @node_version = args[:node_version] if args.key?(:node_version)
  @project_id = args[:project_id] if args.key?(:project_id)
  @queued_provisioning = args[:queued_provisioning] if args.key?(:queued_provisioning)
  @resource_labels = args[:resource_labels] if args.key?(:resource_labels)
  @resource_manager_tags = args[:resource_manager_tags] if args.key?(:resource_manager_tags)
  @storage_pools = args[:storage_pools] if args.key?(:storage_pools)
  @tags = args[:tags] if args.key?(:tags)
  @taint_config = args[:taint_config] if args.key?(:taint_config)
  @taints = args[:taints] if args.key?(:taints)
  @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings)
  @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)
  @zone = args[:zone] if args.key?(:zone)
end