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

Inherits:
Object
  • Object
show all
Includes:
Google::Apis::Core::Hashable, Google::Apis::Core::JsonObjectSupport
Defined in:
generated/google/apis/container_v1/classes.rb,
generated/google/apis/container_v1/representations.rb,
generated/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

Methods included from Google::Apis::Core::JsonObjectSupport

#to_json

Methods included from Google::Apis::Core::Hashable

process_value, #to_h

Constructor Details

#initialize(**args) ⇒ NodePool

Returns a new instance of NodePool.


2455
2456
2457
# File 'generated/google/apis/container_v1/classes.rb', line 2455

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

Instance Attribute Details

#autoscalingGoogle::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


2362
2363
2364
# File 'generated/google/apis/container_v1/classes.rb', line 2362

def autoscaling
  @autoscaling
end

#conditionsArray<Google::Apis::ContainerV1::StatusCondition>

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


2367
2368
2369
# File 'generated/google/apis/container_v1/classes.rb', line 2367

def conditions
  @conditions
end

#configGoogle::Apis::ContainerV1::NodeConfig

Parameters that describe the nodes in a cluster. Corresponds to the JSON property config


2372
2373
2374
# File 'generated/google/apis/container_v1/classes.rb', line 2372

def config
  @config
end

#initial_node_countFixnum

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)

2380
2381
2382
# File 'generated/google/apis/container_v1/classes.rb', line 2380

def initial_node_count
  @initial_node_count
end

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

2387
2388
2389
# File 'generated/google/apis/container_v1/classes.rb', line 2387

def instance_group_urls
  @instance_group_urls
end

#locationsArray<String>

The list of Google Compute Engine zones in which the NodePool's nodes should be located. Corresponds to the JSON property locations

Returns:

  • (Array<String>)

2393
2394
2395
# File 'generated/google/apis/container_v1/classes.rb', line 2393

def locations
  @locations
end

#managementGoogle::Apis::ContainerV1::NodeManagement

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


2399
2400
2401
# File 'generated/google/apis/container_v1/classes.rb', line 2399

def management
  @management
end

#max_pods_constraintGoogle::Apis::ContainerV1::MaxPodsConstraint

Constraints applied to pods. Corresponds to the JSON property maxPodsConstraint


2404
2405
2406
# File 'generated/google/apis/container_v1/classes.rb', line 2404

def max_pods_constraint
  @max_pods_constraint
end

#nameString

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

Returns:

  • (String)

2409
2410
2411
# File 'generated/google/apis/container_v1/classes.rb', line 2409

def name
  @name
end

#pod_ipv4_cidr_sizeFixnum

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

Returns:

  • (Fixnum)

2414
2415
2416
# File 'generated/google/apis/container_v1/classes.rb', line 2414

def pod_ipv4_cidr_size
  @pod_ipv4_cidr_size
end

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

Returns:

  • (String)

2419
2420
2421
# File 'generated/google/apis/container_v1/classes.rb', line 2419

def self_link
  @self_link
end

#statusString

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

Returns:

  • (String)

2424
2425
2426
# File 'generated/google/apis/container_v1/classes.rb', line 2424

def status
  @status
end

#status_messageString

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

Returns:

  • (String)

2430
2431
2432
# File 'generated/google/apis/container_v1/classes.rb', line 2430

def status_message
  @status_message
end

#upgrade_settingsGoogle::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


2448
2449
2450
# File 'generated/google/apis/container_v1/classes.rb', line 2448

def upgrade_settings
  @upgrade_settings
end

#versionString

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

Returns:

  • (String)

2453
2454
2455
# File 'generated/google/apis/container_v1/classes.rb', line 2453

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object


2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
# File 'generated/google/apis/container_v1/classes.rb', line 2460

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