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.



5129
5130
5131
 
# File 'lib/google/apis/container_v1/classes.rb', line 5129

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) 


5031
5032
5033
 
# File 'lib/google/apis/container_v1/classes.rb', line 5031

def cluster_id
  @cluster_id
end

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

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

Returns:



5037
5038
5039
 
# File 'lib/google/apis/container_v1/classes.rb', line 5037

def gcfs_config
  @gcfs_config
end

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

Configuration of gVNIC feature. Corresponds to the JSON property gvnic

Returns:



5042
5043
5044
 
# File 'lib/google/apis/container_v1/classes.rb', line 5042

def gvnic
  @gvnic
end

#image_type ⇒ String

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

Returns:

  • (String) 


5047
5048
5049
 
# File 'lib/google/apis/container_v1/classes.rb', line 5047

def image_type
  @image_type
end

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

Node kubelet configs. Corresponds to the JSON property kubeletConfig

Returns:



5052
5053
5054
 
# File 'lib/google/apis/container_v1/classes.rb', line 5052

def kubelet_config
  @kubelet_config
end

#linux_node_config ⇒ Google::Apis::ContainerV1::LinuxNodeConfig

Parameters that can be configured on Linux nodes. Corresponds to the JSON property linuxNodeConfig

Returns:



5057
5058
5059
 
# File 'lib/google/apis/container_v1/classes.rb', line 5057

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


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

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) 


5072
5073
5074
 
# File 'lib/google/apis/container_v1/classes.rb', line 5072

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) 


5078
5079
5080
 
# File 'lib/google/apis/container_v1/classes.rb', line 5078

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) 


5089
5090
5091
 
# File 'lib/google/apis/container_v1/classes.rb', line 5089

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) 


5096
5097
5098
 
# File 'lib/google/apis/container_v1/classes.rb', line 5096

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:



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

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:



5120
5121
5122
 
# File 'lib/google/apis/container_v1/classes.rb', line 5120

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) 


5127
5128
5129
 
# File 'lib/google/apis/container_v1/classes.rb', line 5127

def zone
  @zone
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



5134
5135
5136
5137
5138
5139
5140
5141
5142
5143
5144
5145
5146
5147
5148
5149
 
# File 'lib/google/apis/container_v1/classes.rb', line 5134

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