Class NodePool

Provides a Rancher v2 Node Pool resource. This can be used to create Node Pool, using Node template for Rancher v2 RKE clusters and retrieve their information.

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

Assembly: Pulumi.Rancher2.dll

Syntax

public class NodePool : CustomResource

Constructors

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

Annotations

Annotations for Node Pool object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Annotations { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

ClusterId

The RKE cluster id to use Node Pool (string)

Declaration

public Output<string> ClusterId { get; }

Property Value

Type	Description
Output<System.String>

ControlPlane

RKE control plane role for created nodes (bool)

Declaration

public Output<bool?> ControlPlane { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

DeleteNotReadyAfterSecs

Delete not ready node after secs. For Rancher v2.3.3 or above. Default 0 (int)

Declaration

public Output<int?> DeleteNotReadyAfterSecs { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Etcd

RKE etcd role for created nodes (bool)

Declaration

public Output<bool?> Etcd { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

HostnamePrefix

The prefix for created nodes of the Node Pool (string)

Declaration

public Output<string> HostnamePrefix { get; }

Property Value

Type	Description
Output<System.String>

Labels

Labels for Node Pool object (map)

Declaration

public Output<ImmutableDictionary<string, object>> Labels { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>

Name

The name of the Node Pool (string)

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

NodeTaints

Node taints. For Rancher v2.3.3 or above (List)

Declaration

public Output<ImmutableArray<NodePoolNodeTaint>> NodeTaints { get; }

Property Value

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

NodeTemplateId

The Node Template ID to use for node creation (string)

Declaration

public Output<string> NodeTemplateId { get; }

Property Value

Type	Description
Output<System.String>

Quantity

The number of nodes to create on Node Pool. Default 1. Only values >= 1 allowed (int)

Declaration

public Output<int?> Quantity { get; }

Property Value

Type	Description
Output<System.Nullable<System.Int32>>

Worker

RKE role role for created nodes (bool)

Declaration

public Output<bool?> Worker { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

Methods

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