Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vkcs Provider
  3. API Docs
  4. KubernetesCluster
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

vkcs.KubernetesCluster

Explore with Pulumi AI

vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs

Provides a kubernetes cluster resource. This can be used to create, modify and delete kubernetes clusters.

Standard Kubernetes cluster

import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";

const k8sCluster = new vkcs.KubernetesCluster("k8sCluster", {
    clusterType: "standard",
    clusterTemplateId: data.vkcs_kubernetes_clustertemplate.k8s_31.id,
    masterFlavor: data.vkcs_compute_flavor.basic.id,
    masterCount: 1,
    labels: {
        cloud_monitoring: "true",
        kube_log_level: "2",
        clean_volumes: "true",
        master_volume_size: "100",
        cluster_node_volume_type: "ceph-ssd",
    },
    availabilityZone: "MS1",
    networkId: vkcs_networking_network.app.id,
    subnetId: vkcs_networking_subnet.app.id,
    floatingIpEnabled: true,
    syncSecurityPolicy: true,
}, {
    dependsOn: [vkcs_networking_router_interface.app],
});
Copy
import pulumi
import pulumi_vkcs as vkcs

k8s_cluster = vkcs.KubernetesCluster("k8sCluster",
    cluster_type="standard",
    cluster_template_id=data["vkcs_kubernetes_clustertemplate"]["k8s_31"]["id"],
    master_flavor=data["vkcs_compute_flavor"]["basic"]["id"],
    master_count=1,
    labels={
        "cloud_monitoring": "true",
        "kube_log_level": "2",
        "clean_volumes": "true",
        "master_volume_size": "100",
        "cluster_node_volume_type": "ceph-ssd",
    },
    availability_zone="MS1",
    network_id=vkcs_networking_network["app"]["id"],
    subnet_id=vkcs_networking_subnet["app"]["id"],
    floating_ip_enabled=True,
    sync_security_policy=True,
    opts = pulumi.ResourceOptions(depends_on=[vkcs_networking_router_interface["app"]]))
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewKubernetesCluster(ctx, "k8sCluster", &vkcs.KubernetesClusterArgs{
			ClusterType:       pulumi.String("standard"),
			ClusterTemplateId: pulumi.Any(data.Vkcs_kubernetes_clustertemplate.K8s_31.Id),
			MasterFlavor:      pulumi.Any(data.Vkcs_compute_flavor.Basic.Id),
			MasterCount:       pulumi.Float64(1),
			Labels: pulumi.StringMap{
				"cloud_monitoring":         pulumi.String("true"),
				"kube_log_level":           pulumi.String("2"),
				"clean_volumes":            pulumi.String("true"),
				"master_volume_size":       pulumi.String("100"),
				"cluster_node_volume_type": pulumi.String("ceph-ssd"),
			},
			AvailabilityZone:   pulumi.String("MS1"),
			NetworkId:          pulumi.Any(vkcs_networking_network.App.Id),
			SubnetId:           pulumi.Any(vkcs_networking_subnet.App.Id),
			FloatingIpEnabled:  pulumi.Bool(true),
			SyncSecurityPolicy: pulumi.Bool(true),
		}, pulumi.DependsOn([]pulumi.Resource{
			vkcs_networking_router_interface.App,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var k8sCluster = new Vkcs.KubernetesCluster("k8sCluster", new()
    {
        ClusterType = "standard",
        ClusterTemplateId = data.Vkcs_kubernetes_clustertemplate.K8s_31.Id,
        MasterFlavor = data.Vkcs_compute_flavor.Basic.Id,
        MasterCount = 1,
        Labels = 
        {
            { "cloud_monitoring", "true" },
            { "kube_log_level", "2" },
            { "clean_volumes", "true" },
            { "master_volume_size", "100" },
            { "cluster_node_volume_type", "ceph-ssd" },
        },
        AvailabilityZone = "MS1",
        NetworkId = vkcs_networking_network.App.Id,
        SubnetId = vkcs_networking_subnet.App.Id,
        FloatingIpEnabled = true,
        SyncSecurityPolicy = true,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vkcs_networking_router_interface.App,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.KubernetesCluster;
import com.pulumi.vkcs.KubernetesClusterArgs;
import com.pulumi.resources.CustomResourceOptions;
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 k8sCluster = new KubernetesCluster("k8sCluster", KubernetesClusterArgs.builder()
            .clusterType("standard")
            .clusterTemplateId(data.vkcs_kubernetes_clustertemplate().k8s_31().id())
            .masterFlavor(data.vkcs_compute_flavor().basic().id())
            .masterCount(1)
            .labels(Map.ofEntries(
                Map.entry("cloud_monitoring", "true"),
                Map.entry("kube_log_level", "2"),
                Map.entry("clean_volumes", "true"),
                Map.entry("master_volume_size", "100"),
                Map.entry("cluster_node_volume_type", "ceph-ssd")
            ))
            .availabilityZone("MS1")
            .networkId(vkcs_networking_network.app().id())
            .subnetId(vkcs_networking_subnet.app().id())
            .floatingIpEnabled(true)
            .syncSecurityPolicy(true)
            .build(), CustomResourceOptions.builder()
                .dependsOn(vkcs_networking_router_interface.app())
                .build());

    }
}
Copy
resources:
  k8sCluster:
    type: vkcs:KubernetesCluster
    properties:
      clusterType: standard
      clusterTemplateId: ${data.vkcs_kubernetes_clustertemplate.k8s_31.id}
      masterFlavor: ${data.vkcs_compute_flavor.basic.id}
      masterCount: 1
      labels:
        cloud_monitoring: 'true'
        kube_log_level: '2'
        clean_volumes: 'true'
        master_volume_size: '100'
        cluster_node_volume_type: ceph-ssd
      availabilityZone: MS1
      networkId: ${vkcs_networking_network.app.id}
      subnetId: ${vkcs_networking_subnet.app.id}
      floatingIpEnabled: true
      syncSecurityPolicy: true
    options:
      dependsOn:
        - ${vkcs_networking_router_interface.app}
Copy

Regional Kubernetes cluster

import * as pulumi from "@pulumi/pulumi";
import * as vkcs from "@pulumi/vkcs";

const k8sCluster = new vkcs.KubernetesCluster("k8sCluster", {
    clusterType: "regional",
    clusterTemplateId: data.vkcs_kubernetes_clustertemplate.k8s_31.id,
    masterFlavor: data.vkcs_compute_flavor.basic.id,
    masterCount: 3,
    labels: {
        cloud_monitoring: "true",
        kube_log_level: "2",
        clean_volumes: "true",
        master_volume_size: "100",
        cluster_node_volume_type: "ceph-ssd",
    },
    networkId: vkcs_networking_network.app.id,
    subnetId: vkcs_networking_subnet.app.id,
    floatingIpEnabled: true,
    syncSecurityPolicy: true,
}, {
    dependsOn: [vkcs_networking_router_interface.app],
});
Copy
import pulumi
import pulumi_vkcs as vkcs

k8s_cluster = vkcs.KubernetesCluster("k8sCluster",
    cluster_type="regional",
    cluster_template_id=data["vkcs_kubernetes_clustertemplate"]["k8s_31"]["id"],
    master_flavor=data["vkcs_compute_flavor"]["basic"]["id"],
    master_count=3,
    labels={
        "cloud_monitoring": "true",
        "kube_log_level": "2",
        "clean_volumes": "true",
        "master_volume_size": "100",
        "cluster_node_volume_type": "ceph-ssd",
    },
    network_id=vkcs_networking_network["app"]["id"],
    subnet_id=vkcs_networking_subnet["app"]["id"],
    floating_ip_enabled=True,
    sync_security_policy=True,
    opts = pulumi.ResourceOptions(depends_on=[vkcs_networking_router_interface["app"]]))
Copy
package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vkcs/vkcs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := vkcs.NewKubernetesCluster(ctx, "k8sCluster", &vkcs.KubernetesClusterArgs{
			ClusterType:       pulumi.String("regional"),
			ClusterTemplateId: pulumi.Any(data.Vkcs_kubernetes_clustertemplate.K8s_31.Id),
			MasterFlavor:      pulumi.Any(data.Vkcs_compute_flavor.Basic.Id),
			MasterCount:       pulumi.Float64(3),
			Labels: pulumi.StringMap{
				"cloud_monitoring":         pulumi.String("true"),
				"kube_log_level":           pulumi.String("2"),
				"clean_volumes":            pulumi.String("true"),
				"master_volume_size":       pulumi.String("100"),
				"cluster_node_volume_type": pulumi.String("ceph-ssd"),
			},
			NetworkId:          pulumi.Any(vkcs_networking_network.App.Id),
			SubnetId:           pulumi.Any(vkcs_networking_subnet.App.Id),
			FloatingIpEnabled:  pulumi.Bool(true),
			SyncSecurityPolicy: pulumi.Bool(true),
		}, pulumi.DependsOn([]pulumi.Resource{
			vkcs_networking_router_interface.App,
		}))
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vkcs = Pulumi.Vkcs;

return await Deployment.RunAsync(() => 
{
    var k8sCluster = new Vkcs.KubernetesCluster("k8sCluster", new()
    {
        ClusterType = "regional",
        ClusterTemplateId = data.Vkcs_kubernetes_clustertemplate.K8s_31.Id,
        MasterFlavor = data.Vkcs_compute_flavor.Basic.Id,
        MasterCount = 3,
        Labels = 
        {
            { "cloud_monitoring", "true" },
            { "kube_log_level", "2" },
            { "clean_volumes", "true" },
            { "master_volume_size", "100" },
            { "cluster_node_volume_type", "ceph-ssd" },
        },
        NetworkId = vkcs_networking_network.App.Id,
        SubnetId = vkcs_networking_subnet.App.Id,
        FloatingIpEnabled = true,
        SyncSecurityPolicy = true,
    }, new CustomResourceOptions
    {
        DependsOn =
        {
            vkcs_networking_router_interface.App,
        },
    });

});
Copy
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vkcs.KubernetesCluster;
import com.pulumi.vkcs.KubernetesClusterArgs;
import com.pulumi.resources.CustomResourceOptions;
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 k8sCluster = new KubernetesCluster("k8sCluster", KubernetesClusterArgs.builder()
            .clusterType("regional")
            .clusterTemplateId(data.vkcs_kubernetes_clustertemplate().k8s_31().id())
            .masterFlavor(data.vkcs_compute_flavor().basic().id())
            .masterCount(3)
            .labels(Map.ofEntries(
                Map.entry("cloud_monitoring", "true"),
                Map.entry("kube_log_level", "2"),
                Map.entry("clean_volumes", "true"),
                Map.entry("master_volume_size", "100"),
                Map.entry("cluster_node_volume_type", "ceph-ssd")
            ))
            .networkId(vkcs_networking_network.app().id())
            .subnetId(vkcs_networking_subnet.app().id())
            .floatingIpEnabled(true)
            .syncSecurityPolicy(true)
            .build(), CustomResourceOptions.builder()
                .dependsOn(vkcs_networking_router_interface.app())
                .build());

    }
}
Copy
resources:
  k8sCluster:
    type: vkcs:KubernetesCluster
    properties:
      clusterType: regional
      clusterTemplateId: ${data.vkcs_kubernetes_clustertemplate.k8s_31.id}
      masterFlavor: ${data.vkcs_compute_flavor.basic.id}
      masterCount: 3
      labels:
        cloud_monitoring: 'true'
        kube_log_level: '2'
        clean_volumes: 'true'
        master_volume_size: '100'
        cluster_node_volume_type: ceph-ssd
      networkId: ${vkcs_networking_network.app.id}
      subnetId: ${vkcs_networking_subnet.app.id}
      floatingIpEnabled: true
      syncSecurityPolicy: true
    options:
      dependsOn:
        - ${vkcs_networking_router_interface.app}
Copy

Create KubernetesCluster Resource

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

Constructor syntax

new KubernetesCluster(name: string, args: KubernetesClusterArgs, opts?: CustomResourceOptions);
@overload
def KubernetesCluster(resource_name: str,
                      args: KubernetesClusterArgs,
                      opts: Optional[ResourceOptions] = None)

@overload
def KubernetesCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      cluster_template_id: Optional[str] = None,
                      subnet_id: Optional[str] = None,
                      network_id: Optional[str] = None,
                      floating_ip_enabled: Optional[bool] = None,
                      labels: Optional[Mapping[str, str]] = None,
                      master_flavor: Optional[str] = None,
                      dns_domain: Optional[str] = None,
                      availability_zones: Optional[Sequence[str]] = None,
                      ingress_floating_ip: Optional[str] = None,
                      insecure_registries: Optional[Sequence[str]] = None,
                      keypair: Optional[str] = None,
                      kubernetes_cluster_id: Optional[str] = None,
                      api_lb_fip: Optional[str] = None,
                      loadbalancer_subnet_id: Optional[str] = None,
                      master_count: Optional[float] = None,
                      cluster_type: Optional[str] = None,
                      name: Optional[str] = None,
                      availability_zone: Optional[str] = None,
                      pods_network_cidr: Optional[str] = None,
                      region: Optional[str] = None,
                      registry_auth_password: Optional[str] = None,
                      status: Optional[str] = None,
                      api_lb_vip: Optional[str] = None,
                      sync_security_policy: Optional[bool] = None,
                      timeouts: Optional[KubernetesClusterTimeoutsArgs] = None)
