vultr.KubernetesNodePools
Deploy additional node pools to an existing Vultr Kubernetes Engine (VKE) cluster.
Create KubernetesNodePools Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new KubernetesNodePools(name: string, args: KubernetesNodePoolsArgs, opts?: CustomResourceOptions);@overload
def KubernetesNodePools(resource_name: str,
args: KubernetesNodePoolsInitArgs,
opts: Optional[ResourceOptions] = None)
@overload
def KubernetesNodePools(resource_name: str,
opts: Optional[ResourceOptions] = None,
cluster_id: Optional[str] = None,
label: Optional[str] = None,
node_quantity: Optional[int] = None,
plan: Optional[str] = None,
auto_scaler: Optional[bool] = None,
labels: Optional[Mapping[str, str]] = None,
max_nodes: Optional[int] = None,
min_nodes: Optional[int] = None,
tag: Optional[str] = None,
taints: Optional[Sequence[KubernetesNodePoolsTaintArgs]] = None,
user_data: Optional[str] = None)func NewKubernetesNodePools(ctx *Context, name string, args KubernetesNodePoolsArgs, opts ...ResourceOption) (*KubernetesNodePools, error)public KubernetesNodePools(string name, KubernetesNodePoolsArgs args, CustomResourceOptions? opts = null)
public KubernetesNodePools(String name, KubernetesNodePoolsArgs args)
public KubernetesNodePools(String name, KubernetesNodePoolsArgs args, CustomResourceOptions options)
type: vultr:KubernetesNodePools
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 KubernetesNodePoolsArgs
- 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 KubernetesNodePoolsInitArgs
- 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 KubernetesNodePoolsArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KubernetesNodePoolsArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KubernetesNodePoolsArgs
- 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 kubernetesNodePoolsResource = new Vultr.KubernetesNodePools("kubernetesNodePoolsResource", new()
{
ClusterId = "string",
Label = "string",
NodeQuantity = 0,
Plan = "string",
AutoScaler = false,
Labels =
{
{ "string", "string" },
},
MaxNodes = 0,
MinNodes = 0,
Tag = "string",
Taints = new[]
{
new Vultr.Inputs.KubernetesNodePoolsTaintArgs
{
Effect = "string",
Key = "string",
Value = "string",
},
},
UserData = "string",
});
example, err := vultr.NewKubernetesNodePools(ctx, "kubernetesNodePoolsResource", &vultr.KubernetesNodePoolsArgs{
ClusterId: pulumi.String("string"),
Label: pulumi.String("string"),
NodeQuantity: pulumi.Int(0),
Plan: pulumi.String("string"),
AutoScaler: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
MaxNodes: pulumi.Int(0),
MinNodes: pulumi.Int(0),
Tag: pulumi.String("string"),
Taints: vultr.KubernetesNodePoolsTaintArray{
&vultr.KubernetesNodePoolsTaintArgs{
Effect: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
UserData: pulumi.String("string"),
})
var kubernetesNodePoolsResource = new KubernetesNodePools("kubernetesNodePoolsResource", KubernetesNodePoolsArgs.builder()
.clusterId("string")
.label("string")
.nodeQuantity(0)
.plan("string")
.autoScaler(false)
.labels(Map.of("string", "string"))
.maxNodes(0)
.minNodes(0)
.tag("string")
.taints(KubernetesNodePoolsTaintArgs.builder()
.effect("string")
.key("string")
.value("string")
.build())
.userData("string")
.build());
kubernetes_node_pools_resource = vultr.KubernetesNodePools("kubernetesNodePoolsResource",
cluster_id="string",
label="string",
node_quantity=0,
plan="string",
auto_scaler=False,
labels={
"string": "string",
},
max_nodes=0,
min_nodes=0,
tag="string",
taints=[{
"effect": "string",
"key": "string",
"value": "string",
}],
user_data="string")
const kubernetesNodePoolsResource = new vultr.KubernetesNodePools("kubernetesNodePoolsResource", {
clusterId: "string",
label: "string",
nodeQuantity: 0,
plan: "string",
autoScaler: false,
labels: {
string: "string",
},
maxNodes: 0,
minNodes: 0,
tag: "string",
taints: [{
effect: "string",
key: "string",
value: "string",
}],
userData: "string",
});
type: vultr:KubernetesNodePools
properties:
autoScaler: false
clusterId: string
label: string
labels:
string: string
maxNodes: 0
minNodes: 0
nodeQuantity: 0
plan: string
tag: string
taints:
- effect: string
key: string
value: string
userData: string
KubernetesNodePools 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 KubernetesNodePools resource accepts the following input properties:
- Cluster
Id string - The VKE cluster ID you want to attach this nodepool to.
- Label string
- The label to be used as a prefix for nodes in this node pool.
- Node
Quantity int - The number of nodes in this node pool.
- Plan string
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- Auto
Scaler bool - Enable the auto scaler for the default node pool.
- Labels Dictionary<string, string>
- A map of key/value pairs for Kubernetes node labels.
- Max
Nodes int - The maximum number of nodes to use with the auto scaler.
- Min
Nodes int - The minimum number of nodes to use with the auto scaler.
- Tag string
- A tag that is assigned to this node pool.
- Taints
List<ediri.
Vultr. Inputs. Kubernetes Node Pools Taint> - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - User
Data string - A base64 encoded string containing the user data to apply to nodes in the node pool.
- Cluster
Id string - The VKE cluster ID you want to attach this nodepool to.
- Label string
- The label to be used as a prefix for nodes in this node pool.
- Node
Quantity int - The number of nodes in this node pool.
- Plan string
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- Auto
Scaler bool - Enable the auto scaler for the default node pool.
- Labels map[string]string
- A map of key/value pairs for Kubernetes node labels.
- Max
Nodes int - The maximum number of nodes to use with the auto scaler.
- Min
Nodes int - The minimum number of nodes to use with the auto scaler.
- Tag string
- A tag that is assigned to this node pool.
- Taints
[]Kubernetes
Node Pools Taint Args - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - User
Data string - A base64 encoded string containing the user data to apply to nodes in the node pool.
- cluster
Id String - The VKE cluster ID you want to attach this nodepool to.
- label String
- The label to be used as a prefix for nodes in this node pool.
- node
Quantity Integer - The number of nodes in this node pool.
- plan String
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- auto
Scaler Boolean - Enable the auto scaler for the default node pool.
- labels Map<String,String>
- A map of key/value pairs for Kubernetes node labels.
- max
Nodes Integer - The maximum number of nodes to use with the auto scaler.
- min
Nodes Integer - The minimum number of nodes to use with the auto scaler.
- tag String
- A tag that is assigned to this node pool.
- taints
List<Kubernetes
Node Pools Taint> - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user
Data String - A base64 encoded string containing the user data to apply to nodes in the node pool.
- cluster
Id string - The VKE cluster ID you want to attach this nodepool to.
- label string
- The label to be used as a prefix for nodes in this node pool.
- node
Quantity number - The number of nodes in this node pool.
- plan string
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- auto
Scaler boolean - Enable the auto scaler for the default node pool.
- labels {[key: string]: string}
- A map of key/value pairs for Kubernetes node labels.
- max
Nodes number - The maximum number of nodes to use with the auto scaler.
- min
Nodes number - The minimum number of nodes to use with the auto scaler.
- tag string
- A tag that is assigned to this node pool.
- taints
Kubernetes
Node Pools Taint[] - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user
Data string - A base64 encoded string containing the user data to apply to nodes in the node pool.
- cluster_
id str - The VKE cluster ID you want to attach this nodepool to.
- label str
- The label to be used as a prefix for nodes in this node pool.
- node_
quantity int - The number of nodes in this node pool.
- plan str
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- auto_
scaler bool - Enable the auto scaler for the default node pool.
- labels Mapping[str, str]
- A map of key/value pairs for Kubernetes node labels.
- max_
nodes int - The maximum number of nodes to use with the auto scaler.
- min_
nodes int - The minimum number of nodes to use with the auto scaler.
- tag str
- A tag that is assigned to this node pool.
- taints
Sequence[Kubernetes
Node Pools Taint Args] - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user_
data str - A base64 encoded string containing the user data to apply to nodes in the node pool.
- cluster
Id String - The VKE cluster ID you want to attach this nodepool to.
- label String
- The label to be used as a prefix for nodes in this node pool.
- node
Quantity Number - The number of nodes in this node pool.
- plan String
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- auto
Scaler Boolean - Enable the auto scaler for the default node pool.
- labels Map<String>
- A map of key/value pairs for Kubernetes node labels.
- max
Nodes Number - The maximum number of nodes to use with the auto scaler.
- min
Nodes Number - The minimum number of nodes to use with the auto scaler.
- tag String
- A tag that is assigned to this node pool.
- taints List<Property Map>
- Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user
Data String - A base64 encoded string containing the user data to apply to nodes in the node pool.
Outputs
All input properties are implicitly available as output properties. Additionally, the KubernetesNodePools resource produces the following output properties:
- Date
Created string - Date node was created.
- Date
Updated string - Date of node pool updates.
- Id string
- The provider-assigned unique ID for this managed resource.
- Nodes
List<ediri.
Vultr. Outputs. Kubernetes Node Pools Node> - Array that contains information about nodes within this node pool.
- Status string
- Status of node.
- Date
Created string - Date node was created.
- Date
Updated string - Date of node pool updates.
- Id string
- The provider-assigned unique ID for this managed resource.
- Nodes
[]Kubernetes
Node Pools Node - Array that contains information about nodes within this node pool.
- Status string
- Status of node.
- date
Created String - Date node was created.
- date
Updated String - Date of node pool updates.
- id String
- The provider-assigned unique ID for this managed resource.
- nodes
List<Kubernetes
Node Pools Node> - Array that contains information about nodes within this node pool.
- status String
- Status of node.
- date
Created string - Date node was created.
- date
Updated string - Date of node pool updates.
- id string
- The provider-assigned unique ID for this managed resource.
- nodes
Kubernetes
Node Pools Node[] - Array that contains information about nodes within this node pool.
- status string
- Status of node.
- date_
created str - Date node was created.
- date_
updated str - Date of node pool updates.
- id str
- The provider-assigned unique ID for this managed resource.
- nodes
Sequence[Kubernetes
Node Pools Node] - Array that contains information about nodes within this node pool.
- status str
- Status of node.
- date
Created String - Date node was created.
- date
Updated String - Date of node pool updates.
- id String
- The provider-assigned unique ID for this managed resource.
- nodes List<Property Map>
- Array that contains information about nodes within this node pool.
- status String
- Status of node.
Look up Existing KubernetesNodePools Resource
Get an existing KubernetesNodePools 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?: KubernetesNodePoolsState, opts?: CustomResourceOptions): KubernetesNodePools@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
auto_scaler: Optional[bool] = None,
cluster_id: Optional[str] = None,
date_created: Optional[str] = None,
date_updated: Optional[str] = None,
label: Optional[str] = None,
labels: Optional[Mapping[str, str]] = None,
max_nodes: Optional[int] = None,
min_nodes: Optional[int] = None,
node_quantity: Optional[int] = None,
nodes: Optional[Sequence[KubernetesNodePoolsNodeArgs]] = None,
plan: Optional[str] = None,
status: Optional[str] = None,
tag: Optional[str] = None,
taints: Optional[Sequence[KubernetesNodePoolsTaintArgs]] = None,
user_data: Optional[str] = None) -> KubernetesNodePoolsfunc GetKubernetesNodePools(ctx *Context, name string, id IDInput, state *KubernetesNodePoolsState, opts ...ResourceOption) (*KubernetesNodePools, error)public static KubernetesNodePools Get(string name, Input<string> id, KubernetesNodePoolsState? state, CustomResourceOptions? opts = null)public static KubernetesNodePools get(String name, Output<String> id, KubernetesNodePoolsState state, CustomResourceOptions options)resources: _: type: vultr:KubernetesNodePools get: id: ${id}- 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.
- Auto
Scaler bool - Enable the auto scaler for the default node pool.
- Cluster
Id string - The VKE cluster ID you want to attach this nodepool to.
- Date
Created string - Date node was created.
- Date
Updated string - Date of node pool updates.
- Label string
- The label to be used as a prefix for nodes in this node pool.
- Labels Dictionary<string, string>
- A map of key/value pairs for Kubernetes node labels.
- Max
Nodes int - The maximum number of nodes to use with the auto scaler.
- Min
Nodes int - The minimum number of nodes to use with the auto scaler.
- Node
Quantity int - The number of nodes in this node pool.
- Nodes
List<ediri.
Vultr. Inputs. Kubernetes Node Pools Node> - Array that contains information about nodes within this node pool.
- Plan string
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- Status string
- Status of node.
- Tag string
- A tag that is assigned to this node pool.
- Taints
List<ediri.
Vultr. Inputs. Kubernetes Node Pools Taint> - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - User
Data string - A base64 encoded string containing the user data to apply to nodes in the node pool.
- Auto
Scaler bool - Enable the auto scaler for the default node pool.
- Cluster
Id string - The VKE cluster ID you want to attach this nodepool to.
- Date
Created string - Date node was created.
- Date
Updated string - Date of node pool updates.
- Label string
- The label to be used as a prefix for nodes in this node pool.
- Labels map[string]string
- A map of key/value pairs for Kubernetes node labels.
- Max
Nodes int - The maximum number of nodes to use with the auto scaler.
- Min
Nodes int - The minimum number of nodes to use with the auto scaler.
- Node
Quantity int - The number of nodes in this node pool.
- Nodes
[]Kubernetes
Node Pools Node Args - Array that contains information about nodes within this node pool.
- Plan string
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- Status string
- Status of node.
- Tag string
- A tag that is assigned to this node pool.
- Taints
[]Kubernetes
Node Pools Taint Args - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - User
Data string - A base64 encoded string containing the user data to apply to nodes in the node pool.
- auto
Scaler Boolean - Enable the auto scaler for the default node pool.
- cluster
Id String - The VKE cluster ID you want to attach this nodepool to.
- date
Created String - Date node was created.
- date
Updated String - Date of node pool updates.
- label String
- The label to be used as a prefix for nodes in this node pool.
- labels Map<String,String>
- A map of key/value pairs for Kubernetes node labels.
- max
Nodes Integer - The maximum number of nodes to use with the auto scaler.
- min
Nodes Integer - The minimum number of nodes to use with the auto scaler.
- node
Quantity Integer - The number of nodes in this node pool.
- nodes
List<Kubernetes
Node Pools Node> - Array that contains information about nodes within this node pool.
- plan String
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- status String
- Status of node.
- tag String
- A tag that is assigned to this node pool.
- taints
List<Kubernetes
Node Pools Taint> - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user
Data String - A base64 encoded string containing the user data to apply to nodes in the node pool.
- auto
Scaler boolean - Enable the auto scaler for the default node pool.
- cluster
Id string - The VKE cluster ID you want to attach this nodepool to.
- date
Created string - Date node was created.
- date
Updated string - Date of node pool updates.
- label string
- The label to be used as a prefix for nodes in this node pool.
- labels {[key: string]: string}
- A map of key/value pairs for Kubernetes node labels.
- max
Nodes number - The maximum number of nodes to use with the auto scaler.
- min
Nodes number - The minimum number of nodes to use with the auto scaler.
- node
Quantity number - The number of nodes in this node pool.
- nodes
Kubernetes
Node Pools Node[] - Array that contains information about nodes within this node pool.
- plan string
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- status string
- Status of node.
- tag string
- A tag that is assigned to this node pool.
- taints
Kubernetes
Node Pools Taint[] - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user
Data string - A base64 encoded string containing the user data to apply to nodes in the node pool.
- auto_
scaler bool - Enable the auto scaler for the default node pool.
- cluster_
id str - The VKE cluster ID you want to attach this nodepool to.
- date_
created str - Date node was created.
- date_
updated str - Date of node pool updates.
- label str
- The label to be used as a prefix for nodes in this node pool.
- labels Mapping[str, str]
- A map of key/value pairs for Kubernetes node labels.
- max_
nodes int - The maximum number of nodes to use with the auto scaler.
- min_
nodes int - The minimum number of nodes to use with the auto scaler.
- node_
quantity int - The number of nodes in this node pool.
- nodes
Sequence[Kubernetes
Node Pools Node Args] - Array that contains information about nodes within this node pool.
- plan str
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- status str
- Status of node.
- tag str
- A tag that is assigned to this node pool.
- taints
Sequence[Kubernetes
Node Pools Taint Args] - Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user_
data str - A base64 encoded string containing the user data to apply to nodes in the node pool.
- auto
Scaler Boolean - Enable the auto scaler for the default node pool.
- cluster
Id String - The VKE cluster ID you want to attach this nodepool to.
- date
Created String - Date node was created.
- date
Updated String - Date of node pool updates.
- label String
- The label to be used as a prefix for nodes in this node pool.
- labels Map<String>
- A map of key/value pairs for Kubernetes node labels.
- max
Nodes Number - The maximum number of nodes to use with the auto scaler.
- min
Nodes Number - The minimum number of nodes to use with the auto scaler.
- node
Quantity Number - The number of nodes in this node pool.
- nodes List<Property Map>
- Array that contains information about nodes within this node pool.
- plan String
- The plan to be used in this node pool. See Plans List Note the minimum plan requirements must have at least 1 core and 2 gbs of memory.
- status String
- Status of node.
- tag String
- A tag that is assigned to this node pool.
- taints List<Property Map>
- Taints to apply to the nodes in the node pool. Should contain
key,valueandeffect. Theeffectshould be one ofNoSchedule,PreferNoScheduleorNoExecute. - user
Data String - A base64 encoded string containing the user data to apply to nodes in the node pool.
Supporting Types
KubernetesNodePoolsNode, KubernetesNodePoolsNodeArgs
- Date
Created string - Date node was created.
- Id string
- ID of node.
- Label string
- The label to be used as a prefix for nodes in this node pool.
- Status string
- Status of node.
- Date
Created string - Date node was created.
- Id string
- ID of node.
- Label string
- The label to be used as a prefix for nodes in this node pool.
- Status string
- Status of node.
- date
Created String - Date node was created.
- id String
- ID of node.
- label String
- The label to be used as a prefix for nodes in this node pool.
- status String
- Status of node.
- date
Created string - Date node was created.
- id string
- ID of node.
- label string
- The label to be used as a prefix for nodes in this node pool.
- status string
- Status of node.
- date_
created str - Date node was created.
- id str
- ID of node.
- label str
- The label to be used as a prefix for nodes in this node pool.
- status str
- Status of node.
- date
Created String - Date node was created.
- id String
- ID of node.
- label String
- The label to be used as a prefix for nodes in this node pool.
- status String
- Status of node.
KubernetesNodePoolsTaint, KubernetesNodePoolsTaintArgs
Import
Node pool resources are able to be imported into terraform state like other
resources, however, since they rely on a kubernetes cluster, the import state
requires the UUID of the cluster as well. With that in mind, format the second
argument to the pulumi import command as a space delimited string of
UUIDs, the first is the cluster ID, the second is the node pool ID. It will
look like this:
“clusterID nodePoolID”
$ pulumi import vultr:index/kubernetesNodePools:KubernetesNodePools my-k8s-np "7365a98b-5a43-450f-bd27-d768827100e5 ec330340-4f50-4526-858f-a39199f568ac"
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- vultr dirien/pulumi-vultr
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
vultrTerraform Provider.
