ovh.CloudProject.KubeNodePool
Explore with Pulumi AI
Creates a nodepool in a OVHcloud Managed Kubernetes Service cluster.
Example Usage
Create a simple node pool in your Kubernetes cluster:
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";
const nodePool = new ovh.cloudproject.KubeNodePool("nodePool", {
desiredNodes: 3,
flavorName: "b2-7",
kubeId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
maxNodes: 3,
minNodes: 3,
serviceName: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
});
import pulumi
import pulumi_ovh as ovh
node_pool = ovh.cloud_project.KubeNodePool("nodePool",
desired_nodes=3,
flavor_name="b2-7",
kube_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
max_nodes=3,
min_nodes=3,
service_name="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
package main
import (
"github.com/ovh/pulumi-ovh/sdk/go/ovh/CloudProject"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := CloudProject.NewKubeNodePool(ctx, "nodePool", &CloudProject.KubeNodePoolArgs{
DesiredNodes: pulumi.Int(3),
FlavorName: pulumi.String("b2-7"),
KubeId: pulumi.String("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
MaxNodes: pulumi.Int(3),
MinNodes: pulumi.Int(3),
ServiceName: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;
return await Deployment.RunAsync(() =>
{
var nodePool = new Ovh.CloudProject.KubeNodePool("nodePool", new()
{
DesiredNodes = 3,
FlavorName = "b2-7",
KubeId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
MaxNodes = 3,
MinNodes = 3,
ServiceName = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.KubeNodePool;
import com.pulumi.ovh.CloudProject.KubeNodePoolArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var nodePool = new KubeNodePool("nodePool", KubeNodePoolArgs.builder()
.desiredNodes(3)
.flavorName("b2-7")
.kubeId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
.maxNodes(3)
.minNodes(3)
.serviceName("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.build());
}
}
resources:
nodePool:
type: ovh:CloudProject:KubeNodePool
properties:
desiredNodes: 3
flavorName: b2-7
kubeId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
maxNodes: 3
minNodes: 3
# Warning: "_" char is not allowed!
serviceName: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
Create an advanced node pool in your Kubernetes cluster:
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@ovhcloud/pulumi-ovh";
const pool = new ovh.cloudproject.KubeNodePool("pool", {
desiredNodes: 3,
flavorName: "b2-7",
kubeId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
maxNodes: 3,
minNodes: 3,
serviceName: "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
template: {
metadata: {
annotations: {
k1: "v1",
k2: "v2",
},
finalizers: [
"ovhcloud.com/v1beta1",
"ovhcloud.com/v1",
],
labels: {
k3: "v3",
k4: "v4",
},
},
spec: {
taints: [{
effect: "PreferNoSchedule",
key: "k",
value: "v",
}],
unschedulable: false,
},
},
});
import pulumi
import pulumi_ovh as ovh
pool = ovh.cloud_project.KubeNodePool("pool",
desired_nodes=3,
flavor_name="b2-7",
kube_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
max_nodes=3,
min_nodes=3,
service_name="xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
template=ovh.cloud_project.KubeNodePoolTemplateArgs(
metadata=ovh.cloud_project.KubeNodePoolTemplateMetadataArgs(
annotations={
"k1": "v1",
"k2": "v2",
},
finalizers=[
"ovhcloud.com/v1beta1",
"ovhcloud.com/v1",
],
labels={
"k3": "v3",
"k4": "v4",
},
),
spec=ovh.cloud_project.KubeNodePoolTemplateSpecArgs(
taints=[{
"effect": "PreferNoSchedule",
"key": "k",
"value": "v",
}],
unschedulable=False,
),
))
package main
import (
"github.com/ovh/pulumi-ovh/sdk/go/ovh/CloudProject"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := CloudProject.NewKubeNodePool(ctx, "pool", &CloudProject.KubeNodePoolArgs{
DesiredNodes: pulumi.Int(3),
FlavorName: pulumi.String("b2-7"),
KubeId: pulumi.String("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"),
MaxNodes: pulumi.Int(3),
MinNodes: pulumi.Int(3),
ServiceName: pulumi.String("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"),
Template: &cloudproject.KubeNodePoolTemplateArgs{
Metadata: &cloudproject.KubeNodePoolTemplateMetadataArgs{
Annotations: pulumi.StringMap{
"k1": pulumi.String("v1"),
"k2": pulumi.String("v2"),
},
Finalizers: pulumi.StringArray{
pulumi.String("ovhcloud.com/v1beta1"),
pulumi.String("ovhcloud.com/v1"),
},
Labels: pulumi.StringMap{
"k3": pulumi.String("v3"),
"k4": pulumi.String("v4"),
},
},
Spec: &cloudproject.KubeNodePoolTemplateSpecArgs{
Taints: pulumi.MapArray{
pulumi.Map{
"effect": pulumi.Any("PreferNoSchedule"),
"key": pulumi.Any("k"),
"value": pulumi.Any("v"),
},
},
Unschedulable: pulumi.Bool(false),
},
},
})
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;
return await Deployment.RunAsync(() =>
{
var pool = new Ovh.CloudProject.KubeNodePool("pool", new()
{
DesiredNodes = 3,
FlavorName = "b2-7",
KubeId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
MaxNodes = 3,
MinNodes = 3,
ServiceName = "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
Template = new Ovh.CloudProject.Inputs.KubeNodePoolTemplateArgs
{
Metadata = new Ovh.CloudProject.Inputs.KubeNodePoolTemplateMetadataArgs
{
Annotations =
{
{ "k1", "v1" },
{ "k2", "v2" },
},
Finalizers = new[]
{
"ovhcloud.com/v1beta1",
"ovhcloud.com/v1",
},
Labels =
{
{ "k3", "v3" },
{ "k4", "v4" },
},
},
Spec = new Ovh.CloudProject.Inputs.KubeNodePoolTemplateSpecArgs
{
Taints = new[]
{
{
{ "effect", "PreferNoSchedule" },
{ "key", "k" },
{ "value", "v" },
},
},
Unschedulable = false,
},
},
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.KubeNodePool;
import com.pulumi.ovh.CloudProject.KubeNodePoolArgs;
import com.pulumi.ovh.CloudProject.inputs.KubeNodePoolTemplateArgs;
import com.pulumi.ovh.CloudProject.inputs.KubeNodePoolTemplateMetadataArgs;
import com.pulumi.ovh.CloudProject.inputs.KubeNodePoolTemplateSpecArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var pool = new KubeNodePool("pool", KubeNodePoolArgs.builder()
.desiredNodes(3)
.flavorName("b2-7")
.kubeId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx")
.maxNodes(3)
.minNodes(3)
.serviceName("xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx")
.template(KubeNodePoolTemplateArgs.builder()
.metadata(KubeNodePoolTemplateMetadataArgs.builder()
.annotations(Map.ofEntries(
Map.entry("k1", "v1"),
Map.entry("k2", "v2")
))
.finalizers(
"ovhcloud.com/v1beta1",
"ovhcloud.com/v1")
.labels(Map.ofEntries(
Map.entry("k3", "v3"),
Map.entry("k4", "v4")
))
.build())
.spec(KubeNodePoolTemplateSpecArgs.builder()
.taints(Map.ofEntries(
Map.entry("effect", "PreferNoSchedule"),
Map.entry("key", "k"),
Map.entry("value", "v")
))
.unschedulable(false)
.build())
.build())
.build());
}
}
resources:
pool:
type: ovh:CloudProject:KubeNodePool
properties:
desiredNodes: 3
flavorName: b2-7
kubeId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
maxNodes: 3
minNodes: 3
serviceName: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
template:
metadata:
annotations:
k1: v1
k2: v2
finalizers:
- ovhcloud.com/v1beta1
- ovhcloud.com/v1
labels:
k3: v3
k4: v4
spec:
taints:
- effect: PreferNoSchedule
key: k
value: v
unschedulable: false
Create KubeNodePool Resource
new KubeNodePool(name: string, args: KubeNodePoolArgs, opts?: CustomResourceOptions);
@overload
def KubeNodePool(resource_name: str,
opts: Optional[ResourceOptions] = None,
anti_affinity: Optional[bool] = None,
autoscale: Optional[bool] = None,
autoscaling_scale_down_unneeded_time_seconds: Optional[int] = None,
autoscaling_scale_down_unready_time_seconds: Optional[int] = None,
autoscaling_scale_down_utilization_threshold: Optional[float] = None,
desired_nodes: Optional[int] = None,
flavor_name: Optional[str] = None,
kube_id: Optional[str] = None,
max_nodes: Optional[int] = None,
min_nodes: Optional[int] = None,
monthly_billed: Optional[bool] = None,
name: Optional[str] = None,
service_name: Optional[str] = None,
template: Optional[_cloudproject.KubeNodePoolTemplateArgs] = None)
@overload
def KubeNodePool(resource_name: str,
args: KubeNodePoolArgs,
opts: Optional[ResourceOptions] = None)
func NewKubeNodePool(ctx *Context, name string, args KubeNodePoolArgs, opts ...ResourceOption) (*KubeNodePool, error)
public KubeNodePool(string name, KubeNodePoolArgs args, CustomResourceOptions? opts = null)
public KubeNodePool(String name, KubeNodePoolArgs args)
public KubeNodePool(String name, KubeNodePoolArgs args, CustomResourceOptions options)
type: ovh:CloudProject:KubeNodePool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KubeNodePoolArgs
- 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 KubeNodePoolArgs
- 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 KubeNodePoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args KubeNodePoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args KubeNodePoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
KubeNodePool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The KubeNodePool resource accepts the following input properties:
- Flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- Kube
Id string - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- Service
Name string - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - Anti
Affinity bool - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - Autoscale bool
- Enable auto-scaling for the pool. Default to
false
. - Autoscaling
Scale intDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- Autoscaling
Scale intDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- Autoscaling
Scale doubleDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- Desired
Nodes int - number of nodes to start.
- Max
Nodes int - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - Min
Nodes int - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - Monthly
Billed bool - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - Name string
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - Template
Kube
Node Pool Template - Node pool template
- Flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- Kube
Id string - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- Service
Name string - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - Anti
Affinity bool - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - Autoscale bool
- Enable auto-scaling for the pool. Default to
false
. - Autoscaling
Scale intDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- Autoscaling
Scale intDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- Autoscaling
Scale float64Down Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- Desired
Nodes int - number of nodes to start.
- Max
Nodes int - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - Min
Nodes int - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - Monthly
Billed bool - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - Name string
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - Template
Kube
Node Pool Template Args - Node pool template
- flavor
Name String - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube
Id String - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- service
Name String - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - anti
Affinity Boolean - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale Boolean
- Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale IntegerDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale IntegerDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale DoubleDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- desired
Nodes Integer - number of nodes to start.
- max
Nodes Integer - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min
Nodes Integer - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly
Billed Boolean - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name String
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - template
Kube
Node Pool Template - Node pool template
- flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube
Id string - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- service
Name string - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - anti
Affinity boolean - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale boolean
- Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale numberDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale numberDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale numberDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- desired
Nodes number - number of nodes to start.
- max
Nodes number - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min
Nodes number - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly
Billed boolean - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name string
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - template
Kube
Node Pool Template - Node pool template
- flavor_
name str - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube_
id str - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- service_
name str - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - anti_
affinity bool - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale bool
- Enable auto-scaling for the pool. Default to
false
. - autoscaling_
scale_ intdown_ unneeded_ time_ seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling_
scale_ intdown_ unready_ time_ seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling_
scale_ floatdown_ utilization_ threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- desired_
nodes int - number of nodes to start.
- max_
nodes int - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min_
nodes int - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly_
billed bool - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name str
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - template
Kube
Node Pool Template Args - Node pool template
- flavor
Name String - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube
Id String - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- service
Name String - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - anti
Affinity Boolean - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale Boolean
- Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale NumberDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale NumberDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale NumberDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- desired
Nodes Number - number of nodes to start.
- max
Nodes Number - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min
Nodes Number - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly
Billed Boolean - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name String
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - template Property Map
- Node pool template
Outputs
All input properties are implicitly available as output properties. Additionally, the KubeNodePool resource produces the following output properties:
- Available
Nodes int - Number of nodes which are actually ready in the pool
- Created
At string - Creation date
- Current
Nodes int - Number of nodes present in the pool
- Flavor string
- Flavor name
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Project id
- Size
Status string - Status describing the state between number of nodes wanted and available ones
- Status string
- Current status
- Up
To intDate Nodes - Number of nodes with the latest version installed in the pool
- Updated
At string - Last update date
- Available
Nodes int - Number of nodes which are actually ready in the pool
- Created
At string - Creation date
- Current
Nodes int - Number of nodes present in the pool
- Flavor string
- Flavor name
- Id string
- The provider-assigned unique ID for this managed resource.
- Project
Id string - Project id
- Size
Status string - Status describing the state between number of nodes wanted and available ones
- Status string
- Current status
- Up
To intDate Nodes - Number of nodes with the latest version installed in the pool
- Updated
At string - Last update date
- available
Nodes Integer - Number of nodes which are actually ready in the pool
- created
At String - Creation date
- current
Nodes Integer - Number of nodes present in the pool
- flavor String
- Flavor name
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - Project id
- size
Status String - Status describing the state between number of nodes wanted and available ones
- status String
- Current status
- up
To IntegerDate Nodes - Number of nodes with the latest version installed in the pool
- updated
At String - Last update date
- available
Nodes number - Number of nodes which are actually ready in the pool
- created
At string - Creation date
- current
Nodes number - Number of nodes present in the pool
- flavor string
- Flavor name
- id string
- The provider-assigned unique ID for this managed resource.
- project
Id string - Project id
- size
Status string - Status describing the state between number of nodes wanted and available ones
- status string
- Current status
- up
To numberDate Nodes - Number of nodes with the latest version installed in the pool
- updated
At string - Last update date
- available_
nodes int - Number of nodes which are actually ready in the pool
- created_
at str - Creation date
- current_
nodes int - Number of nodes present in the pool
- flavor str
- Flavor name
- id str
- The provider-assigned unique ID for this managed resource.
- project_
id str - Project id
- size_
status str - Status describing the state between number of nodes wanted and available ones
- status str
- Current status
- up_
to_ intdate_ nodes - Number of nodes with the latest version installed in the pool
- updated_
at str - Last update date
- available
Nodes Number - Number of nodes which are actually ready in the pool
- created
At String - Creation date
- current
Nodes Number - Number of nodes present in the pool
- flavor String
- Flavor name
- id String
- The provider-assigned unique ID for this managed resource.
- project
Id String - Project id
- size
Status String - Status describing the state between number of nodes wanted and available ones
- status String
- Current status
- up
To NumberDate Nodes - Number of nodes with the latest version installed in the pool
- updated
At String - Last update date
Look up Existing KubeNodePool Resource
Get an existing KubeNodePool 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?: KubeNodePoolState, opts?: CustomResourceOptions): KubeNodePool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
anti_affinity: Optional[bool] = None,
autoscale: Optional[bool] = None,
autoscaling_scale_down_unneeded_time_seconds: Optional[int] = None,
autoscaling_scale_down_unready_time_seconds: Optional[int] = None,
autoscaling_scale_down_utilization_threshold: Optional[float] = None,
available_nodes: Optional[int] = None,
created_at: Optional[str] = None,
current_nodes: Optional[int] = None,
desired_nodes: Optional[int] = None,
flavor: Optional[str] = None,
flavor_name: Optional[str] = None,
kube_id: Optional[str] = None,
max_nodes: Optional[int] = None,
min_nodes: Optional[int] = None,
monthly_billed: Optional[bool] = None,
name: Optional[str] = None,
project_id: Optional[str] = None,
service_name: Optional[str] = None,
size_status: Optional[str] = None,
status: Optional[str] = None,
template: Optional[_cloudproject.KubeNodePoolTemplateArgs] = None,
up_to_date_nodes: Optional[int] = None,
updated_at: Optional[str] = None) -> KubeNodePool
func GetKubeNodePool(ctx *Context, name string, id IDInput, state *KubeNodePoolState, opts ...ResourceOption) (*KubeNodePool, error)
public static KubeNodePool Get(string name, Input<string> id, KubeNodePoolState? state, CustomResourceOptions? opts = null)
public static KubeNodePool get(String name, Output<String> id, KubeNodePoolState 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.
- Anti
Affinity bool - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - Autoscale bool
- Enable auto-scaling for the pool. Default to
false
. - Autoscaling
Scale intDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- Autoscaling
Scale intDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- Autoscaling
Scale doubleDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- Available
Nodes int - Number of nodes which are actually ready in the pool
- Created
At string - Creation date
- Current
Nodes int - Number of nodes present in the pool
- Desired
Nodes int - number of nodes to start.
- Flavor string
- Flavor name
- Flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- Kube
Id string - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- Max
Nodes int - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - Min
Nodes int - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - Monthly
Billed bool - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - Name string
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - Project
Id string - Project id
- Service
Name string - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - Size
Status string - Status describing the state between number of nodes wanted and available ones
- Status string
- Current status
- Template
Kube
Node Pool Template - Node pool template
- Up
To intDate Nodes - Number of nodes with the latest version installed in the pool
- Updated
At string - Last update date
- Anti
Affinity bool - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - Autoscale bool
- Enable auto-scaling for the pool. Default to
false
. - Autoscaling
Scale intDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- Autoscaling
Scale intDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- Autoscaling
Scale float64Down Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- Available
Nodes int - Number of nodes which are actually ready in the pool
- Created
At string - Creation date
- Current
Nodes int - Number of nodes present in the pool
- Desired
Nodes int - number of nodes to start.
- Flavor string
- Flavor name
- Flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- Kube
Id string - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- Max
Nodes int - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - Min
Nodes int - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - Monthly
Billed bool - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - Name string
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - Project
Id string - Project id
- Service
Name string - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - Size
Status string - Status describing the state between number of nodes wanted and available ones
- Status string
- Current status
- Template
Kube
Node Pool Template Args - Node pool template
- Up
To intDate Nodes - Number of nodes with the latest version installed in the pool
- Updated
At string - Last update date
- anti
Affinity Boolean - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale Boolean
- Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale IntegerDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale IntegerDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale DoubleDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- available
Nodes Integer - Number of nodes which are actually ready in the pool
- created
At String - Creation date
- current
Nodes Integer - Number of nodes present in the pool
- desired
Nodes Integer - number of nodes to start.
- flavor String
- Flavor name
- flavor
Name String - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube
Id String - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- max
Nodes Integer - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min
Nodes Integer - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly
Billed Boolean - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name String
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - project
Id String - Project id
- service
Name String - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - size
Status String - Status describing the state between number of nodes wanted and available ones
- status String
- Current status
- template
Kube
Node Pool Template - Node pool template
- up
To IntegerDate Nodes - Number of nodes with the latest version installed in the pool
- updated
At String - Last update date
- anti
Affinity boolean - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale boolean
- Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale numberDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale numberDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale numberDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- available
Nodes number - Number of nodes which are actually ready in the pool
- created
At string - Creation date
- current
Nodes number - Number of nodes present in the pool
- desired
Nodes number - number of nodes to start.
- flavor string
- Flavor name
- flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube
Id string - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- max
Nodes number - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min
Nodes number - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly
Billed boolean - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name string
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - project
Id string - Project id
- service
Name string - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - size
Status string - Status describing the state between number of nodes wanted and available ones
- status string
- Current status
- template
Kube
Node Pool Template - Node pool template
- up
To numberDate Nodes - Number of nodes with the latest version installed in the pool
- updated
At string - Last update date
- anti_
affinity bool - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale bool
- Enable auto-scaling for the pool. Default to
false
. - autoscaling_
scale_ intdown_ unneeded_ time_ seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling_
scale_ intdown_ unready_ time_ seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling_
scale_ floatdown_ utilization_ threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- available_
nodes int - Number of nodes which are actually ready in the pool
- created_
at str - Creation date
- current_
nodes int - Number of nodes present in the pool
- desired_
nodes int - number of nodes to start.
- flavor str
- Flavor name
- flavor_
name str - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube_
id str - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- max_
nodes int - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min_
nodes int - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly_
billed bool - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name str
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - project_
id str - Project id
- service_
name str - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - size_
status str - Status describing the state between number of nodes wanted and available ones
- status str
- Current status
- template
Kube
Node Pool Template Args - Node pool template
- up_
to_ intdate_ nodes - Number of nodes with the latest version installed in the pool
- updated_
at str - Last update date
- anti
Affinity Boolean - should the pool use the anti-affinity feature. Default to
false
. Changing this value recreates the resource. - autoscale Boolean
- Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale NumberDown Unneeded Time Seconds - scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale NumberDown Unready Time Seconds - scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale NumberDown Utilization Threshold - scaleDownUtilizationThreshold autoscaling parameter
Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down
template
- (Optional) Managed Kubernetes nodepool template, which is a complex object constituted by two main nested objects:
- available
Nodes Number - Number of nodes which are actually ready in the pool
- created
At String - Creation date
- current
Nodes Number - Number of nodes present in the pool
- desired
Nodes Number - number of nodes to start.
- flavor String
- Flavor name
- flavor
Name String - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/. Changing this value recreates the resource.
- kube
Id String - The id of the managed kubernetes cluster. Changing this value recreates the resource.
- max
Nodes Number - maximum number of nodes allowed in the pool. Setting
desired_nodes
over this value will raise an error. - min
Nodes Number - minimum number of nodes allowed in the pool. Setting
desired_nodes
under this value will raise an error. - monthly
Billed Boolean - should the nodes be billed on a monthly basis. Default to
false
. Changing this value recreates the resource. - name String
- The name of the nodepool. Warning:
_
char is not allowed! Changing this value recreates the resource. - project
Id String - Project id
- service
Name String - The id of the public cloud project. If omitted, the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. Changing this value recreates the resource. - size
Status String - Status describing the state between number of nodes wanted and available ones
- status String
- Current status
- template Property Map
- Node pool template
- up
To NumberDate Nodes - Number of nodes with the latest version installed in the pool
- updated
At String - Last update date
Supporting Types
KubeNodePoolTemplate, KubeNodePoolTemplateArgs
- Metadata
Kube
Node Pool Template Metadata - Metadata of each node in the pool
- Spec
Kube
Node Pool Template Spec - Spec of each node in the pool
- Metadata
Kube
Node Pool Template Metadata - Metadata of each node in the pool
- Spec
Kube
Node Pool Template Spec - Spec of each node in the pool
- metadata
Kube
Node Pool Template Metadata - Metadata of each node in the pool
- spec
Kube
Node Pool Template Spec - Spec of each node in the pool
- metadata
Kube
Node Pool Template Metadata - Metadata of each node in the pool
- spec
Kube
Node Pool Template Spec - Spec of each node in the pool
- metadata
Kube
Node Pool Template Metadata - Metadata of each node in the pool
- spec
Kube
Node Pool Template Spec - Spec of each node in the pool
- metadata Property Map
- Metadata of each node in the pool
- spec Property Map
- Spec of each node in the pool
KubeNodePoolTemplateMetadata, KubeNodePoolTemplateMetadataArgs
- Annotations Dictionary<string, string>
- Annotations to apply to each node
- Finalizers List<string>
- Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
- Labels Dictionary<string, string>
- Labels to apply to each node
- Annotations map[string]string
- Annotations to apply to each node
- Finalizers []string
- Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
- Labels map[string]string
- Labels to apply to each node
- annotations Map<String,String>
- Annotations to apply to each node
- finalizers List<String>
- Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
- labels Map<String,String>
- Labels to apply to each node
- annotations {[key: string]: string}
- Annotations to apply to each node
- finalizers string[]
- Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
- labels {[key: string]: string}
- Labels to apply to each node
- annotations Mapping[str, str]
- Annotations to apply to each node
- finalizers Sequence[str]
- Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
- labels Mapping[str, str]
- Labels to apply to each node
- annotations Map<String>
- Annotations to apply to each node
- finalizers List<String>
- Finalizers to apply to each node. A finalizer name must be fully qualified, e.g. kubernetes.io/pv-protection , where you prefix it with hostname of your service which is related to the controller responsible for the finalizer.
- labels Map<String>
- Labels to apply to each node
KubeNodePoolTemplateSpec, KubeNodePoolTemplateSpecArgs
- Taints
List<Immutable
Dictionary<string, object>> - Taints to apply to each node NodeSpec kubernetes documentation
- Unschedulable bool
- If true, set nodes as un-schedulable
- Taints []map[string]interface{}
- Taints to apply to each node NodeSpec kubernetes documentation
- Unschedulable bool
- If true, set nodes as un-schedulable
- taints List<Map<String,Object>>
- Taints to apply to each node NodeSpec kubernetes documentation
- unschedulable Boolean
- If true, set nodes as un-schedulable
- taints {[key: string]: any}[]
- Taints to apply to each node NodeSpec kubernetes documentation
- unschedulable boolean
- If true, set nodes as un-schedulable
- taints Sequence[Mapping[str, Any]]
- Taints to apply to each node NodeSpec kubernetes documentation
- unschedulable bool
- If true, set nodes as un-schedulable
- taints List<Map<Any>>
- Taints to apply to each node NodeSpec kubernetes documentation
- unschedulable Boolean
- If true, set nodes as un-schedulable
Import
OVHcloud Managed Kubernetes Service cluster node pool can be imported using the service_name
, the id
of the cluster, and the id
of the nodepool separated by “/” E.g.,
bash
$ pulumi import ovh:CloudProject/kubeNodePool:KubeNodePool pool service_name/kube_id/poolid
Package Details
- Repository
- ovh ovh/pulumi-ovh
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ovh
Terraform Provider.