Class: Google::Apis::ContainerV1beta1::NodePool

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

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

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ NodePool

Returns a new instance of NodePool.



3552
3553
3554
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3552

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

Instance Attribute Details

#autoscaling ⇒ Google::Apis::ContainerV1beta1::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:



3463
3464
3465
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3463

def autoscaling
  @autoscaling
end

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

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

Returns:



3468
3469
3470
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3468

def conditions
  @conditions
end

#config ⇒ Google::Apis::ContainerV1beta1::NodeConfig

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

Returns:



3473
3474
3475
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3473

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) 


3481
3482
3483
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3481

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


3488
3489
3490
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3488

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


3498
3499
3500
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3498

def locations
  @locations
end

#management ⇒ Google::Apis::ContainerV1beta1::NodeManagement

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

Returns:



3504
3505
3506
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3504

def management
  @management
end

#max_pods_constraint ⇒ Google::Apis::ContainerV1beta1::MaxPodsConstraint

Constraints applied to pods. Corresponds to the JSON property maxPodsConstraint

Returns:



3509
3510
3511
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3509

def max_pods_constraint
  @max_pods_constraint
end

#name ⇒ String

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

Returns:

  • (String) 


3514
3515
3516
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3514

def name
  @name
end

#network_config ⇒ Google::Apis::ContainerV1beta1::NodeNetworkConfig

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

Returns:



3519
3520
3521
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3519

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) 


3524
3525
3526
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3524

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) 


3529
3530
3531
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3529

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) 


3534
3535
3536
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3534

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) 


3540
3541
3542
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3540

def status_message
  @status_message
end

#upgrade_settings ⇒ Google::Apis::ContainerV1beta1::UpgradeSettings

Upgrade settings control disruption and speed of the upgrade. Corresponds to the JSON property upgradeSettings

Returns:



3545
3546
3547
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3545

def upgrade_settings
  @upgrade_settings
end

#version ⇒ String

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

Returns:

  • (String) 


3550
3551
3552
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3550

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
3573
3574
 
# File 'lib/google/apis/container_v1beta1/classes.rb', line 3557

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