rancher2.NodePool
Explore with Pulumi AI
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.
Example Usage
Coming soon!
Coming soon!
Coming soon!
Coming soon!
Coming soon!
resources:
# Create a new rancher2 RKE Cluster
foo-custom:
type: rancher2:Cluster
properties:
name: foo-custom
description: Foo rancher2 custom cluster
kind: rke
rkeConfig:
network:
plugin: canal
# Create a new rancher2 Cloud Credential
foo:
type: rancher2:CloudCredential
properties:
name: foo
description: Terraform cloudCredential acceptance test
amazonec2CredentialConfig:
accessKey: XXXXXXXXXXXXXXXXXXXX
secretKey: XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
# Create a new rancher2 Node Template
fooNodeTemplate:
type: rancher2:NodeTemplate
name: foo
properties:
name: foo
description: foo test
cloudCredentialId: ${foo.id}
amazonec2Config:
ami: <AMI_ID>
region: <REGION>
securityGroups:
- <AWS_SECURITY_GROUP>
subnetId: <SUBNET_ID>
vpcId: <VPC_ID>
zone: <ZONE>
# Create a new rancher2 Node Pool
fooNodePool:
type: rancher2:NodePool
name: foo
properties:
clusterId: ${["foo-custom"].id}
name: foo
hostnamePrefix: foo-cluster-0
nodeTemplateId: ${fooNodeTemplate.id}
quantity: 1
controlPlane: true
etcd: true
worker: true
Create NodePool Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new NodePool(name: string, args: NodePoolArgs, opts?: CustomResourceOptions);
@overload
def NodePool(resource_name: str,
args: NodePoolArgs,
opts: Optional[ResourceOptions] = None)
@overload
def NodePool(resource_name: str,
opts: Optional[ResourceOptions] = None,
hostname_prefix: Optional[str] = None,
cluster_id: Optional[str] = None,
node_template_id: Optional[str] = None,
delete_not_ready_after_secs: Optional[int] = None,
drain_before_delete: Optional[bool] = None,
etcd: Optional[bool] = None,
annotations: Optional[Mapping[str, str]] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
node_taints: Optional[Sequence[NodePoolNodeTaintArgs]] = None,
control_plane: Optional[bool] = None,
quantity: Optional[int] = None,
worker: Optional[bool] = None)
func NewNodePool(ctx *Context, name string, args NodePoolArgs, opts ...ResourceOption) (*NodePool, error)
public NodePool(string name, NodePoolArgs args, CustomResourceOptions? opts = null)
public NodePool(String name, NodePoolArgs args)
public NodePool(String name, NodePoolArgs args, CustomResourceOptions options)
type: rancher2:NodePool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args NodePoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var nodePoolResource = new Rancher2.NodePool("nodePoolResource", new()
{
HostnamePrefix = "string",
ClusterId = "string",
NodeTemplateId = "string",
DeleteNotReadyAfterSecs = 0,
DrainBeforeDelete = false,
Etcd = false,
Annotations =
{
{ "string", "string" },
},
Labels =
{
{ "string", "string" },
},
Name = "string",
NodeTaints = new[]
{
new Rancher2.Inputs.NodePoolNodeTaintArgs
{
Key = "string",
Value = "string",
Effect = "string",
TimeAdded = "string",
},
},
ControlPlane = false,
Quantity = 0,
Worker = false,
});
example, err := rancher2.NewNodePool(ctx, "nodePoolResource", &rancher2.NodePoolArgs{
HostnamePrefix: pulumi.String("string"),
ClusterId: pulumi.String("string"),
NodeTemplateId: pulumi.String("string"),
DeleteNotReadyAfterSecs: pulumi.Int(0),
DrainBeforeDelete: pulumi.Bool(false),
Etcd: pulumi.Bool(false),
Annotations: pulumi.StringMap{
"string": pulumi.String("string"),
},
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
Name: pulumi.String("string"),
NodeTaints: rancher2.NodePoolNodeTaintArray{
&rancher2.NodePoolNodeTaintArgs{
Key: pulumi.String("string"),
Value: pulumi.String("string"),
Effect: pulumi.String("string"),
TimeAdded: pulumi.String("string"),
},
},
ControlPlane: pulumi.Bool(false),
Quantity: pulumi.Int(0),
Worker: pulumi.Bool(false),
})
var nodePoolResource = new NodePool("nodePoolResource", NodePoolArgs.builder()
.hostnamePrefix("string")
.clusterId("string")
.nodeTemplateId("string")
.deleteNotReadyAfterSecs(0)
.drainBeforeDelete(false)
.etcd(false)
.annotations(Map.of("string", "string"))
.labels(Map.of("string", "string"))
.name("string")
.nodeTaints(NodePoolNodeTaintArgs.builder()
.key("string")
.value("string")
.effect("string")
.timeAdded("string")
.build())
.controlPlane(false)
.quantity(0)
.worker(false)
.build());
node_pool_resource = rancher2.NodePool("nodePoolResource",
hostname_prefix="string",
cluster_id="string",
node_template_id="string",
delete_not_ready_after_secs=0,
drain_before_delete=False,
etcd=False,
annotations={
"string": "string",
},
labels={
"string": "string",
},
name="string",
node_taints=[{
"key": "string",
"value": "string",
"effect": "string",
"time_added": "string",
}],
control_plane=False,
quantity=0,
worker=False)
const nodePoolResource = new rancher2.NodePool("nodePoolResource", {
hostnamePrefix: "string",
clusterId: "string",
nodeTemplateId: "string",
deleteNotReadyAfterSecs: 0,
drainBeforeDelete: false,
etcd: false,
annotations: {
string: "string",
},
labels: {
string: "string",
},
name: "string",
nodeTaints: [{
key: "string",
value: "string",
effect: "string",
timeAdded: "string",
}],
controlPlane: false,
quantity: 0,
worker: false,
});
type: rancher2:NodePool
properties:
annotations:
string: string
clusterId: string
controlPlane: false
deleteNotReadyAfterSecs: 0
drainBeforeDelete: false
etcd: false
hostnamePrefix: string
labels:
string: string
name: string
nodeTaints:
- effect: string
key: string
timeAdded: string
value: string
nodeTemplateId: string
quantity: 0
worker: false
NodePool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The NodePool resource accepts the following input properties:
- Cluster
Id string - The RKE cluster id to use Node Pool (string)
- Hostname
Prefix string - The prefix for created nodes of the Node Pool (string)
- Node
Template stringId - The Node Template ID to use for node creation (string)
- Annotations Dictionary<string, string>
- Annotations for Node Pool object (map)
- Control
Plane bool - RKE control plane role for created nodes (bool)
- Delete
Not intReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - Drain
Before boolDelete - Drain nodes before delete. Default:
false
(bool) - Etcd bool
- RKE etcd role for created nodes (bool)
- Labels Dictionary<string, string>
- Labels for Node Pool object (map)
- Name string
- The name of the Node Pool (string)
- Node
Taints List<NodePool Node Taint> - Node taints. For Rancher v2.3.3 and above (List)
- Quantity int
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - Worker bool
- RKE role role for created nodes (bool)
- Cluster
Id string - The RKE cluster id to use Node Pool (string)
- Hostname
Prefix string - The prefix for created nodes of the Node Pool (string)
- Node
Template stringId - The Node Template ID to use for node creation (string)
- Annotations map[string]string
- Annotations for Node Pool object (map)
- Control
Plane bool - RKE control plane role for created nodes (bool)
- Delete
Not intReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - Drain
Before boolDelete - Drain nodes before delete. Default:
false
(bool) - Etcd bool
- RKE etcd role for created nodes (bool)
- Labels map[string]string
- Labels for Node Pool object (map)
- Name string
- The name of the Node Pool (string)
- Node
Taints []NodePool Node Taint Args - Node taints. For Rancher v2.3.3 and above (List)
- Quantity int
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - Worker bool
- RKE role role for created nodes (bool)
- cluster
Id String - The RKE cluster id to use Node Pool (string)
- hostname
Prefix String - The prefix for created nodes of the Node Pool (string)
- node
Template StringId - The Node Template ID to use for node creation (string)
- annotations Map<String,String>
- Annotations for Node Pool object (map)
- control
Plane Boolean - RKE control plane role for created nodes (bool)
- delete
Not IntegerReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain
Before BooleanDelete - Drain nodes before delete. Default:
false
(bool) - etcd Boolean
- RKE etcd role for created nodes (bool)
- labels Map<String,String>
- Labels for Node Pool object (map)
- name String
- The name of the Node Pool (string)
- node
Taints List<NodePool Node Taint> - Node taints. For Rancher v2.3.3 and above (List)
- quantity Integer
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker Boolean
- RKE role role for created nodes (bool)
- cluster
Id string - The RKE cluster id to use Node Pool (string)
- hostname
Prefix string - The prefix for created nodes of the Node Pool (string)
- node
Template stringId - The Node Template ID to use for node creation (string)
- annotations {[key: string]: string}
- Annotations for Node Pool object (map)
- control
Plane boolean - RKE control plane role for created nodes (bool)
- delete
Not numberReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain
Before booleanDelete - Drain nodes before delete. Default:
false
(bool) - etcd boolean
- RKE etcd role for created nodes (bool)
- labels {[key: string]: string}
- Labels for Node Pool object (map)
- name string
- The name of the Node Pool (string)
- node
Taints NodePool Node Taint[] - Node taints. For Rancher v2.3.3 and above (List)
- quantity number
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker boolean
- RKE role role for created nodes (bool)
- cluster_
id str - The RKE cluster id to use Node Pool (string)
- hostname_
prefix str - The prefix for created nodes of the Node Pool (string)
- node_
template_ strid - The Node Template ID to use for node creation (string)
- annotations Mapping[str, str]
- Annotations for Node Pool object (map)
- control_
plane bool - RKE control plane role for created nodes (bool)
- delete_
not_ intready_ after_ secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain_
before_ booldelete - Drain nodes before delete. Default:
false
(bool) - etcd bool
- RKE etcd role for created nodes (bool)
- labels Mapping[str, str]
- Labels for Node Pool object (map)
- name str
- The name of the Node Pool (string)
- node_
taints Sequence[NodePool Node Taint Args] - Node taints. For Rancher v2.3.3 and above (List)
- quantity int
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker bool
- RKE role role for created nodes (bool)
- cluster
Id String - The RKE cluster id to use Node Pool (string)
- hostname
Prefix String - The prefix for created nodes of the Node Pool (string)
- node
Template StringId - The Node Template ID to use for node creation (string)
- annotations Map<String>
- Annotations for Node Pool object (map)
- control
Plane Boolean - RKE control plane role for created nodes (bool)
- delete
Not NumberReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain
Before BooleanDelete - Drain nodes before delete. Default:
false
(bool) - etcd Boolean
- RKE etcd role for created nodes (bool)
- labels Map<String>
- Labels for Node Pool object (map)
- name String
- The name of the Node Pool (string)
- node
Taints List<Property Map> - Node taints. For Rancher v2.3.3 and above (List)
- quantity Number
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker Boolean
- RKE role role for created nodes (bool)
Outputs
All input properties are implicitly available as output properties. Additionally, the NodePool resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Id string
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
- id string
- The provider-assigned unique ID for this managed resource.
- id str
- The provider-assigned unique ID for this managed resource.
- id String
- The provider-assigned unique ID for this managed resource.
Look up Existing NodePool Resource
Get an existing NodePool resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static get(name: string, id: Input<ID>, state?: NodePoolState, opts?: CustomResourceOptions): NodePool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
annotations: Optional[Mapping[str, str]] = None,
cluster_id: Optional[str] = None,
control_plane: Optional[bool] = None,
delete_not_ready_after_secs: Optional[int] = None,
drain_before_delete: Optional[bool] = None,
etcd: Optional[bool] = None,
hostname_prefix: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
name: Optional[str] = None,
node_taints: Optional[Sequence[NodePoolNodeTaintArgs]] = None,
node_template_id: Optional[str] = None,
quantity: Optional[int] = None,
worker: Optional[bool] = None) -> NodePool
func GetNodePool(ctx *Context, name string, id IDInput, state *NodePoolState, opts ...ResourceOption) (*NodePool, error)
public static NodePool Get(string name, Input<string> id, NodePoolState? state, CustomResourceOptions? opts = null)
public static NodePool get(String name, Output<String> id, NodePoolState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- resource_name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- name
- The unique name of the resulting resource.
- id
- The unique provider ID of the resource to lookup.
- state
- Any extra arguments used during the lookup.
- opts
- A bag of options that control this resource's behavior.
- Annotations Dictionary<string, string>
- Annotations for Node Pool object (map)
- Cluster
Id string - The RKE cluster id to use Node Pool (string)
- Control
Plane bool - RKE control plane role for created nodes (bool)
- Delete
Not intReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - Drain
Before boolDelete - Drain nodes before delete. Default:
false
(bool) - Etcd bool
- RKE etcd role for created nodes (bool)
- Hostname
Prefix string - The prefix for created nodes of the Node Pool (string)
- Labels Dictionary<string, string>
- Labels for Node Pool object (map)
- Name string
- The name of the Node Pool (string)
- Node
Taints List<NodePool Node Taint> - Node taints. For Rancher v2.3.3 and above (List)
- Node
Template stringId - The Node Template ID to use for node creation (string)
- Quantity int
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - Worker bool
- RKE role role for created nodes (bool)
- Annotations map[string]string
- Annotations for Node Pool object (map)
- Cluster
Id string - The RKE cluster id to use Node Pool (string)
- Control
Plane bool - RKE control plane role for created nodes (bool)
- Delete
Not intReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - Drain
Before boolDelete - Drain nodes before delete. Default:
false
(bool) - Etcd bool
- RKE etcd role for created nodes (bool)
- Hostname
Prefix string - The prefix for created nodes of the Node Pool (string)
- Labels map[string]string
- Labels for Node Pool object (map)
- Name string
- The name of the Node Pool (string)
- Node
Taints []NodePool Node Taint Args - Node taints. For Rancher v2.3.3 and above (List)
- Node
Template stringId - The Node Template ID to use for node creation (string)
- Quantity int
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - Worker bool
- RKE role role for created nodes (bool)
- annotations Map<String,String>
- Annotations for Node Pool object (map)
- cluster
Id String - The RKE cluster id to use Node Pool (string)
- control
Plane Boolean - RKE control plane role for created nodes (bool)
- delete
Not IntegerReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain
Before BooleanDelete - Drain nodes before delete. Default:
false
(bool) - etcd Boolean
- RKE etcd role for created nodes (bool)
- hostname
Prefix String - The prefix for created nodes of the Node Pool (string)
- labels Map<String,String>
- Labels for Node Pool object (map)
- name String
- The name of the Node Pool (string)
- node
Taints List<NodePool Node Taint> - Node taints. For Rancher v2.3.3 and above (List)
- node
Template StringId - The Node Template ID to use for node creation (string)
- quantity Integer
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker Boolean
- RKE role role for created nodes (bool)
- annotations {[key: string]: string}
- Annotations for Node Pool object (map)
- cluster
Id string - The RKE cluster id to use Node Pool (string)
- control
Plane boolean - RKE control plane role for created nodes (bool)
- delete
Not numberReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain
Before booleanDelete - Drain nodes before delete. Default:
false
(bool) - etcd boolean
- RKE etcd role for created nodes (bool)
- hostname
Prefix string - The prefix for created nodes of the Node Pool (string)
- labels {[key: string]: string}
- Labels for Node Pool object (map)
- name string
- The name of the Node Pool (string)
- node
Taints NodePool Node Taint[] - Node taints. For Rancher v2.3.3 and above (List)
- node
Template stringId - The Node Template ID to use for node creation (string)
- quantity number
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker boolean
- RKE role role for created nodes (bool)
- annotations Mapping[str, str]
- Annotations for Node Pool object (map)
- cluster_
id str - The RKE cluster id to use Node Pool (string)
- control_
plane bool - RKE control plane role for created nodes (bool)
- delete_
not_ intready_ after_ secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain_
before_ booldelete - Drain nodes before delete. Default:
false
(bool) - etcd bool
- RKE etcd role for created nodes (bool)
- hostname_
prefix str - The prefix for created nodes of the Node Pool (string)
- labels Mapping[str, str]
- Labels for Node Pool object (map)
- name str
- The name of the Node Pool (string)
- node_
taints Sequence[NodePool Node Taint Args] - Node taints. For Rancher v2.3.3 and above (List)
- node_
template_ strid - The Node Template ID to use for node creation (string)
- quantity int
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker bool
- RKE role role for created nodes (bool)
- annotations Map<String>
- Annotations for Node Pool object (map)
- cluster
Id String - The RKE cluster id to use Node Pool (string)
- control
Plane Boolean - RKE control plane role for created nodes (bool)
- delete
Not NumberReady After Secs - Delete not ready node after secs. For Rancher v2.3.3 and above. Default
0
(int) - drain
Before BooleanDelete - Drain nodes before delete. Default:
false
(bool) - etcd Boolean
- RKE etcd role for created nodes (bool)
- hostname
Prefix String - The prefix for created nodes of the Node Pool (string)
- labels Map<String>
- Labels for Node Pool object (map)
- name String
- The name of the Node Pool (string)
- node
Taints List<Property Map> - Node taints. For Rancher v2.3.3 and above (List)
- node
Template StringId - The Node Template ID to use for node creation (string)
- quantity Number
- The number of nodes to create on Node Pool. Default
1
. Only values >= 1 allowed (int) - worker Boolean
- RKE role role for created nodes (bool)
Supporting Types
NodePoolNodeTaint, NodePoolNodeTaintArgs
- key str
- Taint key (string)
- value str
- Taint value (string)
- effect str
- Taint effect. Supported values :
"NoExecute" | "NoSchedule" | "PreferNoSchedule"
(string) - time_
added str - Taint time added (string)
Import
Node Pool can be imported using the Rancher Node Pool ID
$ pulumi import rancher2:index/nodePool:NodePool foo <node_pool_id>
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Rancher2 pulumi/pulumi-rancher2
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
rancher2
Terraform Provider.