func NewKubernetesCluster(ctx *Context, name string, args KubernetesClusterArgs, opts ...ResourceOption) (*KubernetesCluster, error)
public KubernetesCluster(string name, KubernetesClusterArgs args, CustomResourceOptions? opts = null)
public KubernetesCluster(String name, KubernetesClusterArgs args)
public KubernetesCluster(String name, KubernetesClusterArgs args, CustomResourceOptions options)

type: vkcs:KubernetesCluster
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. KubernetesClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. KubernetesClusterArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. KubernetesClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. KubernetesClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. KubernetesClusterArgs
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 kubernetesClusterResource = new Vkcs.KubernetesCluster("kubernetesClusterResource", new()
{
    ClusterTemplateId = "string",
    SubnetId = "string",
    NetworkId = "string",
    FloatingIpEnabled = false,
    Labels = 
    {
        { "string", "string" },
    },
    MasterFlavor = "string",
    DnsDomain = "string",
    AvailabilityZones = new[]
    {
        "string",
    },
    InsecureRegistries = new[]
    {
        "string",
    },
    KubernetesClusterId = "string",
    ApiLbFip = "string",
    LoadbalancerSubnetId = "string",
    MasterCount = 0,
    ClusterType = "string",
    Name = "string",
    AvailabilityZone = "string",
    PodsNetworkCidr = "string",
    Region = "string",
    RegistryAuthPassword = "string",
    Status = "string",
    ApiLbVip = "string",
    SyncSecurityPolicy = false,
    Timeouts = new Vkcs.Inputs.KubernetesClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
});
Copy
example, err := vkcs.NewKubernetesCluster(ctx, "kubernetesClusterResource", &vkcs.KubernetesClusterArgs{
ClusterTemplateId: pulumi.String("string"),
SubnetId: pulumi.String("string"),
NetworkId: pulumi.String("string"),
FloatingIpEnabled: pulumi.Bool(false),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
MasterFlavor: pulumi.String("string"),
DnsDomain: pulumi.String("string"),
AvailabilityZones: pulumi.StringArray{
pulumi.String("string"),
},
InsecureRegistries: pulumi.StringArray{
pulumi.String("string"),
},
KubernetesClusterId: pulumi.String("string"),
ApiLbFip: pulumi.String("string"),
LoadbalancerSubnetId: pulumi.String("string"),
MasterCount: pulumi.Float64(0),
ClusterType: pulumi.String("string"),
Name: pulumi.String("string"),
AvailabilityZone: pulumi.String("string"),
PodsNetworkCidr: pulumi.String("string"),
Region: pulumi.String("string"),
RegistryAuthPassword: pulumi.String("string"),
Status: pulumi.String("string"),
ApiLbVip: pulumi.String("string"),
SyncSecurityPolicy: pulumi.Bool(false),
Timeouts: &.KubernetesClusterTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
})
Copy
var kubernetesClusterResource = new KubernetesCluster("kubernetesClusterResource", KubernetesClusterArgs.builder()
    .clusterTemplateId("string")
    .subnetId("string")
    .networkId("string")
    .floatingIpEnabled(false)
    .labels(Map.of("string", "string"))
    .masterFlavor("string")
    .dnsDomain("string")
    .availabilityZones("string")
    .insecureRegistries("string")
    .kubernetesClusterId("string")
    .apiLbFip("string")
    .loadbalancerSubnetId("string")
    .masterCount(0)
    .clusterType("string")
    .name("string")
    .availabilityZone("string")
    .podsNetworkCidr("string")
    .region("string")
    .registryAuthPassword("string")
    .status("string")
    .apiLbVip("string")
    .syncSecurityPolicy(false)
    .timeouts(KubernetesClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .build());
Copy
kubernetes_cluster_resource = vkcs.KubernetesCluster("kubernetesClusterResource",
    cluster_template_id="string",
    subnet_id="string",
    network_id="string",
    floating_ip_enabled=False,
    labels={
        "string": "string",
    },
    master_flavor="string",
    dns_domain="string",
    availability_zones=["string"],
    insecure_registries=["string"],
    kubernetes_cluster_id="string",
    api_lb_fip="string",
    loadbalancer_subnet_id="string",
    master_count=0,
    cluster_type="string",
    name="string",
    availability_zone="string",
    pods_network_cidr="string",
    region="string",
    registry_auth_password="string",
    status="string",
    api_lb_vip="string",
    sync_security_policy=False,
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    })
Copy
const kubernetesClusterResource = new vkcs.KubernetesCluster("kubernetesClusterResource", {
    clusterTemplateId: "string",
    subnetId: "string",
    networkId: "string",
    floatingIpEnabled: false,
    labels: {
        string: "string",
    },
    masterFlavor: "string",
    dnsDomain: "string",
    availabilityZones: ["string"],
    insecureRegistries: ["string"],
    kubernetesClusterId: "string",
    apiLbFip: "string",
    loadbalancerSubnetId: "string",
    masterCount: 0,
    clusterType: "string",
    name: "string",
    availabilityZone: "string",
    podsNetworkCidr: "string",
    region: "string",
    registryAuthPassword: "string",
    status: "string",
    apiLbVip: "string",
    syncSecurityPolicy: false,
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
});
Copy
type: vkcs:KubernetesCluster
properties:
    apiLbFip: string
    apiLbVip: string
    availabilityZone: string
    availabilityZones:
        - string
    clusterTemplateId: string
    clusterType: string
    dnsDomain: string
    floatingIpEnabled: false
    insecureRegistries:
        - string
    kubernetesClusterId: string
    labels:
        string: string
    loadbalancerSubnetId: string
    masterCount: 0
    masterFlavor: string
    name: string
    networkId: string
    podsNetworkCidr: string
    region: string
    registryAuthPassword: string
    status: string
    subnetId: string
    syncSecurityPolicy: false
    timeouts:
        create: string
        delete: string
        update: string
