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.



5167
5168
5169
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5167

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) 


5061
5062
5063
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5061

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) 


5066
5067
5068
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5066

def image_type
  @image_type
end

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

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



5071
5072
5073
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5071

def kubelet_config
  @kubelet_config
end

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

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

Returns:



5077
5078
5079
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5077

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:



5082
5083
5084
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5082

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


5091
5092
5093
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5091

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) 


5097
5098
5099
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5097

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) 


5103
5104
5105
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5103

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) 


5114
5115
5116
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5114

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) 


5121
5122
5123
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5121

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 underlying VM instance. (See tags field in NodeConfig). Corresponds to the JSON property tags

Returns:



5128
5129
5130
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5128

def tags
  @tags
end

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

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

Returns:



5134
5135
5136
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5134

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:



5152
5153
5154
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5152

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:



5158
5159
5160
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5158

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) 


5165
5166
5167
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5165

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5172
5173
5174
5175
5176
5177
5178
5179
5180
5181
5182
5183
5184
5185
5186
5187
5188
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 5172

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