OVHCloud v1.1.0 published on Thursday, Nov 21, 2024 by OVHcloud
ovh.CloudProject.getKubeNodePool
Explore with Pulumi AI
Use this data source to get a OVHcloud Managed Kubernetes node pool.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@pulumi/ovh";
const nodepool = ovh.CloudProject.getKubeNodePool({
serviceName: "XXXXXX",
kubeId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
name: "xxxxxx",
});
export const maxNodes = nodepool.then(nodepool => nodepool.maxNodes);
import pulumi
import pulumi_ovh as ovh
nodepool = ovh.CloudProject.get_kube_node_pool(service_name="XXXXXX",
kube_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
name="xxxxxx")
pulumi.export("maxNodes", nodepool.max_nodes)
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 {
nodepool, err := CloudProject.GetKubeNodePool(ctx, &cloudproject.GetKubeNodePoolArgs{
ServiceName: "XXXXXX",
KubeId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
Name: "xxxxxx",
}, nil)
if err != nil {
return err
}
ctx.Export("maxNodes", nodepool.MaxNodes)
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Ovh = Pulumi.Ovh;
return await Deployment.RunAsync(() =>
{
var nodepool = Ovh.CloudProject.GetKubeNodePool.Invoke(new()
{
ServiceName = "XXXXXX",
KubeId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx",
Name = "xxxxxx",
});
return new Dictionary<string, object?>
{
["maxNodes"] = nodepool.Apply(getKubeNodePoolResult => getKubeNodePoolResult.MaxNodes),
};
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.ovh.CloudProject.CloudProjectFunctions;
import com.pulumi.ovh.CloudProject.inputs.GetKubeNodePoolArgs;
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) {
final var nodepool = CloudProjectFunctions.getKubeNodePool(GetKubeNodePoolArgs.builder()
.serviceName("XXXXXX")
.kubeId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx")
.name("xxxxxx")
.build());
ctx.export("maxNodes", nodepool.applyValue(getKubeNodePoolResult -> getKubeNodePoolResult.maxNodes()));
}
}
variables:
nodepool:
fn::invoke:
Function: ovh:CloudProject:getKubeNodePool
Arguments:
serviceName: XXXXXX
kubeId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxx
name: xxxxxx
outputs:
maxNodes: ${nodepool.maxNodes}
Using getKubeNodePool
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getKubeNodePool(args: GetKubeNodePoolArgs, opts?: InvokeOptions): Promise<GetKubeNodePoolResult>
function getKubeNodePoolOutput(args: GetKubeNodePoolOutputArgs, opts?: InvokeOptions): Output<GetKubeNodePoolResult>
def get_kube_node_pool(kube_id: Optional[str] = None,
name: Optional[str] = None,
service_name: Optional[str] = None,
template: Optional[_cloudproject.GetKubeNodePoolTemplate] = None,
opts: Optional[InvokeOptions] = None) -> GetKubeNodePoolResult
def get_kube_node_pool_output(kube_id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
service_name: Optional[pulumi.Input[str]] = None,
template: Optional[pulumi.Input[_cloudproject.GetKubeNodePoolTemplateArgs]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetKubeNodePoolResult]
func GetKubeNodePool(ctx *Context, args *GetKubeNodePoolArgs, opts ...InvokeOption) (*GetKubeNodePoolResult, error)
func GetKubeNodePoolOutput(ctx *Context, args *GetKubeNodePoolOutputArgs, opts ...InvokeOption) GetKubeNodePoolResultOutput
> Note: This function is named GetKubeNodePool
in the Go SDK.
public static class GetKubeNodePool
{
public static Task<GetKubeNodePoolResult> InvokeAsync(GetKubeNodePoolArgs args, InvokeOptions? opts = null)
public static Output<GetKubeNodePoolResult> Invoke(GetKubeNodePoolInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKubeNodePoolResult> getKubeNodePool(GetKubeNodePoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: ovh:CloudProject/getKubeNodePool:getKubeNodePool
arguments:
# arguments dictionary
The following arguments are supported:
- Kube
Id string - The id of the managed kubernetes cluster.
- Name string
- The name of the node pool.
- Service
Name string - The id of the public cloud project. If omitted,
the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. - Template
Get
Kube Node Pool Template
- Kube
Id string - The id of the managed kubernetes cluster.
- Name string
- The name of the node pool.
- Service
Name string - The id of the public cloud project. If omitted,
the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. - Template
Get
Kube Node Pool Template
- kube
Id String - The id of the managed kubernetes cluster.
- name String
- The name of the node pool.
- service
Name String - The id of the public cloud project. If omitted,
the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. - template
Get
Kube Node Pool Template
- kube
Id string - The id of the managed kubernetes cluster.
- name string
- The name of the node pool.
- service
Name string - The id of the public cloud project. If omitted,
the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. - template
Get
Kube Node Pool Template
- kube_
id str - The id of the managed kubernetes cluster.
- name str
- The name of the node pool.
- service_
name str - The id of the public cloud project. If omitted,
the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. - template
cloudproject.
Get Kube Node Pool Template
- kube
Id String - The id of the managed kubernetes cluster.
- name String
- The name of the node pool.
- service
Name String - The id of the public cloud project. If omitted,
the
OVH_CLOUD_PROJECT_SERVICE
environment variable is used. - template Property Map
getKubeNodePool Result
The following output properties are available:
- Anti
Affinity bool - (Optional) should the pool use the anti-affinity feature. Default to
false
. - Autoscale bool
- (Optional) Enable auto-scaling for the pool. Default to
false
. - Autoscaling
Scale intDown Unneeded Time Seconds - (Optional) scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- Autoscaling
Scale intDown Unready Time Seconds - (Optional) scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- Autoscaling
Scale doubleDown Utilization Threshold - (Optional) 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
- 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 you desire in the pool
- Flavor string
- Flavor name
- Flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". Changing this value recreates the resource. You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/
- Id string
- The provider-assigned unique ID for this managed resource.
- Kube
Id string - See Argument Reference above.
- 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 - (Optional) should the nodes be billed on a monthly basis. Default to
false
. - Name string
- (Optional) The name of the nodepool. Changing this value recreates the resource. Warning: "_" char is not allowed!
- Project
Id string - Project id
- Service
Name string - See Argument Reference above.
- 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
- Template
Get
Kube Node Pool Template
- Anti
Affinity bool - (Optional) should the pool use the anti-affinity feature. Default to
false
. - Autoscale bool
- (Optional) Enable auto-scaling for the pool. Default to
false
. - Autoscaling
Scale intDown Unneeded Time Seconds - (Optional) scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- Autoscaling
Scale intDown Unready Time Seconds - (Optional) scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- Autoscaling
Scale float64Down Utilization Threshold - (Optional) 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
- 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 you desire in the pool
- Flavor string
- Flavor name
- Flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". Changing this value recreates the resource. You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/
- Id string
- The provider-assigned unique ID for this managed resource.
- Kube
Id string - See Argument Reference above.
- 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 - (Optional) should the nodes be billed on a monthly basis. Default to
false
. - Name string
- (Optional) The name of the nodepool. Changing this value recreates the resource. Warning: "_" char is not allowed!
- Project
Id string - Project id
- Service
Name string - See Argument Reference above.
- 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
- Template
Get
Kube Node Pool Template
- anti
Affinity Boolean - (Optional) should the pool use the anti-affinity feature. Default to
false
. - autoscale Boolean
- (Optional) Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale IntegerDown Unneeded Time Seconds - (Optional) scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale IntegerDown Unready Time Seconds - (Optional) scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale DoubleDown Utilization Threshold - (Optional) 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
- 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 you desire in the pool
- flavor String
- Flavor name
- flavor
Name String - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". Changing this value recreates the resource. You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/
- id String
- The provider-assigned unique ID for this managed resource.
- kube
Id String - See Argument Reference above.
- 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 - (Optional) should the nodes be billed on a monthly basis. Default to
false
. - name String
- (Optional) The name of the nodepool. Changing this value recreates the resource. Warning: "_" char is not allowed!
- project
Id String - Project id
- service
Name String - See Argument Reference above.
- 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
- template
Get
Kube Node Pool Template
- anti
Affinity boolean - (Optional) should the pool use the anti-affinity feature. Default to
false
. - autoscale boolean
- (Optional) Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale numberDown Unneeded Time Seconds - (Optional) scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale numberDown Unready Time Seconds - (Optional) scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale numberDown Utilization Threshold - (Optional) 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
- 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 you desire in the pool
- flavor string
- Flavor name
- flavor
Name string - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". Changing this value recreates the resource. You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/
- id string
- The provider-assigned unique ID for this managed resource.
- kube
Id string - See Argument Reference above.
- 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 - (Optional) should the nodes be billed on a monthly basis. Default to
false
. - name string
- (Optional) The name of the nodepool. Changing this value recreates the resource. Warning: "_" char is not allowed!
- project
Id string - Project id
- service
Name string - See Argument Reference above.
- 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
- template
Get
Kube Node Pool Template
- anti_
affinity bool - (Optional) should the pool use the anti-affinity feature. Default to
false
. - autoscale bool
- (Optional) Enable auto-scaling for the pool. Default to
false
. - autoscaling_
scale_ intdown_ unneeded_ time_ seconds - (Optional) scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling_
scale_ intdown_ unready_ time_ seconds - (Optional) scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling_
scale_ floatdown_ utilization_ threshold - (Optional) 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
- 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 you desire in the pool
- flavor str
- Flavor name
- flavor_
name str - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". Changing this value recreates the resource. You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/
- id str
- The provider-assigned unique ID for this managed resource.
- kube_
id str - See Argument Reference above.
- 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 - (Optional) should the nodes be billed on a monthly basis. Default to
false
. - name str
- (Optional) The name of the nodepool. Changing this value recreates the resource. Warning: "_" char is not allowed!
- project_
id str - Project id
- service_
name str - See Argument Reference above.
- 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
- template
cloudproject.
Get Kube Node Pool Template
- anti
Affinity Boolean - (Optional) should the pool use the anti-affinity feature. Default to
false
. - autoscale Boolean
- (Optional) Enable auto-scaling for the pool. Default to
false
. - autoscaling
Scale NumberDown Unneeded Time Seconds - (Optional) scaleDownUnneededTimeSeconds autoscaling parameter How long a node should be unneeded before it is eligible for scale down
- autoscaling
Scale NumberDown Unready Time Seconds - (Optional) scaleDownUnreadyTimeSeconds autoscaling parameter How long an unready node should be unneeded before it is eligible for scale down
- autoscaling
Scale NumberDown Utilization Threshold - (Optional) 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
- 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 you desire in the pool
- flavor String
- Flavor name
- flavor
Name String - a valid OVHcloud public cloud flavor ID in which the nodes will be started. Ex: "b2-7". Changing this value recreates the resource. You can find the list of flavor IDs: https://www.ovhcloud.com/fr/public-cloud/prices/
- id String
- The provider-assigned unique ID for this managed resource.
- kube
Id String - See Argument Reference above.
- 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 - (Optional) should the nodes be billed on a monthly basis. Default to
false
. - name String
- (Optional) The name of the nodepool. Changing this value recreates the resource. Warning: "_" char is not allowed!
- project
Id String - Project id
- service
Name String - See Argument Reference above.
- 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
- template Property Map
Supporting Types
GetKubeNodePoolTemplate
- metadata Property Map
- metadata
- spec Property Map
- spec
GetKubeNodePoolTemplateMetadata
- Annotations Dictionary<string, string>
- annotations
- Finalizers List<string>
- finalizers
- Labels Dictionary<string, string>
- labels
- Annotations map[string]string
- annotations
- Finalizers []string
- finalizers
- Labels map[string]string
- labels
- annotations Map<String,String>
- annotations
- finalizers List<String>
- finalizers
- labels Map<String,String>
- labels
- annotations {[key: string]: string}
- annotations
- finalizers string[]
- finalizers
- labels {[key: string]: string}
- labels
- annotations Mapping[str, str]
- annotations
- finalizers Sequence[str]
- finalizers
- labels Mapping[str, str]
- labels
- annotations Map<String>
- annotations
- finalizers List<String>
- finalizers
- labels Map<String>
- labels
GetKubeNodePoolTemplateSpec
- Taints
List<Immutable
Dictionary<string, string>> - taints
- Unschedulable bool
- unschedulable
- Taints []map[string]string
- taints
- Unschedulable bool
- unschedulable
- taints List<Map<String,String>>
- taints
- unschedulable Boolean
- unschedulable
- taints {[key: string]: string}[]
- taints
- unschedulable boolean
- unschedulable
- taints Sequence[Mapping[str, str]]
- taints
- unschedulable bool
- unschedulable
- taints List<Map<String>>
- taints
- unschedulable Boolean
- unschedulable
Package Details
- Repository
- ovh ovh/pulumi-ovh
- License
- Apache-2.0
- Notes
- This Pulumi package is based on the
ovh
Terraform Provider.