Copy

KubernetesCluster Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The KubernetesCluster resource accepts the following input properties:

ClusterTemplateId This property is required. string
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
FloatingIpEnabled This property is required. bool
required boolean → Floating ip is enabled.
NetworkId This property is required. string
required string → UUID of the cluster's network.
SubnetId This property is required. string
required string → UUID of the cluster's subnet.
ApiLbFip string
optional string → API LoadBalancer fip. IP address field.
ApiLbVip string
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
AvailabilityZone string
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
AvailabilityZones List<string>
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
ClusterType string
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
DnsDomain string
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
IngressFloatingIp string
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

InsecureRegistries List<string>
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
Keypair string
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

KubernetesClusterId string
string → ID of the resource.
Labels Dictionary<string, string>
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
LoadbalancerSubnetId string
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
MasterCount double
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
MasterFlavor string
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
Name string
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
PodsNetworkCidr string
optional string → Network cidr of k8s virtual network
Region string
optional string → Region to use for the cluster. Default is a region configured for provider.
RegistryAuthPassword string
optional string → Docker registry access password.
Status string
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
SyncSecurityPolicy bool
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
Timeouts KubernetesClusterTimeouts
ClusterTemplateId This property is required. string
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
FloatingIpEnabled This property is required. bool
required boolean → Floating ip is enabled.
NetworkId This property is required. string
required string → UUID of the cluster's network.
SubnetId This property is required. string
required string → UUID of the cluster's subnet.
ApiLbFip string
optional string → API LoadBalancer fip. IP address field.
ApiLbVip string
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
AvailabilityZone string
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
AvailabilityZones []string
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
ClusterType string
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
DnsDomain string
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
IngressFloatingIp string
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

