Kubernetes Engine V1beta1 API - Class Google::Cloud::Container::V1beta1::NodePool (v0.11.0)

Reference documentation and code samples for the Kubernetes Engine V1beta1 API class Google::Cloud::Container::V1beta1::NodePool.

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.

Inherits

  • Object

Extended By

  • Google::Protobuf::MessageExts::ClassMethods

Includes

  • Google::Protobuf::MessageExts

Methods

#autoscaling

def autoscaling() -> ::Google::Cloud::Container::V1beta1::NodePoolAutoscaling
Returns

#autoscaling=

def autoscaling=(value) -> ::Google::Cloud::Container::V1beta1::NodePoolAutoscaling
Parameter
Returns

#conditions

def conditions() -> ::Array<::Google::Cloud::Container::V1beta1::StatusCondition>
Returns

#conditions=

def conditions=(value) -> ::Array<::Google::Cloud::Container::V1beta1::StatusCondition>
Parameter
Returns

#config

def config() -> ::Google::Cloud::Container::V1beta1::NodeConfig
Returns

#config=

def config=(value) -> ::Google::Cloud::Container::V1beta1::NodeConfig
Parameter
Returns

#initial_node_count

def initial_node_count() -> ::Integer
Returns
  • (::Integer) — 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.

#initial_node_count=

def initial_node_count=(value) -> ::Integer
Parameter
  • value (::Integer) — 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.
Returns
  • (::Integer) — 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.

#instance_group_urls

def instance_group_urls() -> ::Array<::String>
Returns
  • (::Array<::String>) — [Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.

#instance_group_urls=

def instance_group_urls=(value) -> ::Array<::String>
Parameter
  • value (::Array<::String>) — [Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.
Returns
  • (::Array<::String>) — [Output only] The resource URLs of the managed instance groups associated with this node pool. During the node pool blue-green upgrade operation, the URLs contain both blue and green resources.

#locations

def locations() -> ::Array<::String>
Returns
  • (::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.

#locations=

def locations=(value) -> ::Array<::String>
Parameter
  • value (::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.

Returns
  • (::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.

#management

def management() -> ::Google::Cloud::Container::V1beta1::NodeManagement
Returns

#management=

def management=(value) -> ::Google::Cloud::Container::V1beta1::NodeManagement
Parameter
Returns

#max_pods_constraint

def max_pods_constraint() -> ::Google::Cloud::Container::V1beta1::MaxPodsConstraint
Returns

#max_pods_constraint=

def max_pods_constraint=(value) -> ::Google::Cloud::Container::V1beta1::MaxPodsConstraint
Parameter
Returns

#name

def name() -> ::String
Returns
  • (::String) — The name of the node pool.

#name=

def name=(value) -> ::String
Parameter
  • value (::String) — The name of the node pool.
Returns
  • (::String) — The name of the node pool.

#network_config

def network_config() -> ::Google::Cloud::Container::V1beta1::NodeNetworkConfig
Returns

#network_config=

def network_config=(value) -> ::Google::Cloud::Container::V1beta1::NodeNetworkConfig
Parameter
Returns

#placement_policy

def placement_policy() -> ::Google::Cloud::Container::V1beta1::NodePool::PlacementPolicy
Returns

#placement_policy=

def placement_policy=(value) -> ::Google::Cloud::Container::V1beta1::NodePool::PlacementPolicy
Parameter
Returns

#pod_ipv4_cidr_size

def pod_ipv4_cidr_size() -> ::Integer
Returns
  • (::Integer) — [Output only] The pod CIDR block size per node in this node pool.

#pod_ipv4_cidr_size=

def pod_ipv4_cidr_size=(value) -> ::Integer
Parameter
  • value (::Integer) — [Output only] The pod CIDR block size per node in this node pool.
Returns
  • (::Integer) — [Output only] The pod CIDR block size per node in this node pool.

#self_link

def self_link() -> ::String
Returns
  • (::String) — [Output only] Server-defined URL for the resource.

#self_link=

def self_link=(value) -> ::String
Parameter
  • value (::String) — [Output only] Server-defined URL for the resource.
Returns
  • (::String) — [Output only] Server-defined URL for the resource.

#status

def status() -> ::Google::Cloud::Container::V1beta1::NodePool::Status
Returns

#status=

def status=(value) -> ::Google::Cloud::Container::V1beta1::NodePool::Status
Parameter
Returns

#status_message

def status_message() -> ::String
Returns
  • (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.

#status_message=

def status_message=(value) -> ::String
Parameter
  • value (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.
Returns
  • (::String) — [Output only] Deprecated. Use conditions instead. Additional information about the current status of this node pool instance, if available.

#update_info

def update_info() -> ::Google::Cloud::Container::V1beta1::NodePool::UpdateInfo
Returns

#upgrade_settings

def upgrade_settings() -> ::Google::Cloud::Container::V1beta1::NodePool::UpgradeSettings
Returns

#upgrade_settings=

def upgrade_settings=(value) -> ::Google::Cloud::Container::V1beta1::NodePool::UpgradeSettings
Parameter
Returns

#version

def version() -> ::String
Returns
  • (::String) — The version of the Kubernetes of this node.

#version=

def version=(value) -> ::String
Parameter
  • value (::String) — The version of the Kubernetes of this node.
Returns
  • (::String) — The version of the Kubernetes of this node.