Google Kubernetes Engine v1 API - Class NodePool (3.15.0)

public sealed class NodePool : IMessage<NodePool>, IEquatable<NodePool>, IDeepCloneable<NodePool>, IBufferMessage, IMessage

Reference documentation and code samples for the Google Kubernetes Engine v1 API class 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.

Inheritance

object > NodePool

Namespace

Google.Cloud.Container.V1

Assembly

Google.Cloud.Container.V1.dll

Constructors

NodePool()

public NodePool()

NodePool(NodePool)

public NodePool(NodePool other)
Parameter
NameDescription
otherNodePool

Properties

Autoscaling

public NodePoolAutoscaling Autoscaling { get; set; }

Autoscaler configuration for this NodePool. Autoscaler is enabled only if a valid configuration is present.

Property Value
TypeDescription
NodePoolAutoscaling

BestEffortProvisioning

public BestEffortProvisioning BestEffortProvisioning { get; set; }

Enable best effort provisioning for nodes

Property Value
TypeDescription
BestEffortProvisioning

Conditions

public RepeatedField<StatusCondition> Conditions { get; }

Which conditions caused the current node pool state.

Property Value
TypeDescription
RepeatedFieldStatusCondition

Config

public NodeConfig Config { get; set; }

The node configuration of the pool.

Property Value
TypeDescription
NodeConfig

Etag

public string Etag { get; set; }

This checksum is computed by the server based on the value of node pool fields, and may be sent on update requests to ensure the client has an up-to-date value before proceeding.

Property Value
TypeDescription
string

InitialNodeCount

public int InitialNodeCount { get; set; }

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.

Property Value
TypeDescription
int

InstanceGroupUrls

public RepeatedField<string> InstanceGroupUrls { get; }

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

Property Value
TypeDescription
RepeatedFieldstring

Locations

public RepeatedField<string> Locations { get; }

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.

Property Value
TypeDescription
RepeatedFieldstring

Management

public NodeManagement Management { get; set; }

NodeManagement configuration for this NodePool.

Property Value
TypeDescription
NodeManagement

MaxPodsConstraint

public MaxPodsConstraint MaxPodsConstraint { get; set; }

The constraint on the maximum number of pods that can be run simultaneously on a node in the node pool.

Property Value
TypeDescription
MaxPodsConstraint

Name

public string Name { get; set; }

The name of the node pool.

Property Value
TypeDescription
string

NetworkConfig

public NodeNetworkConfig NetworkConfig { get; set; }

Networking configuration for this NodePool. If specified, it overrides the cluster-level defaults.

Property Value
TypeDescription
NodeNetworkConfig

PlacementPolicy

public NodePool.Types.PlacementPolicy PlacementPolicy { get; set; }

Specifies the node placement policy.

Property Value
TypeDescription
NodePoolTypesPlacementPolicy

PodIpv4CidrSize

public int PodIpv4CidrSize { get; set; }

[Output only] The pod CIDR block size per node in this node pool.

Property Value
TypeDescription
int
public string SelfLink { get; set; }

[Output only] Server-defined URL for the resource.

Property Value
TypeDescription
string

Status

public NodePool.Types.Status Status { get; set; }

[Output only] The status of the nodes in this pool instance.

Property Value
TypeDescription
NodePoolTypesStatus

StatusMessage

[Obsolete]
public string StatusMessage { get; set; }

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

Property Value
TypeDescription
string

UpdateInfo

public NodePool.Types.UpdateInfo UpdateInfo { get; set; }

Output only. [Output only] Update info contains relevant information during a node pool update.

Property Value
TypeDescription
NodePoolTypesUpdateInfo

UpgradeSettings

public NodePool.Types.UpgradeSettings UpgradeSettings { get; set; }

Upgrade settings control disruption and speed of the upgrade.

Property Value
TypeDescription
NodePoolTypesUpgradeSettings

Version

public string Version { get; set; }

The version of Kubernetes running on this NodePool's nodes. If unspecified, it defaults as described here.

Property Value
TypeDescription
string