InsecureRegistries []string
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
Keypair string
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

KubernetesClusterId string
string → ID of the resource.
Labels map[string]string
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
LoadbalancerSubnetId string
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
MasterCount float64
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
MasterFlavor string
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
Name string
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
PodsNetworkCidr string
optional string → Network cidr of k8s virtual network
Region string
optional string → Region to use for the cluster. Default is a region configured for provider.
RegistryAuthPassword string
optional string → Docker registry access password.
Status string
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
SyncSecurityPolicy bool
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
Timeouts KubernetesClusterTimeoutsArgs
clusterTemplateId This property is required. String
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
floatingIpEnabled This property is required. Boolean
required boolean → Floating ip is enabled.
networkId This property is required. String
required string → UUID of the cluster's network.
subnetId This property is required. String
required string → UUID of the cluster's subnet.
apiLbFip String
optional string → API LoadBalancer fip. IP address field.
apiLbVip String
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availabilityZone String
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availabilityZones List<String>
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
clusterType String
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
dnsDomain String
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
ingressFloatingIp String
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecureRegistries List<String>
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
keypair String
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetesClusterId String
string → ID of the resource.
labels Map<String,String>
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancerSubnetId String
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
masterCount Double
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
masterFlavor String
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name String
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
podsNetworkCidr String
optional string → Network cidr of k8s virtual network
region String
optional string → Region to use for the cluster. Default is a region configured for provider.
registryAuthPassword String
optional string → Docker registry access password.
status String
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
syncSecurityPolicy Boolean
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts KubernetesClusterTimeouts
clusterTemplateId This property is required. string
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
floatingIpEnabled This property is required. boolean
required boolean → Floating ip is enabled.
networkId This property is required. string
required string → UUID of the cluster's network.
subnetId This property is required. string
required string → UUID of the cluster's subnet.
apiLbFip string
optional string → API LoadBalancer fip. IP address field.
apiLbVip string
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availabilityZone string
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availabilityZones string[]
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
clusterType string
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
dnsDomain string
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
ingressFloatingIp string
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecureRegistries string[]
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
keypair string
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetesClusterId string
string → ID of the resource.
labels {[key: string]: string}
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancerSubnetId string
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
masterCount number
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
masterFlavor string
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name string
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
podsNetworkCidr string
optional string → Network cidr of k8s virtual network
region string
optional string → Region to use for the cluster. Default is a region configured for provider.
registryAuthPassword string
optional string → Docker registry access password.
status string
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
syncSecurityPolicy boolean
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts KubernetesClusterTimeouts
cluster_template_id This property is required. str
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
floating_ip_enabled This property is required. bool
required boolean → Floating ip is enabled.
network_id This property is required. str
required string → UUID of the cluster's network.
subnet_id This property is required. str
required string → UUID of the cluster's subnet.
api_lb_fip str
optional string → API LoadBalancer fip. IP address field.
api_lb_vip str
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availability_zone str
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availability_zones Sequence[str]
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
cluster_type str
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
dns_domain str
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
ingress_floating_ip str
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecure_registries Sequence[str]
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
keypair str
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetes_cluster_id str
string → ID of the resource.
labels Mapping[str, str]
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancer_subnet_id str
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
master_count float
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
master_flavor str
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name str
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
pods_network_cidr str
optional string → Network cidr of k8s virtual network
region str
optional string → Region to use for the cluster. Default is a region configured for provider.
registry_auth_password str
optional string → Docker registry access password.
status str
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
sync_security_policy bool
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts KubernetesClusterTimeoutsArgs
clusterTemplateId This property is required. String
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
floatingIpEnabled This property is required. Boolean
required boolean → Floating ip is enabled.
networkId This property is required. String
required string → UUID of the cluster's network.
subnetId This property is required. String
required string → UUID of the cluster's subnet.
apiLbFip String
optional string → API LoadBalancer fip. IP address field.
apiLbVip String
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availabilityZone String
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availabilityZones List<String>
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
clusterType String
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
dnsDomain String
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
ingressFloatingIp String
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecureRegistries List<String>
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
keypair String
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetesClusterId String
string → ID of the resource.
labels Map<String>
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancerSubnetId String
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
masterCount Number
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
masterFlavor String
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name String
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
podsNetworkCidr String
optional string → Network cidr of k8s virtual network
region String
optional string → Region to use for the cluster. Default is a region configured for provider.
registryAuthPassword String
optional string → Docker registry access password.
status String
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
syncSecurityPolicy Boolean
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts Property Map

