getKube

Use this data source to get a OVHcloud Managed Kubernetes Service cluster.

Example Usage

using System.Collections.Generic;
using Pulumi;
using Ovh = Pulumi.Ovh;

return await Deployment.RunAsync(() => 
{
    var myKubeCluster = Ovh.CloudProject.GetKube.Invoke(new()
    {
        ServiceName = "XXXXXX",
        KubeId = "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
    });

    return new Dictionary<string, object?>
    {
        ["version"] = myKubeCluster.Apply(getKubeResult => getKubeResult.Version),
    };
});
package main

import (
	"github.com/lbrlabs/pulumi-ovh/sdk/go/ovh/CloudProject"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		myKubeCluster, err := CloudProject.GetKube(ctx, &cloudproject.GetKubeArgs{
			ServiceName: "XXXXXX",
			KubeId:      "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("version", myKubeCluster.Version)
		return nil
	})
}
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.GetKubeArgs;
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 myKubeCluster = CloudProjectFunctions.getKube(GetKubeArgs.builder()
            .serviceName("XXXXXX")
            .kubeId("xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx")
            .build());

        ctx.export("version", myKubeCluster.applyValue(getKubeResult -> getKubeResult.version()));
    }
}
import pulumi
import pulumi_ovh as ovh

my_kube_cluster = ovh.CloudProject.get_kube(service_name="XXXXXX",
    kube_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx")
pulumi.export("version", my_kube_cluster.version)
import * as pulumi from "@pulumi/pulumi";
import * as ovh from "@pulumi/ovh";

const myKubeCluster = ovh.CloudProject.getKube({
    serviceName: "XXXXXX",
    kubeId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx",
});
export const version = myKubeCluster.then(myKubeCluster => myKubeCluster.version);
variables:
  myKubeCluster:
    fn::invoke:
      Function: ovh:CloudProject:getKube
      Arguments:
        serviceName: XXXXXX
        kubeId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx
outputs:
  version: ${myKubeCluster.version}

Using getKube

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 getKube(args: GetKubeArgs, opts?: InvokeOptions): Promise<GetKubeResult>
function getKubeOutput(args: GetKubeOutputArgs, opts?: InvokeOptions): Output<GetKubeResult>
def get_kube(customization: Optional[_cloudproject.GetKubeCustomization] = None,
             kube_id: Optional[str] = None,
             name: Optional[str] = None,
             region: Optional[str] = None,
             service_name: Optional[str] = None,
             update_policy: Optional[str] = None,
             version: Optional[str] = None,
             opts: Optional[InvokeOptions] = None) -> GetKubeResult
def get_kube_output(customization: Optional[pulumi.Input[_cloudproject.GetKubeCustomizationArgs]] = None,
             kube_id: Optional[pulumi.Input[str]] = None,
             name: Optional[pulumi.Input[str]] = None,
             region: Optional[pulumi.Input[str]] = None,
             service_name: Optional[pulumi.Input[str]] = None,
             update_policy: Optional[pulumi.Input[str]] = None,
             version: Optional[pulumi.Input[str]] = None,
             opts: Optional[InvokeOptions] = None) -> Output[GetKubeResult]
func GetKube(ctx *Context, args *GetKubeArgs, opts ...InvokeOption) (*GetKubeResult, error)
func GetKubeOutput(ctx *Context, args *GetKubeOutputArgs, opts ...InvokeOption) GetKubeResultOutput

> Note: This function is named GetKube in the Go SDK.

public static class GetKube 
{
    public static Task<GetKubeResult> InvokeAsync(GetKubeArgs args, InvokeOptions? opts = null)
    public static Output<GetKubeResult> Invoke(GetKubeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetKubeResult> getKube(GetKubeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
  function: ovh:CloudProject/getKube:getKube
  arguments:
    # arguments dictionary

The following arguments are supported:

KubeId string

The id of the managed kubernetes cluster.

ServiceName string

The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

Customization Lbrlabs.PulumiPackage.Ovh.CloudProject.Inputs.GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
Name string

The name of the managed kubernetes cluster.

Region string

The OVHcloud public cloud region ID of the managed kubernetes cluster.

UpdatePolicy string

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

Version string

Kubernetes version of the managed kubernetes cluster.

KubeId string

The id of the managed kubernetes cluster.

ServiceName string

The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

Customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
Name string

The name of the managed kubernetes cluster.

Region string

The OVHcloud public cloud region ID of the managed kubernetes cluster.

UpdatePolicy string

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

Version string

Kubernetes version of the managed kubernetes cluster.

kubeId String

The id of the managed kubernetes cluster.

serviceName String

The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
name String

The name of the managed kubernetes cluster.

region String

The OVHcloud public cloud region ID of the managed kubernetes cluster.

updatePolicy String

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version String

Kubernetes version of the managed kubernetes cluster.

kubeId string

The id of the managed kubernetes cluster.

serviceName string

The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
name string

The name of the managed kubernetes cluster.

region string

The OVHcloud public cloud region ID of the managed kubernetes cluster.

updatePolicy string

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version string

Kubernetes version of the managed kubernetes cluster.

kube_id str

The id of the managed kubernetes cluster.

service_name str

The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
name str

The name of the managed kubernetes cluster.

region str

The OVHcloud public cloud region ID of the managed kubernetes cluster.

update_policy str

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version str

Kubernetes version of the managed kubernetes cluster.

kubeId String

The id of the managed kubernetes cluster.

serviceName String

The id of the public cloud project. If omitted, the OVH_CLOUD_PROJECT_SERVICE environment variable is used.

customization Property Map

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
name String

The name of the managed kubernetes cluster.

region String

The OVHcloud public cloud region ID of the managed kubernetes cluster.

updatePolicy String

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version String

Kubernetes version of the managed kubernetes cluster.

getKube Result

The following output properties are available:

ControlPlaneIsUpToDate bool

True if control-plane is up to date.

Customization Lbrlabs.PulumiPackage.Ovh.CloudProject.Outputs.GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
Id string

The provider-assigned unique ID for this managed resource.

IsUpToDate bool

True if all nodes and control-plane are up to date.

KubeId string

See Argument Reference above.

NextUpgradeVersions List<string>

Kubernetes versions available for upgrade.

NodesUrl string

Cluster nodes URL.

PrivateNetworkId string

OpenStack private network (or vrack) ID to use.

ServiceName string

See Argument Reference above.

Status string

Cluster status. Should be normally set to 'READY'.

Url string

Management URL of your cluster.

Name string

The name of the managed kubernetes cluster.

Region string

The OVHcloud public cloud region ID of the managed kubernetes cluster.

UpdatePolicy string

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

Version string

Kubernetes version of the managed kubernetes cluster.

ControlPlaneIsUpToDate bool

True if control-plane is up to date.

Customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
Id string

The provider-assigned unique ID for this managed resource.

IsUpToDate bool

True if all nodes and control-plane are up to date.

KubeId string

See Argument Reference above.

NextUpgradeVersions []string

Kubernetes versions available for upgrade.

NodesUrl string

Cluster nodes URL.

PrivateNetworkId string

OpenStack private network (or vrack) ID to use.

ServiceName string

See Argument Reference above.

Status string

Cluster status. Should be normally set to 'READY'.

Url string

Management URL of your cluster.

Name string

The name of the managed kubernetes cluster.

Region string

The OVHcloud public cloud region ID of the managed kubernetes cluster.

UpdatePolicy string

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

Version string

Kubernetes version of the managed kubernetes cluster.

controlPlaneIsUpToDate Boolean

True if control-plane is up to date.

customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
id String

The provider-assigned unique ID for this managed resource.

isUpToDate Boolean

True if all nodes and control-plane are up to date.

kubeId String

See Argument Reference above.

nextUpgradeVersions List<String>

Kubernetes versions available for upgrade.

nodesUrl String

Cluster nodes URL.

privateNetworkId String

OpenStack private network (or vrack) ID to use.

serviceName String

See Argument Reference above.

status String

Cluster status. Should be normally set to 'READY'.

url String

Management URL of your cluster.

name String

The name of the managed kubernetes cluster.

region String

The OVHcloud public cloud region ID of the managed kubernetes cluster.

updatePolicy String

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version String

Kubernetes version of the managed kubernetes cluster.

controlPlaneIsUpToDate boolean

True if control-plane is up to date.

customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
id string

The provider-assigned unique ID for this managed resource.

isUpToDate boolean

True if all nodes and control-plane are up to date.

kubeId string

See Argument Reference above.

nextUpgradeVersions string[]

Kubernetes versions available for upgrade.

nodesUrl string

Cluster nodes URL.

privateNetworkId string

OpenStack private network (or vrack) ID to use.

serviceName string

See Argument Reference above.

status string

Cluster status. Should be normally set to 'READY'.

url string

Management URL of your cluster.

name string

The name of the managed kubernetes cluster.

region string

The OVHcloud public cloud region ID of the managed kubernetes cluster.

updatePolicy string

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version string

Kubernetes version of the managed kubernetes cluster.

control_plane_is_up_to_date bool

True if control-plane is up to date.

customization GetKubeCustomization

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
id str

The provider-assigned unique ID for this managed resource.

is_up_to_date bool

True if all nodes and control-plane are up to date.

kube_id str

See Argument Reference above.

next_upgrade_versions Sequence[str]

Kubernetes versions available for upgrade.

nodes_url str

Cluster nodes URL.

private_network_id str

OpenStack private network (or vrack) ID to use.

service_name str

See Argument Reference above.

status str

Cluster status. Should be normally set to 'READY'.

url str

Management URL of your cluster.

name str

The name of the managed kubernetes cluster.

region str

The OVHcloud public cloud region ID of the managed kubernetes cluster.

update_policy str

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version str

Kubernetes version of the managed kubernetes cluster.

controlPlaneIsUpToDate Boolean

True if control-plane is up to date.

customization Property Map

Customer customization object

  • apiserver - Kubernetes API server customization
  • admissionplugins - Kubernetes API server admission plugins customization
  • enabled - Array of admission plugins enabled, default is ["NodeRestriction","AlwaysPulImages"] and only these admission plugins can be enabled at this time.
  • disabled - Array of admission plugins disabled, default is [] and only AlwaysPulImages can be disabled at this time.
id String

The provider-assigned unique ID for this managed resource.

isUpToDate Boolean

True if all nodes and control-plane are up to date.

kubeId String

See Argument Reference above.

nextUpgradeVersions List<String>

Kubernetes versions available for upgrade.

nodesUrl String

Cluster nodes URL.

privateNetworkId String

OpenStack private network (or vrack) ID to use.

serviceName String

See Argument Reference above.

status String

Cluster status. Should be normally set to 'READY'.

url String

Management URL of your cluster.

name String

The name of the managed kubernetes cluster.

region String

The OVHcloud public cloud region ID of the managed kubernetes cluster.

updatePolicy String

Cluster update policy. Choose between [ALWAYS_UPDATE,MINIMAL_DOWNTIME,NEVER_UPDATE]'.

version String

Kubernetes version of the managed kubernetes cluster.

Supporting Types

GetKubeCustomization

GetKubeCustomizationApiserver

GetKubeCustomizationApiserverAdmissionplugins

Disableds List<string>
Enableds List<string>
Disableds []string
Enableds []string
disableds List<String>
enableds List<String>
disableds string[]
enableds string[]
disableds Sequence[str]
enableds Sequence[str]
disableds List<String>
enableds List<String>

Package Details

Repository
https://github.com/lbrlabs/pulumi-ovh
License
Apache-2.0
Notes

This Pulumi package is based on the ovh Terraform Provider.