Class: Google::Apis::ContainerV1::NodePool

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

NodePool contains the name and configuration for a cluster's node pool. Node pools are a set of nodes (i.e. VM's), with a common configuration and specification, under the control of the cluster master. They may have a set of Kubernetes labels applied to them, which may be used to reference them during pod scheduling. They may also be resized up or down, to accommodate the workload.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NodePool

Returns a new instance of NodePool.



3357
3358
3359
 
# File 'lib/google/apis/container_v1/classes.rb', line 3357

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

Instance Attribute Details

#autoscaling ⇒ Google::Apis::ContainerV1::NodePoolAutoscaling

NodePoolAutoscaling contains information required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Corresponds to the JSON property autoscaling

Returns:



3253
3254
3255
 
# File 'lib/google/apis/container_v1/classes.rb', line 3253

def autoscaling
  @autoscaling
end

#conditions ⇒ Array<Google::Apis::ContainerV1::StatusCondition>

Which conditions caused the current node pool state. Corresponds to the JSON property conditions

Returns:



3258
3259
3260
 
# File 'lib/google/apis/container_v1/classes.rb', line 3258

def conditions
  @conditions
end

#config ⇒ Google::Apis::ContainerV1::NodeConfig

Parameters that describe the nodes in a cluster. *Note: *GKE Autopilot clusters do not recognize parameters in NodeConfig. Use AutoprovisioningNodePoolDefaults instead. Corresponds to the JSON property config

Returns:



3265
3266
3267
 
# File 'lib/google/apis/container_v1/classes.rb', line 3265

def config
  @config
end

#initial_node_count ⇒ Fixnum

The initial node count for the pool. You must ensure that your Compute Engine resource quota is sufficient for this number of instances. You must also have available firewall and routes quota. Corresponds to the JSON property initialNodeCount

Returns:

  • (Fixnum) 


3273
3274
3275
 
# File 'lib/google/apis/container_v1/classes.rb', line 3273

def initial_node_count
  @initial_node_count
end

#instance_group_urls ⇒ Array<String>

[Output only] The resource URLs of the managed instance groups associated with this node pool. Corresponds to the JSON property instanceGroupUrls

Returns:

  • (Array<String>) 


3280
3281
3282
 
# File 'lib/google/apis/container_v1/classes.rb', line 3280

def instance_group_urls
  @instance_group_urls
end

#locations ⇒ Array<String>

The list of Google Compute Engine zones in which the NodePool's nodes should be located. If this value is unspecified during node pool creation, the Cluster.Locations value will be used, instead. Warning: changing node pool locations will result in nodes being added and/or removed. Corresponds to the JSON property locations

Returns:

  • (Array<String>) 


3290
3291
3292
 
# File 'lib/google/apis/container_v1/classes.rb', line 3290

def locations
  @locations
end

#management ⇒ Google::Apis::ContainerV1::NodeManagement

NodeManagement defines the set of node management services turned on for the node pool. Corresponds to the JSON property management

Returns:



3296
3297
3298
 
# File 'lib/google/apis/container_v1/classes.rb', line 3296

def management
  @management
end

#max_pods_constraint ⇒ Google::Apis::ContainerV1::MaxPodsConstraint

Constraints applied to pods. Corresponds to the JSON property maxPodsConstraint

Returns:



3301
3302
3303
 
# File 'lib/google/apis/container_v1/classes.rb', line 3301

def max_pods_constraint
  @max_pods_constraint
end

#name ⇒ String

The name of the node pool. Corresponds to the JSON property name

Returns:

  • (String) 


3306
3307
3308
 
# File 'lib/google/apis/container_v1/classes.rb', line 3306

def name
  @name
end

#network_config ⇒ Google::Apis::ContainerV1::NodeNetworkConfig

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

Returns:



3311
3312
3313
 
# File 'lib/google/apis/container_v1/classes.rb', line 3311

def network_config
  @network_config
end

#pod_ipv4_cidr_size ⇒ Fixnum

[Output only] The pod CIDR block size per node in this node pool. Corresponds to the JSON property podIpv4CidrSize

Returns:

  • (Fixnum) 


3316
3317
3318
 
# File 'lib/google/apis/container_v1/classes.rb', line 3316

def pod_ipv4_cidr_size
  @pod_ipv4_cidr_size
end

#self_link ⇒ String

[Output only] Server-defined URL for the resource. Corresponds to the JSON property selfLink

Returns:

  • (String) 


3321
3322
3323
 
# File 'lib/google/apis/container_v1/classes.rb', line 3321

def self_link
  @self_link
end

#status ⇒ String

[Output only] The status of the nodes in this pool instance. Corresponds to the JSON property status

Returns:

  • (String) 


3326
3327
3328
 
# File 'lib/google/apis/container_v1/classes.rb', line 3326

def status
  @status
end

#status_message ⇒ String

[Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available. Corresponds to the JSON property statusMessage

Returns:

  • (String) 


3332
3333
3334
 
# File 'lib/google/apis/container_v1/classes.rb', line 3332

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



3350
3351
3352
 
# File 'lib/google/apis/container_v1/classes.rb', line 3350

def upgrade_settings
  @upgrade_settings
end

#version ⇒ String

The version of the Kubernetes of this node. Corresponds to the JSON property version

Returns:

  • (String) 


3355
3356
3357
 
# File 'lib/google/apis/container_v1/classes.rb', line 3355

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
 
# File 'lib/google/apis/container_v1/classes.rb', line 3362

def update!(**args)
  @autoscaling = args[:autoscaling] if args.key?(:autoscaling)
  @conditions = args[:conditions] if args.key?(:conditions)
  @config = args[:config] if args.key?(:config)
  @initial_node_count = args[:initial_node_count] if args.key?(:initial_node_count)
  @instance_group_urls = args[:instance_group_urls] if args.key?(:instance_group_urls)
  @locations = args[:locations] if args.key?(:locations)
  @management = args[:management] if args.key?(:management)
  @max_pods_constraint = args[:max_pods_constraint] if args.key?(:max_pods_constraint)
  @name = args[:name] if args.key?(:name)
  @network_config = args[:network_config] if args.key?(:network_config)
  @pod_ipv4_cidr_size = args[:pod_ipv4_cidr_size] if args.key?(:pod_ipv4_cidr_size)
  @self_link = args[:self_link] if args.key?(:self_link)
  @status = args[:status] if args.key?(:status)
  @status_message = args[:status_message] if args.key?(:status_message)
  @upgrade_settings = args[:upgrade_settings] if args.key?(:upgrade_settings)
  @version = args[:version] if args.key?(:version)
end