Outputs

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

AllLabels Dictionary<string, string>
map of string → The read-only map of all cluster labels.New since v0.5.1.
ApiAddress string
string → COE API address.
CreatedAt string
string → The time at which cluster was created.
Id string
The provider-assigned unique ID for this managed resource.
K8sConfig string
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
MasterAddresses List<string>
string → IP addresses of the master node of the cluster.
ProjectId string
string → The project of the cluster.
StackId string
string → UUID of the Orchestration service stack.
UpdatedAt string
string → The time at which cluster was created.
UserId string
string → The user of the cluster.
AllLabels map[string]string
map of string → The read-only map of all cluster labels.New since v0.5.1.
ApiAddress string
string → COE API address.
CreatedAt string
string → The time at which cluster was created.
Id string
The provider-assigned unique ID for this managed resource.
K8sConfig string
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
MasterAddresses []string
string → IP addresses of the master node of the cluster.
ProjectId string
string → The project of the cluster.
StackId string
string → UUID of the Orchestration service stack.
UpdatedAt string
string → The time at which cluster was created.
UserId string
string → The user of the cluster.
allLabels Map<String,String>
map of string → The read-only map of all cluster labels.New since v0.5.1.
apiAddress String
string → COE API address.
createdAt String
string → The time at which cluster was created.
id String
The provider-assigned unique ID for this managed resource.
k8sConfig String
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
masterAddresses List<String>
string → IP addresses of the master node of the cluster.
projectId String
string → The project of the cluster.
stackId String
string → UUID of the Orchestration service stack.
updatedAt String
string → The time at which cluster was created.
userId String
string → The user of the cluster.
allLabels {[key: string]: string}
map of string → The read-only map of all cluster labels.New since v0.5.1.
apiAddress string
string → COE API address.
createdAt string
string → The time at which cluster was created.
id string
The provider-assigned unique ID for this managed resource.
k8sConfig string
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
masterAddresses string[]
string → IP addresses of the master node of the cluster.
projectId string
string → The project of the cluster.
stackId string
string → UUID of the Orchestration service stack.
updatedAt string
string → The time at which cluster was created.
userId string
string → The user of the cluster.
all_labels Mapping[str, str]
map of string → The read-only map of all cluster labels.New since v0.5.1.
api_address str
string → COE API address.
created_at str
string → The time at which cluster was created.
id str
The provider-assigned unique ID for this managed resource.
k8s_config str
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
master_addresses Sequence[str]
string → IP addresses of the master node of the cluster.
project_id str
string → The project of the cluster.
stack_id str
string → UUID of the Orchestration service stack.
updated_at str
string → The time at which cluster was created.
user_id str
string → The user of the cluster.
allLabels Map<String>
map of string → The read-only map of all cluster labels.New since v0.5.1.
apiAddress String
string → COE API address.
createdAt String
string → The time at which cluster was created.
id String
The provider-assigned unique ID for this managed resource.
k8sConfig String
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
masterAddresses List<String>
string → IP addresses of the master node of the cluster.
projectId String
string → The project of the cluster.
stackId String
string → UUID of the Orchestration service stack.
updatedAt String
string → The time at which cluster was created.
userId String
string → The user of the cluster.

