1. Packages
  2. Exoscale
  3. API Docs
  4. SksCluster
Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse

exoscale.SksCluster

Explore with Pulumi AI

exoscale logo
Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse

    Manage Exoscale Scalable Kubernetes Service (SKS) Clusters.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as exoscale from "@pulumiverse/exoscale";
    
    const mySksCluster = new exoscale.SksCluster("mySksCluster", {zone: "ch-gva-2"});
    export const mySksClusterEndpoint = mySksCluster.endpoint;
    
    import pulumi
    import pulumiverse_exoscale as exoscale
    
    my_sks_cluster = exoscale.SksCluster("mySksCluster", zone="ch-gva-2")
    pulumi.export("mySksClusterEndpoint", my_sks_cluster.endpoint)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-exoscale/sdk/go/exoscale"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		mySksCluster, err := exoscale.NewSksCluster(ctx, "mySksCluster", &exoscale.SksClusterArgs{
    			Zone: pulumi.String("ch-gva-2"),
    		})
    		if err != nil {
    			return err
    		}
    		ctx.Export("mySksClusterEndpoint", mySksCluster.Endpoint)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Exoscale = Pulumiverse.Exoscale;
    
    return await Deployment.RunAsync(() => 
    {
        var mySksCluster = new Exoscale.SksCluster("mySksCluster", new()
        {
            Zone = "ch-gva-2",
        });
    
        return new Dictionary<string, object?>
        {
            ["mySksClusterEndpoint"] = mySksCluster.Endpoint,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.exoscale.SksCluster;
    import com.pulumi.exoscale.SksClusterArgs;
    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 mySksCluster = new SksCluster("mySksCluster", SksClusterArgs.builder()
                .zone("ch-gva-2")
                .build());
    
            ctx.export("mySksClusterEndpoint", mySksCluster.endpoint());
        }
    }
    
    resources:
      mySksCluster:
        type: exoscale:SksCluster
        properties:
          zone: ch-gva-2
    outputs:
      mySksClusterEndpoint: ${mySksCluster.endpoint}
    

    Next step is to attach exoscale_sks_nodepool(s) to the cluster.

    Please refer to the examples directory for complete configuration examples.

    Create SksCluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SksCluster(name: string, args: SksClusterArgs, opts?: CustomResourceOptions);
    @overload
    def SksCluster(resource_name: str,
                   args: SksClusterArgs,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def SksCluster(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   zone: Optional[str] = None,
                   labels: Optional[Mapping[str, str]] = None,
                   cni: Optional[str] = None,
                   description: Optional[str] = None,
                   exoscale_ccm: Optional[bool] = None,
                   exoscale_csi: Optional[bool] = None,
                   addons: Optional[Sequence[str]] = None,
                   metrics_server: Optional[bool] = None,
                   name: Optional[str] = None,
                   oidc: Optional[SksClusterOidcArgs] = None,
                   service_level: Optional[str] = None,
                   version: Optional[str] = None,
                   auto_upgrade: Optional[bool] = None)
    func NewSksCluster(ctx *Context, name string, args SksClusterArgs, opts ...ResourceOption) (*SksCluster, error)
    public SksCluster(string name, SksClusterArgs args, CustomResourceOptions? opts = null)
    public SksCluster(String name, SksClusterArgs args)
    public SksCluster(String name, SksClusterArgs args, CustomResourceOptions options)
    
    type: exoscale:SksCluster
    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 SksClusterArgs
    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 SksClusterArgs
    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 SksClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SksClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SksClusterArgs
    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 sksClusterResource = new Exoscale.SksCluster("sksClusterResource", new()
    {
        Zone = "string",
        Labels = 
        {
            { "string", "string" },
        },
        Cni = "string",
        Description = "string",
        ExoscaleCcm = false,
        ExoscaleCsi = false,
        MetricsServer = false,
        Name = "string",
        Oidc = new Exoscale.Inputs.SksClusterOidcArgs
        {
            ClientId = "string",
            IssuerUrl = "string",
            GroupsClaim = "string",
            GroupsPrefix = "string",
            RequiredClaim = 
            {
                { "string", "string" },
            },
            UsernameClaim = "string",
            UsernamePrefix = "string",
        },
        ServiceLevel = "string",
        Version = "string",
        AutoUpgrade = false,
    });
    
    example, err := exoscale.NewSksCluster(ctx, "sksClusterResource", &exoscale.SksClusterArgs{
    	Zone: pulumi.String("string"),
    	Labels: pulumi.StringMap{
    		"string": pulumi.String("string"),
    	},
    	Cni:           pulumi.String("string"),
    	Description:   pulumi.String("string"),
    	ExoscaleCcm:   pulumi.Bool(false),
    	ExoscaleCsi:   pulumi.Bool(false),
    	MetricsServer: pulumi.Bool(false),
    	Name:          pulumi.String("string"),
    	Oidc: &exoscale.SksClusterOidcArgs{
    		ClientId:     pulumi.String("string"),
    		IssuerUrl:    pulumi.String("string"),
    		GroupsClaim:  pulumi.String("string"),
    		GroupsPrefix: pulumi.String("string"),
    		RequiredClaim: pulumi.StringMap{
    			"string": pulumi.String("string"),
    		},
    		UsernameClaim:  pulumi.String("string"),
    		UsernamePrefix: pulumi.String("string"),
    	},
    	ServiceLevel: pulumi.String("string"),
    	Version:      pulumi.String("string"),
    	AutoUpgrade:  pulumi.Bool(false),
    })
    
    var sksClusterResource = new SksCluster("sksClusterResource", SksClusterArgs.builder()
        .zone("string")
        .labels(Map.of("string", "string"))
        .cni("string")
        .description("string")
        .exoscaleCcm(false)
        .exoscaleCsi(false)
        .metricsServer(false)
        .name("string")
        .oidc(SksClusterOidcArgs.builder()
            .clientId("string")
            .issuerUrl("string")
            .groupsClaim("string")
            .groupsPrefix("string")
            .requiredClaim(Map.of("string", "string"))
            .usernameClaim("string")
            .usernamePrefix("string")
            .build())
        .serviceLevel("string")
        .version("string")
        .autoUpgrade(false)
        .build());
    
    sks_cluster_resource = exoscale.SksCluster("sksClusterResource",
        zone="string",
        labels={
            "string": "string",
        },
        cni="string",
        description="string",
        exoscale_ccm=False,
        exoscale_csi=False,
        metrics_server=False,
        name="string",
        oidc=exoscale.SksClusterOidcArgs(
            client_id="string",
            issuer_url="string",
            groups_claim="string",
            groups_prefix="string",
            required_claim={
                "string": "string",
            },
            username_claim="string",
            username_prefix="string",
        ),
        service_level="string",
        version="string",
        auto_upgrade=False)
    
    const sksClusterResource = new exoscale.SksCluster("sksClusterResource", {
        zone: "string",
        labels: {
            string: "string",
        },
        cni: "string",
        description: "string",
        exoscaleCcm: false,
        exoscaleCsi: false,
        metricsServer: false,
        name: "string",
        oidc: {
            clientId: "string",
            issuerUrl: "string",
            groupsClaim: "string",
            groupsPrefix: "string",
            requiredClaim: {
                string: "string",
            },
            usernameClaim: "string",
            usernamePrefix: "string",
        },
        serviceLevel: "string",
        version: "string",
        autoUpgrade: false,
    });
    
    type: exoscale:SksCluster
    properties:
        autoUpgrade: false
        cni: string
        description: string
        exoscaleCcm: false
        exoscaleCsi: false
        labels:
            string: string
        metricsServer: false
        name: string
        oidc:
            clientId: string
            groupsClaim: string
            groupsPrefix: string
            issuerUrl: string
            requiredClaim:
                string: string
            usernameClaim: string
            usernamePrefix: string
        serviceLevel: string
        version: string
        zone: string
    

    SksCluster 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 SksCluster resource accepts the following input properties:

    Zone string
    ❗ The Exoscale Zone name.
    Addons List<string>

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    AutoUpgrade bool
    Enable automatic upgrading of the control plane version.
    Cni string
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    Description string
    A free-form text describing the cluster.
    ExoscaleCcm bool
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    ExoscaleCsi bool
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    Labels Dictionary<string, string>
    A map of key/value labels.
    MetricsServer bool
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    Name string
    The SKS cluster name.
    Oidc Pulumiverse.Exoscale.Inputs.SksClusterOidc
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    ServiceLevel string
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    Version string
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    Zone string
    ❗ The Exoscale Zone name.
    Addons []string

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    AutoUpgrade bool
    Enable automatic upgrading of the control plane version.
    Cni string
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    Description string
    A free-form text describing the cluster.
    ExoscaleCcm bool
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    ExoscaleCsi bool
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    Labels map[string]string
    A map of key/value labels.
    MetricsServer bool
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    Name string
    The SKS cluster name.
    Oidc SksClusterOidcArgs
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    ServiceLevel string
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    Version string
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone String
    ❗ The Exoscale Zone name.
    addons List<String>

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    autoUpgrade Boolean
    Enable automatic upgrading of the control plane version.
    cni String
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    description String
    A free-form text describing the cluster.
    exoscaleCcm Boolean
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscaleCsi Boolean
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    labels Map<String,String>
    A map of key/value labels.
    metricsServer Boolean
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name String
    The SKS cluster name.
    oidc SksClusterOidc
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    serviceLevel String
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    version String
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone string
    ❗ The Exoscale Zone name.
    addons string[]

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    autoUpgrade boolean
    Enable automatic upgrading of the control plane version.
    cni string
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    description string
    A free-form text describing the cluster.
    exoscaleCcm boolean
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscaleCsi boolean
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    labels {[key: string]: string}
    A map of key/value labels.
    metricsServer boolean
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name string
    The SKS cluster name.
    oidc SksClusterOidc
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    serviceLevel string
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    version string
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone str
    ❗ The Exoscale Zone name.
    addons Sequence[str]

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    auto_upgrade bool
    Enable automatic upgrading of the control plane version.
    cni str
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    description str
    A free-form text describing the cluster.
    exoscale_ccm bool
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscale_csi bool
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    labels Mapping[str, str]
    A map of key/value labels.
    metrics_server bool
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name str
    The SKS cluster name.
    oidc SksClusterOidcArgs
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    service_level str
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    version str
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone String
    ❗ The Exoscale Zone name.
    addons List<String>

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    autoUpgrade Boolean
    Enable automatic upgrading of the control plane version.
    cni String
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    description String
    A free-form text describing the cluster.
    exoscaleCcm Boolean
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscaleCsi Boolean
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    labels Map<String>
    A map of key/value labels.
    metricsServer Boolean
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name String
    The SKS cluster name.
    oidc Property Map
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    serviceLevel String
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    version String
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SksCluster resource produces the following output properties:

    AggregationCa string
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    ControlPlaneCa string
    The CA certificate (in PEM format) for TLS communications between control plane components.
    CreatedAt string
    The cluster creation date.
    Endpoint string
    The cluster API endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    KubeletCa string
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    Nodepools List<string>
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    State string
    The cluster state.
    AggregationCa string
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    ControlPlaneCa string
    The CA certificate (in PEM format) for TLS communications between control plane components.
    CreatedAt string
    The cluster creation date.
    Endpoint string
    The cluster API endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    KubeletCa string
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    Nodepools []string
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    State string
    The cluster state.
    aggregationCa String
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    controlPlaneCa String
    The CA certificate (in PEM format) for TLS communications between control plane components.
    createdAt String
    The cluster creation date.
    endpoint String
    The cluster API endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    kubeletCa String
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    nodepools List<String>
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    state String
    The cluster state.
    aggregationCa string
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    controlPlaneCa string
    The CA certificate (in PEM format) for TLS communications between control plane components.
    createdAt string
    The cluster creation date.
    endpoint string
    The cluster API endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    kubeletCa string
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    nodepools string[]
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    state string
    The cluster state.
    aggregation_ca str
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    control_plane_ca str
    The CA certificate (in PEM format) for TLS communications between control plane components.
    created_at str
    The cluster creation date.
    endpoint str
    The cluster API endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    kubelet_ca str
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    nodepools Sequence[str]
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    state str
    The cluster state.
    aggregationCa String
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    controlPlaneCa String
    The CA certificate (in PEM format) for TLS communications between control plane components.
    createdAt String
    The cluster creation date.
    endpoint String
    The cluster API endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    kubeletCa String
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    nodepools List<String>
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    state String
    The cluster state.

    Look up Existing SksCluster Resource

    Get an existing SksCluster 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?: SksClusterState, opts?: CustomResourceOptions): SksCluster
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            addons: Optional[Sequence[str]] = None,
            aggregation_ca: Optional[str] = None,
            auto_upgrade: Optional[bool] = None,
            cni: Optional[str] = None,
            control_plane_ca: Optional[str] = None,
            created_at: Optional[str] = None,
            description: Optional[str] = None,
            endpoint: Optional[str] = None,
            exoscale_ccm: Optional[bool] = None,
            exoscale_csi: Optional[bool] = None,
            kubelet_ca: Optional[str] = None,
            labels: Optional[Mapping[str, str]] = None,
            metrics_server: Optional[bool] = None,
            name: Optional[str] = None,
            nodepools: Optional[Sequence[str]] = None,
            oidc: Optional[SksClusterOidcArgs] = None,
            service_level: Optional[str] = None,
            state: Optional[str] = None,
            version: Optional[str] = None,
            zone: Optional[str] = None) -> SksCluster
    func GetSksCluster(ctx *Context, name string, id IDInput, state *SksClusterState, opts ...ResourceOption) (*SksCluster, error)
    public static SksCluster Get(string name, Input<string> id, SksClusterState? state, CustomResourceOptions? opts = null)
    public static SksCluster get(String name, Output<String> id, SksClusterState 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.
    The following state arguments are supported:
    Addons List<string>

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    AggregationCa string
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    AutoUpgrade bool
    Enable automatic upgrading of the control plane version.
    Cni string
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    ControlPlaneCa string
    The CA certificate (in PEM format) for TLS communications between control plane components.
    CreatedAt string
    The cluster creation date.
    Description string
    A free-form text describing the cluster.
    Endpoint string
    The cluster API endpoint.
    ExoscaleCcm bool
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    ExoscaleCsi bool
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    KubeletCa string
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    Labels Dictionary<string, string>
    A map of key/value labels.
    MetricsServer bool
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    Name string
    The SKS cluster name.
    Nodepools List<string>
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    Oidc Pulumiverse.Exoscale.Inputs.SksClusterOidc
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    ServiceLevel string
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    State string
    The cluster state.
    Version string
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    Zone string
    ❗ The Exoscale Zone name.
    Addons []string

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    AggregationCa string
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    AutoUpgrade bool
    Enable automatic upgrading of the control plane version.
    Cni string
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    ControlPlaneCa string
    The CA certificate (in PEM format) for TLS communications between control plane components.
    CreatedAt string
    The cluster creation date.
    Description string
    A free-form text describing the cluster.
    Endpoint string
    The cluster API endpoint.
    ExoscaleCcm bool
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    ExoscaleCsi bool
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    KubeletCa string
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    Labels map[string]string
    A map of key/value labels.
    MetricsServer bool
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    Name string
    The SKS cluster name.
    Nodepools []string
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    Oidc SksClusterOidcArgs
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    ServiceLevel string
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    State string
    The cluster state.
    Version string
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    Zone string
    ❗ The Exoscale Zone name.
    addons List<String>

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    aggregationCa String
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    autoUpgrade Boolean
    Enable automatic upgrading of the control plane version.
    cni String
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    controlPlaneCa String
    The CA certificate (in PEM format) for TLS communications between control plane components.
    createdAt String
    The cluster creation date.
    description String
    A free-form text describing the cluster.
    endpoint String
    The cluster API endpoint.
    exoscaleCcm Boolean
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscaleCsi Boolean
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    kubeletCa String
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    labels Map<String,String>
    A map of key/value labels.
    metricsServer Boolean
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name String
    The SKS cluster name.
    nodepools List<String>
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    oidc SksClusterOidc
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    serviceLevel String
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    state String
    The cluster state.
    version String
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone String
    ❗ The Exoscale Zone name.
    addons string[]

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    aggregationCa string
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    autoUpgrade boolean
    Enable automatic upgrading of the control plane version.
    cni string
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    controlPlaneCa string
    The CA certificate (in PEM format) for TLS communications between control plane components.
    createdAt string
    The cluster creation date.
    description string
    A free-form text describing the cluster.
    endpoint string
    The cluster API endpoint.
    exoscaleCcm boolean
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscaleCsi boolean
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    kubeletCa string
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    labels {[key: string]: string}
    A map of key/value labels.
    metricsServer boolean
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name string
    The SKS cluster name.
    nodepools string[]
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    oidc SksClusterOidc
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    serviceLevel string
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    state string
    The cluster state.
    version string
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone string
    ❗ The Exoscale Zone name.
    addons Sequence[str]

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    aggregation_ca str
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    auto_upgrade bool
    Enable automatic upgrading of the control plane version.
    cni str
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    control_plane_ca str
    The CA certificate (in PEM format) for TLS communications between control plane components.
    created_at str
    The cluster creation date.
    description str
    A free-form text describing the cluster.
    endpoint str
    The cluster API endpoint.
    exoscale_ccm bool
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscale_csi bool
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    kubelet_ca str
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    labels Mapping[str, str]
    A map of key/value labels.
    metrics_server bool
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name str
    The SKS cluster name.
    nodepools Sequence[str]
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    oidc SksClusterOidcArgs
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    service_level str
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    state str
    The cluster state.
    version str
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone str
    ❗ The Exoscale Zone name.
    addons List<String>

    Deprecated: This attribute has been replaced by exoscale_ccm/metrics_server attributes, it will be removed in a future release.

    aggregationCa String
    The CA certificate (in PEM format) for TLS communications between the control plane and the aggregation layer (e.g. metrics-server).
    autoUpgrade Boolean
    Enable automatic upgrading of the control plane version.
    cni String
    The CNI plugin that is to be used. Available options are "calico" or "cilium". Defaults to "calico". Setting empty string will result in a cluster with no CNI.
    controlPlaneCa String
    The CA certificate (in PEM format) for TLS communications between control plane components.
    createdAt String
    The cluster creation date.
    description String
    A free-form text describing the cluster.
    endpoint String
    The cluster API endpoint.
    exoscaleCcm Boolean
    Deploy the Exoscale Cloud Controller Manager in the control plane (boolean; default: true; may only be set at creation time).
    exoscaleCsi Boolean
    Deploy the Exoscale Container Storage Interface on worker nodes (boolean; default: false; requires the CCM to be enabled).
    kubeletCa String
    The CA certificate (in PEM format) for TLS communications between kubelets and the control plane.
    labels Map<String>
    A map of key/value labels.
    metricsServer Boolean
    Deploy the Kubernetes Metrics Server in the control plane (boolean; default: true; may only be set at creation time).
    name String
    The SKS cluster name.
    nodepools List<String>
    The list of exoscalesksnodepool (IDs) attached to the cluster.
    oidc Property Map
    An OpenID Connect configuration to provide to the Kubernetes API server (may only be set at creation time). Structure is documented below.
    serviceLevel String
    The service level of the control plane (pro or starter; default: pro; may only be set at creation time).
    state String
    The cluster state.
    version String
    The version of the control plane (default: latest version available from the API; see exo compute sks versions for reference; may only be set at creation time).
    zone String
    ❗ The Exoscale Zone name.

    Supporting Types

    SksClusterOidc, SksClusterOidcArgs

    ClientId string
    The OpenID client ID.
    IssuerUrl string
    The OpenID provider URL.
    GroupsClaim string
    An OpenID JWT claim to use as the user's group.
    GroupsPrefix string
    An OpenID prefix prepended to group claims.
    RequiredClaim Dictionary<string, string>
    A map of key/value pairs that describes a required claim in the OpenID Token.
    UsernameClaim string
    An OpenID JWT claim to use as the user name.
    UsernamePrefix string
    An OpenID prefix prepended to username claims.
    ClientId string
    The OpenID client ID.
    IssuerUrl string
    The OpenID provider URL.
    GroupsClaim string
    An OpenID JWT claim to use as the user's group.
    GroupsPrefix string
    An OpenID prefix prepended to group claims.
    RequiredClaim map[string]string
    A map of key/value pairs that describes a required claim in the OpenID Token.
    UsernameClaim string
    An OpenID JWT claim to use as the user name.
    UsernamePrefix string
    An OpenID prefix prepended to username claims.
    clientId String
    The OpenID client ID.
    issuerUrl String
    The OpenID provider URL.
    groupsClaim String
    An OpenID JWT claim to use as the user's group.
    groupsPrefix String
    An OpenID prefix prepended to group claims.
    requiredClaim Map<String,String>
    A map of key/value pairs that describes a required claim in the OpenID Token.
    usernameClaim String
    An OpenID JWT claim to use as the user name.
    usernamePrefix String
    An OpenID prefix prepended to username claims.
    clientId string
    The OpenID client ID.
    issuerUrl string
    The OpenID provider URL.
    groupsClaim string
    An OpenID JWT claim to use as the user's group.
    groupsPrefix string
    An OpenID prefix prepended to group claims.
    requiredClaim {[key: string]: string}
    A map of key/value pairs that describes a required claim in the OpenID Token.
    usernameClaim string
    An OpenID JWT claim to use as the user name.
    usernamePrefix string
    An OpenID prefix prepended to username claims.
    client_id str
    The OpenID client ID.
    issuer_url str
    The OpenID provider URL.
    groups_claim str
    An OpenID JWT claim to use as the user's group.
    groups_prefix str
    An OpenID prefix prepended to group claims.
    required_claim Mapping[str, str]
    A map of key/value pairs that describes a required claim in the OpenID Token.
    username_claim str
    An OpenID JWT claim to use as the user name.
    username_prefix str
    An OpenID prefix prepended to username claims.
    clientId String
    The OpenID client ID.
    issuerUrl String
    The OpenID provider URL.
    groupsClaim String
    An OpenID JWT claim to use as the user's group.
    groupsPrefix String
    An OpenID prefix prepended to group claims.
    requiredClaim Map<String>
    A map of key/value pairs that describes a required claim in the OpenID Token.
    usernameClaim String
    An OpenID JWT claim to use as the user name.
    usernamePrefix String
    An OpenID prefix prepended to username claims.

    Import

    An existing SKS cluster may be imported by <ID>@<zone>:

    $ pulumi import exoscale:index/sksCluster:SksCluster \
    

    exoscale_sks_cluster.my_sks_cluster \

    f81d4fae-7dec-11d0-a765-00a0c91e6bf6@ch-gva-2

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    exoscale pulumiverse/pulumi-exoscale
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the exoscale Terraform Provider.
    exoscale logo
    Exoscale v0.59.2 published on Monday, Jul 22, 2024 by Pulumiverse