Show / Hide Table of Contents

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
Implements
IDirectResponseSchema
Inherited Members
object.Equals(object)
object.Equals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
object.ReferenceEquals(object, object)
object.ToString()
Namespace: Google.Apis.Container.v1beta1.Data
Assembly: Google.Apis.Container.v1beta1.dll
Syntax
public class NodePool : IDirectResponseSchema

Properties

AutopilotConfig

Specifies the autopilot configuration for this node pool. This field is exclusively reserved for Cluster Autoscaler.

Declaration
[JsonProperty("autopilotConfig")]
public virtual AutopilotConfig AutopilotConfig { get; set; }
Property Value
Type Description
AutopilotConfig

Autoscaling

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

Declaration
[JsonProperty("autoscaling")]
public virtual NodePoolAutoscaling Autoscaling { get; set; }
Property Value
Type Description
NodePoolAutoscaling

BestEffortProvisioning

Enable best effort provisioning for nodes

Declaration
[JsonProperty("bestEffortProvisioning")]
public virtual BestEffortProvisioning BestEffortProvisioning { get; set; }
Property Value
Type Description
BestEffortProvisioning

Conditions

Which conditions caused the current node pool state.

Declaration
[JsonProperty("conditions")]
public virtual IList<StatusCondition> Conditions { get; set; }
Property Value
Type Description
IList<StatusCondition>

Config

The node configuration of the pool.

Declaration
[JsonProperty("config")]
public virtual NodeConfig Config { get; set; }
Property Value
Type Description
NodeConfig

ETag

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.

Declaration
[JsonProperty("etag")]
public virtual string ETag { get; set; }
Property Value
Type Description
string

InitialNodeCount

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.

Declaration
[JsonProperty("initialNodeCount")]
public virtual int? InitialNodeCount { get; set; }
Property Value
Type Description
int?

InstanceGroupUrls

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.

Declaration
[JsonProperty("instanceGroupUrls")]
public virtual IList<string> InstanceGroupUrls { get; set; }
Property Value
Type Description
IList<string>

Locations

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.

Declaration
[JsonProperty("locations")]
public virtual IList<string> Locations { get; set; }
Property Value
Type Description
IList<string>

Management

NodeManagement configuration for this NodePool.

Declaration
[JsonProperty("management")]
public virtual NodeManagement Management { get; set; }
Property Value
Type Description
NodeManagement

MaxPodsConstraint

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

Declaration
[JsonProperty("maxPodsConstraint")]
public virtual MaxPodsConstraint MaxPodsConstraint { get; set; }
Property Value
Type Description
MaxPodsConstraint

Name

The name of the node pool.

Declaration
[JsonProperty("name")]
public virtual string Name { get; set; }
Property Value
Type Description
string

NetworkConfig

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

Declaration
[JsonProperty("networkConfig")]
public virtual NodeNetworkConfig NetworkConfig { get; set; }
Property Value
Type Description
NodeNetworkConfig

PlacementPolicy

Specifies the node placement policy.

Declaration
[JsonProperty("placementPolicy")]
public virtual PlacementPolicy PlacementPolicy { get; set; }
Property Value
Type Description
PlacementPolicy

PodIpv4CidrSize

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

Declaration
[JsonProperty("podIpv4CidrSize")]
public virtual int? PodIpv4CidrSize { get; set; }
Property Value
Type Description
int?

QueuedProvisioning

Specifies the configuration of queued provisioning.

Declaration
[JsonProperty("queuedProvisioning")]
public virtual QueuedProvisioning QueuedProvisioning { get; set; }
Property Value
Type Description
QueuedProvisioning

SelfLink

Output only. Server-defined URL for the resource.

Declaration
[JsonProperty("selfLink")]
public virtual string SelfLink { get; set; }
Property Value
Type Description
string

Status

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

Declaration
[JsonProperty("status")]
public virtual string Status { get; set; }
Property Value
Type Description
string

StatusMessage

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

Declaration
[JsonProperty("statusMessage")]
public virtual string StatusMessage { get; set; }
Property Value
Type Description
string

UpdateInfo

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

Declaration
[JsonProperty("updateInfo")]
public virtual UpdateInfo UpdateInfo { get; set; }
Property Value
Type Description
UpdateInfo

UpgradeSettings

Upgrade settings control disruption and speed of the upgrade.

Declaration
[JsonProperty("upgradeSettings")]
public virtual UpgradeSettings UpgradeSettings { get; set; }
Property Value
Type Description
UpgradeSettings

Version

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

Declaration
[JsonProperty("version")]
public virtual string Version { get; set; }
Property Value
Type Description
string

Implements

IDirectResponseSchema
In this article
Back to top Generated by DocFX