Look up Existing KubernetesCluster Resource

Get an existing KubernetesCluster 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?: KubernetesClusterState, opts?: CustomResourceOptions): KubernetesCluster
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        all_labels: Optional[Mapping[str, str]] = None,
        api_address: Optional[str] = None,
        api_lb_fip: Optional[str] = None,
        api_lb_vip: Optional[str] = None,
        availability_zone: Optional[str] = None,
        availability_zones: Optional[Sequence[str]] = None,
        cluster_template_id: Optional[str] = None,
        cluster_type: Optional[str] = None,
        created_at: Optional[str] = None,
        dns_domain: Optional[str] = None,
        floating_ip_enabled: Optional[bool] = None,
        ingress_floating_ip: Optional[str] = None,
        insecure_registries: Optional[Sequence[str]] = None,
        k8s_config: Optional[str] = None,
        keypair: Optional[str] = None,
        kubernetes_cluster_id: Optional[str] = None,
        labels: Optional[Mapping[str, str]] = None,
        loadbalancer_subnet_id: Optional[str] = None,
        master_addresses: Optional[Sequence[str]] = None,
        master_count: Optional[float] = None,
        master_flavor: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        pods_network_cidr: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        registry_auth_password: Optional[str] = None,
        stack_id: Optional[str] = None,
        status: Optional[str] = None,
        subnet_id: Optional[str] = None,
        sync_security_policy: Optional[bool] = None,
        timeouts: Optional[KubernetesClusterTimeoutsArgs] = None,
        updated_at: Optional[str] = None,
        user_id: Optional[str] = None) -> KubernetesCluster
func GetKubernetesCluster(ctx *Context, name string, id IDInput, state *KubernetesClusterState, opts ...ResourceOption) (*KubernetesCluster, error)
public static KubernetesCluster Get(string name, Input<string> id, KubernetesClusterState? state, CustomResourceOptions? opts = null)
public static KubernetesCluster get(String name, Output<String> id, KubernetesClusterState state, CustomResourceOptions options)
resources:  _:    type: vkcs:KubernetesCluster    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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 This property is required.
The unique name of the resulting resource.
id This property is required.
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:
AllLabels Dictionary<string, string>
map of string → The read-only map of all cluster labels.New since v0.5.1.
ApiAddress string
string → COE API address.
ApiLbFip string
optional string → API LoadBalancer fip. IP address field.
ApiLbVip string
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
AvailabilityZone string
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
AvailabilityZones List<string>
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
ClusterTemplateId string
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
ClusterType string
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
CreatedAt string
string → The time at which cluster was created.
DnsDomain string
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
FloatingIpEnabled bool
required boolean → Floating ip is enabled.
IngressFloatingIp string
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

InsecureRegistries List<string>
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
K8sConfig string
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
Keypair string
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

