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

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

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.



2775
2776
2777
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2775

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:



2678
2679
2680
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2678

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:



2683
2684
2685
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2683

def conditions
  @conditions
end

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

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

Returns:



2688
2689
2690
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2688

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) 


2696
2697
2698
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2696

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


2703
2704
2705
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2703

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. Corresponds to the JSON property locations

Returns:

  • (Array<String>) 


2709
2710
2711
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2709

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:



2715
2716
2717
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2715

def management
  @management
end

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

Constraints applied to pods. Corresponds to the JSON property maxPodsConstraint

Returns:



2720
2721
2722
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2720

def max_pods_constraint
  @max_pods_constraint
end

#name ⇒ String

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

Returns:

  • (String) 


2725
2726
2727
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2725

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


2730
2731
2732
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2730

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) 


2735
2736
2737
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2735

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) 


2740
2741
2742
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2740

def status
  @status
end

#status_message ⇒ String

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

Returns:

  • (String) 


2746
2747
2748
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2746

def status_message
  @status_message
end

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



2768
2769
2770
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2768

def upgrade_settings
  @upgrade_settings
end

#version ⇒ String

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

Returns:

  • (String) 


2773
2774
2775
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2773

def version
  @version
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
 
# File 'generated/google/apis/container_v1beta1/classes.rb', line 2780

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