Class NodePool

Manages a node pool in a Google Kubernetes Engine (GKE) cluster separately from the cluster control plane. For more information see the official documentation and the API reference.

Inheritance

System.Object

Resource

CustomResource

NodePool

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Gcp.Container

Assembly: Pulumi.Gcp.dll

Syntax

public class NodePool : CustomResource

Constructors

View Source

NodePool(String, NodePoolArgs, CustomResourceOptions)

Create a NodePool resource with the given unique name, arguments, and options.

Declaration

public NodePool(string name, NodePoolArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
NodePoolArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

View Source

Autoscaling

Configuration required by cluster autoscaler to adjust the size of the node pool to the current cluster usage. Structure is documented below.

Declaration

public Output<NodePoolAutoscaling> Autoscaling { get; }

Property Value

Type	Description
Output<NodePoolAutoscaling>

View Source

Cluster

The cluster to create the node pool for. Cluster must be present in location provided for zonal clusters.

Declaration

public Output<string> Cluster { get; }

Property Value

Type	Description
Output<System.String>

View Source

InitialNodeCount

The initial number of nodes for the pool. In regional or multi-zonal clusters, this is the number of nodes per zone. Changing this will force recreation of the resource.

Declaration

public Output<int> InitialNodeCount { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

InstanceGroupUrls

The resource URLs of the managed instance groups associated with this node pool.

Declaration

public Output<ImmutableArray<string>> InstanceGroupUrls { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Location

The location (region or zone) of the cluster.

Declaration

public Output<string> Location { get; }

Property Value

Type	Description
Output<System.String>

View Source

Management

Node management configuration, wherein auto-repair and auto-upgrade is configured. Structure is documented below.

Declaration

public Output<NodePoolManagement> Management { get; }

Property Value

Type	Description
Output<NodePoolManagement>

View Source

MaxPodsPerNode

The maximum number of pods per node in this node pool. Note that this does not work on node pools which are "route-based" - that is, node pools belonging to clusters that do not have IP Aliasing enabled. See the official documentation for more information.

Declaration

public Output<int> MaxPodsPerNode { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

Name

The name of the node pool. If left blank, the provider will auto-generate a unique name.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

View Source

NamePrefix

Creates a unique name for the node pool beginning with the specified prefix. Conflicts with name.

Declaration

public Output<string> NamePrefix { get; }

Property Value

Type	Description
Output<System.String>

View Source

NodeConfig

The node configuration of the pool. See gcp.container.Cluster for schema.

Declaration

public Output<NodePoolNodeConfig> NodeConfig { get; }

Property Value

Type	Description
Output<NodePoolNodeConfig>

View Source

NodeCount

The number of nodes per instance group. This field can be used to update the number of nodes per instance group but should not be used alongside autoscaling.

Declaration

public Output<int> NodeCount { get; }

Property Value

Type	Description
Output<System.Int32>

View Source

NodeLocations

The list of zones in which the node pool's nodes should be located. Nodes must be in the region of their regional cluster or in the same region as their cluster's zone for zonal clusters. If unspecified, the cluster-level node_locations will be used.

Declaration

public Output<ImmutableArray<string>> NodeLocations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

View Source

Project

The ID of the project in which to create the node pool. If blank, the provider-configured project will be used.

Declaration

public Output<string> Project { get; }

Property Value

Type	Description
Output<System.String>

View Source

UpgradeSettings

Specify node upgrade settings to change how many nodes GKE attempts to upgrade at once. The number of nodes upgraded simultaneously is the sum of max_surge and max_unavailable. The maximum number of nodes upgraded simultaneously is limited to 20.

Declaration

public Output<NodePoolUpgradeSettings> UpgradeSettings { get; }

Property Value

Type	Description
Output<NodePoolUpgradeSettings>

View Source

Version

The Kubernetes version for the nodes in this pool. Note that if this field and auto_upgrade are both specified, they will fight each other for what the node version should be, so setting both is highly discouraged. While a fuzzy version can be specified, it's recommended that you specify explicit versions as the provider will see spurious diffs when fuzzy versions are used. See the gcp.container.getEngineVersions data source's version_prefix field to approximate fuzzy versions in a provider-compatible way.

Declaration

public Output<string> Version { get; }

Property Value

Type	Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, NodePoolState, CustomResourceOptions)

Get an existing NodePool resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration

public static NodePool Get(string name, Input<string> id, NodePoolState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
NodePoolState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
NodePool