KubernetesClusterId string
string → ID of the resource.
Labels Dictionary<string, string>
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
LoadbalancerSubnetId string
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
MasterAddresses List<string>
string → IP addresses of the master node of the cluster.
MasterCount double
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
MasterFlavor string
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
Name string
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
NetworkId string
required string → UUID of the cluster's network.
PodsNetworkCidr string
optional string → Network cidr of k8s virtual network
ProjectId string
string → The project of the cluster.
Region string
optional string → Region to use for the cluster. Default is a region configured for provider.
RegistryAuthPassword string
optional string → Docker registry access password.
StackId string
string → UUID of the Orchestration service stack.
Status string
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
SubnetId string
required string → UUID of the cluster's subnet.
SyncSecurityPolicy bool
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
Timeouts KubernetesClusterTimeouts
UpdatedAt string
string → The time at which cluster was created.
UserId string
string → The user of the cluster.
AllLabels map[string]string
map of string → The read-only map of all cluster labels.New since v0.5.1.
ApiAddress string
string → COE API address.
ApiLbFip string
optional string → API LoadBalancer fip. IP address field.
ApiLbVip string
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
AvailabilityZone string
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
AvailabilityZones []string
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
ClusterTemplateId string
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
ClusterType string
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
CreatedAt string
string → The time at which cluster was created.
DnsDomain string
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
FloatingIpEnabled bool
required boolean → Floating ip is enabled.
IngressFloatingIp string
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

InsecureRegistries []string
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
K8sConfig string
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
Keypair string
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

KubernetesClusterId string
string → ID of the resource.
Labels map[string]string
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
LoadbalancerSubnetId string
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
MasterAddresses []string
string → IP addresses of the master node of the cluster.
MasterCount float64
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
MasterFlavor string
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
Name string
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
NetworkId string
required string → UUID of the cluster's network.
PodsNetworkCidr string
optional string → Network cidr of k8s virtual network
ProjectId string
string → The project of the cluster.
Region string
optional string → Region to use for the cluster. Default is a region configured for provider.
RegistryAuthPassword string
optional string → Docker registry access password.
StackId string
string → UUID of the Orchestration service stack.
Status string
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
SubnetId string
required string → UUID of the cluster's subnet.
SyncSecurityPolicy bool
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
Timeouts KubernetesClusterTimeoutsArgs
UpdatedAt string
string → The time at which cluster was created.
UserId string
string → The user of the cluster.
allLabels Map<String,String>
map of string → The read-only map of all cluster labels.New since v0.5.1.
apiAddress String
string → COE API address.
apiLbFip String
optional string → API LoadBalancer fip. IP address field.
apiLbVip String
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availabilityZone String
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availabilityZones List<String>
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
clusterTemplateId String
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
clusterType String
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
createdAt String
string → The time at which cluster was created.
dnsDomain String
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
floatingIpEnabled Boolean
required boolean → Floating ip is enabled.
ingressFloatingIp String
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecureRegistries List<String>
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
k8sConfig String
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
keypair String
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetesClusterId String
string → ID of the resource.
labels Map<String,String>
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancerSubnetId String
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
masterAddresses List<String>
string → IP addresses of the master node of the cluster.
masterCount Double
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
masterFlavor String
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name String
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
networkId String
required string → UUID of the cluster's network.
podsNetworkCidr String
optional string → Network cidr of k8s virtual network
projectId String
string → The project of the cluster.
region String
optional string → Region to use for the cluster. Default is a region configured for provider.
registryAuthPassword String
optional string → Docker registry access password.
stackId String
string → UUID of the Orchestration service stack.
status String
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
subnetId String
required string → UUID of the cluster's subnet.
syncSecurityPolicy Boolean
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts KubernetesClusterTimeouts
updatedAt String
string → The time at which cluster was created.
userId String
string → The user of the cluster.
allLabels {[key: string]: string}
map of string → The read-only map of all cluster labels.New since v0.5.1.
apiAddress string
string → COE API address.
apiLbFip string
optional string → API LoadBalancer fip. IP address field.
apiLbVip string
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availabilityZone string
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availabilityZones string[]
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
clusterTemplateId string
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
clusterType string
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
createdAt string
string → The time at which cluster was created.
dnsDomain string
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
floatingIpEnabled boolean
required boolean → Floating ip is enabled.
ingressFloatingIp string
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecureRegistries string[]
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
k8sConfig string
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
keypair string
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetesClusterId string
string → ID of the resource.
labels {[key: string]: string}
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancerSubnetId string
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
masterAddresses string[]
string → IP addresses of the master node of the cluster.
masterCount number
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
masterFlavor string
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name string
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
networkId string
required string → UUID of the cluster's network.
podsNetworkCidr string
optional string → Network cidr of k8s virtual network
projectId string
string → The project of the cluster.
region string
optional string → Region to use for the cluster. Default is a region configured for provider.
registryAuthPassword string
optional string → Docker registry access password.
stackId string
string → UUID of the Orchestration service stack.
status string
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
subnetId string
required string → UUID of the cluster's subnet.
syncSecurityPolicy boolean
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts KubernetesClusterTimeouts
updatedAt string
string → The time at which cluster was created.
userId string
string → The user of the cluster.
all_labels Mapping[str, str]
map of string → The read-only map of all cluster labels.New since v0.5.1.
api_address str
string → COE API address.
api_lb_fip str
optional string → API LoadBalancer fip. IP address field.
api_lb_vip str
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availability_zone str
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availability_zones Sequence[str]
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
cluster_template_id str
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
cluster_type str
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
created_at str
string → The time at which cluster was created.
dns_domain str
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
floating_ip_enabled bool
required boolean → Floating ip is enabled.
ingress_floating_ip str
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecure_registries Sequence[str]
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
k8s_config str
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
keypair str
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetes_cluster_id str
string → ID of the resource.
labels Mapping[str, str]
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancer_subnet_id str
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
master_addresses Sequence[str]
string → IP addresses of the master node of the cluster.
master_count float
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
master_flavor str
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name str
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
network_id str
required string → UUID of the cluster's network.
pods_network_cidr str
optional string → Network cidr of k8s virtual network
project_id str
string → The project of the cluster.
region str
optional string → Region to use for the cluster. Default is a region configured for provider.
registry_auth_password str
optional string → Docker registry access password.
stack_id str
string → UUID of the Orchestration service stack.
status str
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
subnet_id str
required string → UUID of the cluster's subnet.
sync_security_policy bool
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts KubernetesClusterTimeoutsArgs
updated_at str
string → The time at which cluster was created.
user_id str
string → The user of the cluster.
allLabels Map<String>
map of string → The read-only map of all cluster labels.New since v0.5.1.
apiAddress String
string → COE API address.
apiLbFip String
optional string → API LoadBalancer fip. IP address field.
apiLbVip String
optional string → API LoadBalancer vip. IP address field. The field is read-only, the value set in this field will be ignored. The ability to set this field will be removed in future versions of the provider.
availabilityZone String
optional string → Availability zone of the cluster, set this argument only for cluster with type standard.
availabilityZones List<String>
optional set of string → Availability zones of the regional cluster, set this argument only for cluster with type regional. If you do not set this argument, the availability zones will be selected automatically.New since v0.8.3.
clusterTemplateId String
required string → The UUID of the Kubernetes cluster template. It can be obtained using the cluster_template data source.
clusterType String
optional string → Type of the kubernetes cluster, may be standard or regional. Default type is standard.New since v0.8.3.
createdAt String
string → The time at which cluster was created.
dnsDomain String
optional string → Custom DNS cluster domain. Changing this creates a new cluster.
floatingIpEnabled Boolean
required boolean → Floating ip is enabled.
ingressFloatingIp String
optional deprecated string → Floating IP created for ingress service. Deprecated This argument is deprecated as Ingress controller is not currently installed by default.

