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.



4256
4257
4258
 
# File 'lib/google/apis/container_v1/classes.rb', line 4256

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

Instance Attribute Details

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


4179
4180
4181
 
# File 'lib/google/apis/container_v1/classes.rb', line 4179

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) 


4184
4185
4186
 
# File 'lib/google/apis/container_v1/classes.rb', line 4184

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


4193
4194
4195
 
# File 'lib/google/apis/container_v1/classes.rb', line 4193

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) 


4199
4200
4201
 
# File 'lib/google/apis/container_v1/classes.rb', line 4199

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


4205
4206
4207
 
# File 'lib/google/apis/container_v1/classes.rb', line 4205

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) 


4216
4217
4218
 
# File 'lib/google/apis/container_v1/classes.rb', line 4216

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) 


4223
4224
4225
 
# File 'lib/google/apis/container_v1/classes.rb', line 4223

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

Returns:



4241
4242
4243
 
# File 'lib/google/apis/container_v1/classes.rb', line 4241

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



4247
4248
4249
 
# File 'lib/google/apis/container_v1/classes.rb', line 4247

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) 


4254
4255
4256
 
# File 'lib/google/apis/container_v1/classes.rb', line 4254

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



4261
4262
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272
 
# File 'lib/google/apis/container_v1/classes.rb', line 4261

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