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.



5007
5008
5009
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5007

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

Instance Attribute Details

#cluster_id ⇒ String

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


4901
4902
4903
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4901

def cluster_id
  @cluster_id
end

#image_type ⇒ String

Required. The desired image type for the node pool. Corresponds to the JSON property imageType

Returns:

  • (String) 


4906
4907
4908
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4906

def image_type
  @image_type
end

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

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



4911
4912
4913
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4911

def kubelet_config
  @kubelet_config
end

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

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

Returns:



4917
4918
4919
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4917

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:



4922
4923
4924
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4922

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


4931
4932
4933
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4931

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


4937
4938
4939
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4937

def name
  @name
end

#node_pool_id ⇒ String

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


4943
4944
4945
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4943

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) 


4954
4955
4956
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4954

def node_version
  @node_version
end

#project_id ⇒ String

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


4961
4962
4963
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4961

def project_id
  @project_id
end

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

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

Returns:



4968
4969
4970
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4968

def tags
  @tags
end

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

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

Returns:



4974
4975
4976
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4974

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

Returns:



4992
4993
4994
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4992

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



4998
4999
5000
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 4998

def workload_metadata_config
  @workload_metadata_config
end

#zone ⇒ String

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


5005
5006
5007
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5005

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5012
5013
5014
5015
5016
5017
5018
5019
5020
5021
5022
5023
5024
5025
5026
5027
5028
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5012

def update!(**args)
  @cluster_id = args[:cluster_id] if args.key?(:cluster_id)
  @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)
  @name = args[:name] if args.key?(:name)
  @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)
  @tags = args[:tags] if args.key?(:tags)
  @taints = args[:taints] if args.key?(:taints)
  @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings)
  @workload_metadata_config = args[:workload_metadata_config] if args.key?(:workload_metadata_config)
  @zone = args[:zone] if args.key?(:zone)
end