Deprecated: Deprecated

insecureRegistries List<String>
optional string → Addresses of registries from which you can download images without checking certificates. Changing this creates a new cluster.
k8sConfig String
string → Contents of the kubeconfig file. Use it to authenticate to Kubernetes cluster.New since v0.8.1.
keypair String
optional deprecated string → The name of the Compute service SSH keypair. Changing this creates a new cluster. Deprecated This argument is deprecated, please do not use it.

Deprecated: Deprecated

kubernetesClusterId String
string → ID of the resource.
labels Map<String>
optional map of string → The list of optional key value pairs representing additional properties of the cluster. Note: Updating this attribute will not immediately apply the changes; these options will be used when recreating or deleting cluster nodes, for example, during an upgrade operation.
loadbalancerSubnetId String
optional string → The UUID of the load balancer's subnet. Changing this creates new cluster.
masterAddresses List<String>
string → IP addresses of the master node of the cluster.
masterCount Number
optional number → The number of master nodes for the cluster. Changing this creates a new cluster.
masterFlavor String
optional string → The UUID of a flavor for the master nodes. If master_flavor is not present, value from cluster_template will be used.
name String
required string → The name of the cluster. Changing this creates a new cluster. Should match the pattern ^[a-zA-Z][a-zA-Z0-9_.-]*$.
networkId String
required string → UUID of the cluster's network.
podsNetworkCidr String
optional string → Network cidr of k8s virtual network
projectId String
string → The project of the cluster.
region String
optional string → Region to use for the cluster. Default is a region configured for provider.
registryAuthPassword String
optional string → Docker registry access password.
stackId String
string → UUID of the Orchestration service stack.
status String
optional string → Current state of a cluster. Changing this to RUNNING or SHUTOFF will turn cluster on/off.
subnetId String
required string → UUID of the cluster's subnet.
syncSecurityPolicy Boolean
optional boolean → Enables syncing of security policies of cluster. Default value is false.New since v0.7.0.
timeouts Property Map
updatedAt String
string → The time at which cluster was created.
userId String
string → The user of the cluster.

Supporting Types

KubernetesClusterTimeouts
, KubernetesClusterTimeoutsArgs

Create string
Delete string
Update string
Create string
Delete string
Update string
create String
delete String
update String
create string
delete string
update string
create str
delete str
update str
create String
delete String
update String

Import

Clusters can be imported using the id, e.g.

$ pulumi import vkcs:index/kubernetesCluster:KubernetesCluster mycluster ce0f9463-dd25-474b-9fe8-94de63e5e42b
Copy

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

Package Details

Repository
vkcs vk-cs/terraform-provider-vkcs
License
Notes
This Pulumi package is based on the vkcs Terraform Provider.
vkcs 0.9.3 published on Tuesday, Apr 15, 2025 by vk-cs
vk-cs/terraform-provider-vkcs