Class: Google::Apis::ContainerV1::UpdateNodePoolRequest

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

UpdateNodePoolRequests update a node pool's image and/or version.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ UpdateNodePoolRequest

Returns a new instance of UpdateNodePoolRequest.



7548
7549
7550
 
# File 'lib/google/apis/container_v1/classes.rb', line 7548

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:



7319
7320
7321
 
# File 'lib/google/apis/container_v1/classes.rb', line 7319

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


7325
7326
7327
 
# File 'lib/google/apis/container_v1/classes.rb', line 7325

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



7331
7332
7333
 
# File 'lib/google/apis/container_v1/classes.rb', line 7331

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:



7336
7337
7338
 
# File 'lib/google/apis/container_v1/classes.rb', line 7336

def containerd_config
  @containerd_config
end

#disk_size_gb ⇒ Fixnum

Optional. The desired disk size for nodes in the node pool specified in GB. The smallest allowed disk size is 10GB. 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) 


7343
7344
7345
 
# File 'lib/google/apis/container_v1/classes.rb', line 7343

def disk_size_gb
  @disk_size_gb
end

#disk_type ⇒ String

Optional. The desired disk type (e.g. 'pd-standard', 'pd-ssd' or 'pd-balanced') 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) 


7350
7351
7352
 
# File 'lib/google/apis/container_v1/classes.rb', line 7350

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) 


7357
7358
7359
 
# File 'lib/google/apis/container_v1/classes.rb', line 7357

def etag
  @etag
end

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

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

Returns:



7362
7363
7364
 
# File 'lib/google/apis/container_v1/classes.rb', line 7362

def fast_socket
  @fast_socket
end

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

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

Returns:



7368
7369
7370
 
# File 'lib/google/apis/container_v1/classes.rb', line 7368

def gcfs_config
  @gcfs_config
end

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

Configuration of gVNIC feature. Corresponds to the JSON property gvnic

Returns:



7373
7374
7375
 
# File 'lib/google/apis/container_v1/classes.rb', line 7373

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


7380
7381
7382
 
# File 'lib/google/apis/container_v1/classes.rb', line 7380

def image_type
  @image_type
end

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

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



7385
7386
7387
 
# File 'lib/google/apis/container_v1/classes.rb', line 7385

def kubelet_config
  @kubelet_config
end

#labels ⇒ Google::Apis::ContainerV1::NodeLabels

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

Returns:



7391
7392
7393
 
# File 'lib/google/apis/container_v1/classes.rb', line 7391

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:



7396
7397
7398
 
# File 'lib/google/apis/container_v1/classes.rb', line 7396

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

Returns:

  • (Array<String>) 


7405
7406
7407
 
# File 'lib/google/apis/container_v1/classes.rb', line 7405

def locations
  @locations
end

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

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

Returns:



7410
7411
7412
 
# File 'lib/google/apis/container_v1/classes.rb', line 7410

def logging_config
  @logging_config
end

#machine_type ⇒ String

Optional. The desired Google Compute Engine 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) 


7418
7419
7420
 
# File 'lib/google/apis/container_v1/classes.rb', line 7418

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


7424
7425
7426
 
# File 'lib/google/apis/container_v1/classes.rb', line 7424

def name
  @name
end

#node_network_config ⇒ Google::Apis::ContainerV1::NodeNetworkConfig

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

Returns:



7429
7430
7431
 
# File 'lib/google/apis/container_v1/classes.rb', line 7429

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) 


7435
7436
7437
 
# File 'lib/google/apis/container_v1/classes.rb', line 7435

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) 


7446
7447
7448
 
# File 'lib/google/apis/container_v1/classes.rb', line 7446

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) 


7453
7454
7455
 
# File 'lib/google/apis/container_v1/classes.rb', line 7453

def project_id
  @project_id
end

#queued_provisioning ⇒ Google::Apis::ContainerV1::QueuedProvisioning

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

Returns:



7458
7459
7460
 
# File 'lib/google/apis/container_v1/classes.rb', line 7458

def queued_provisioning
  @queued_provisioning
end

#resource_labels ⇒ Google::Apis::ContainerV1::ResourceLabels

Collection of GCP labels. Corresponds to the JSON property resourceLabels

Returns:



7464
7465
7466
 
# File 'lib/google/apis/container_v1/classes.rb', line 7464

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:



7473
7474
7475
 
# File 'lib/google/apis/container_v1/classes.rb', line 7473

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


7479
7480
7481
 
# File 'lib/google/apis/container_v1/classes.rb', line 7479

def storage_pools
  @storage_pools
end

#tags ⇒ Google::Apis::ContainerV1::NetworkTags

Collection of Compute Engine network tags that can be applied to a node's underlying VM instance. Corresponds to the JSON property tags

Returns:



7485
7486
7487
 
# File 'lib/google/apis/container_v1/classes.rb', line 7485

def tags
  @tags
end

#taints ⇒ Google::Apis::ContainerV1::NodeTaints

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

Returns:



7491
7492
7493
 
# File 'lib/google/apis/container_v1/classes.rb', line 7491

def taints
  @taints
end

#upgrade_settings ⇒ Google::Apis::ContainerV1::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 ROLLING, 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:



7526
7527
7528
 
# File 'lib/google/apis/container_v1/classes.rb', line 7526

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



7533
7534
7535
 
# File 'lib/google/apis/container_v1/classes.rb', line 7533

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:



7539
7540
7541
 
# File 'lib/google/apis/container_v1/classes.rb', line 7539

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) 


7546
7547
7548
 
# File 'lib/google/apis/container_v1/classes.rb', line 7546

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



7553
7554
7555
7556
7557
7558
7559
7560
7561
7562
7563
7564
7565
7566
7567
7568
7569
7570
7571
7572
7573
7574
7575
7576
7577
7578
7579
7580
7581
7582
7583
7584
7585
7586
 
# File 'lib/google/apis/container_v1/classes.rb', line 7553

def update!(**args)
  @accelerators = args[:accelerators] if args.key?(:accelerators)
  @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
  @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)
  @etag = args[:etag] if args.key?(:etag)
  @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)
  @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)
  @name = args[:name] if args.key?(:name)
  @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)
  @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