1. Packages
  2. Civo Provider
  3. API Docs
  4. KubernetesCluster
civo 1.1.5 published on Thursday, Feb 6, 2025 by civo

civo.KubernetesCluster

Explore with Pulumi AI

Import

using ID

$ pulumi import civo:index/kubernetesCluster:KubernetesCluster my-cluster 1b8b2100-0e9f-4e8f-ad78-9eb578c2a0af
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,
                      pools: Optional[KubernetesClusterPoolsArgs] = None,
                      firewall_id: Optional[str] = None,
                      num_target_nodes: Optional[float] = None,
                      cni: Optional[str] = None,
                      kubernetes_cluster_id: Optional[str] = None,
                      kubernetes_version: Optional[str] = None,
                      cluster_type: Optional[str] = None,
                      network_id: Optional[str] = None,
                      name: Optional[str] = None,
                      applications: Optional[str] = None,
                      region: Optional[str] = None,
                      tags: Optional[str] = None,
                      target_nodes_size: Optional[str] = None,
                      timeouts: Optional[KubernetesClusterTimeoutsArgs] = None,
                      write_kubeconfig: Optional[bool] = 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: civo: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 Civo.KubernetesCluster("kubernetesClusterResource", new()
{
    Pools = new Civo.Inputs.KubernetesClusterPoolsArgs
    {
        NodeCount = 0,
        Size = "string",
        InstanceNames = new[]
        {
            "string",
        },
        Label = "string",
        Labels = 
        {
            { "string", "string" },
        },
        PublicIpNodePool = false,
        Taints = new[]
        {
            new Civo.Inputs.KubernetesClusterPoolsTaintArgs
            {
                Effect = "string",
                Key = "string",
                Value = "string",
            },
        },
    },
    FirewallId = "string",
    Cni = "string",
    KubernetesClusterId = "string",
    KubernetesVersion = "string",
    ClusterType = "string",
    NetworkId = "string",
    Name = "string",
    Applications = "string",
    Region = "string",
    Tags = "string",
    Timeouts = new Civo.Inputs.KubernetesClusterTimeoutsArgs
    {
        Create = "string",
        Delete = "string",
        Update = "string",
    },
    WriteKubeconfig = false,
});
Copy
example, err := civo.NewKubernetesCluster(ctx, "kubernetesClusterResource", &civo.KubernetesClusterArgs{
Pools: &.KubernetesClusterPoolsArgs{
NodeCount: pulumi.Float64(0),
Size: pulumi.String("string"),
InstanceNames: pulumi.StringArray{
pulumi.String("string"),
},
Label: pulumi.String("string"),
Labels: pulumi.StringMap{
"string": pulumi.String("string"),
},
PublicIpNodePool: pulumi.Bool(false),
Taints: .KubernetesClusterPoolsTaintArray{
&.KubernetesClusterPoolsTaintArgs{
Effect: pulumi.String("string"),
Key: pulumi.String("string"),
Value: pulumi.String("string"),
},
},
},
FirewallId: pulumi.String("string"),
Cni: pulumi.String("string"),
KubernetesClusterId: pulumi.String("string"),
KubernetesVersion: pulumi.String("string"),
ClusterType: pulumi.String("string"),
NetworkId: pulumi.String("string"),
Name: pulumi.String("string"),
Applications: pulumi.String("string"),
Region: pulumi.String("string"),
Tags: pulumi.String("string"),
Timeouts: &.KubernetesClusterTimeoutsArgs{
Create: pulumi.String("string"),
Delete: pulumi.String("string"),
Update: pulumi.String("string"),
},
WriteKubeconfig: pulumi.Bool(false),
})
Copy
var kubernetesClusterResource = new KubernetesCluster("kubernetesClusterResource", KubernetesClusterArgs.builder()
    .pools(KubernetesClusterPoolsArgs.builder()
        .nodeCount(0)
        .size("string")
        .instanceNames("string")
        .label("string")
        .labels(Map.of("string", "string"))
        .publicIpNodePool(false)
        .taints(KubernetesClusterPoolsTaintArgs.builder()
            .effect("string")
            .key("string")
            .value("string")
            .build())
        .build())
    .firewallId("string")
    .cni("string")
    .kubernetesClusterId("string")
    .kubernetesVersion("string")
    .clusterType("string")
    .networkId("string")
    .name("string")
    .applications("string")
    .region("string")
    .tags("string")
    .timeouts(KubernetesClusterTimeoutsArgs.builder()
        .create("string")
        .delete("string")
        .update("string")
        .build())
    .writeKubeconfig(false)
    .build());
Copy
kubernetes_cluster_resource = civo.KubernetesCluster("kubernetesClusterResource",
    pools={
        "node_count": 0,
        "size": "string",
        "instance_names": ["string"],
        "label": "string",
        "labels": {
            "string": "string",
        },
        "public_ip_node_pool": False,
        "taints": [{
            "effect": "string",
            "key": "string",
            "value": "string",
        }],
    },
    firewall_id="string",
    cni="string",
    kubernetes_cluster_id="string",
    kubernetes_version="string",
    cluster_type="string",
    network_id="string",
    name="string",
    applications="string",
    region="string",
    tags="string",
    timeouts={
        "create": "string",
        "delete": "string",
        "update": "string",
    },
    write_kubeconfig=False)
Copy
const kubernetesClusterResource = new civo.KubernetesCluster("kubernetesClusterResource", {
    pools: {
        nodeCount: 0,
        size: "string",
        instanceNames: ["string"],
        label: "string",
        labels: {
            string: "string",
        },
        publicIpNodePool: false,
        taints: [{
            effect: "string",
            key: "string",
            value: "string",
        }],
    },
    firewallId: "string",
    cni: "string",
    kubernetesClusterId: "string",
    kubernetesVersion: "string",
    clusterType: "string",
    networkId: "string",
    name: "string",
    applications: "string",
    region: "string",
    tags: "string",
    timeouts: {
        create: "string",
        "delete": "string",
        update: "string",
    },
    writeKubeconfig: false,
});
Copy
type: civo:KubernetesCluster
properties:
    applications: string
    clusterType: string
    cni: string
    firewallId: string
    kubernetesClusterId: string
    kubernetesVersion: string
    name: string
    networkId: string
    pools:
        instanceNames:
            - string
        label: string
        labels:
            string: string
        nodeCount: 0
        publicIpNodePool: false
        size: string
        taints:
            - effect: string
              key: string
              value: string
    region: string
    tags: string
    timeouts:
        create: string
        delete: string
        update: string
    writeKubeconfig: false
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:

FirewallId This property is required. string
The existing firewall ID to use for this cluster
Pools This property is required. KubernetesClusterPools
Applications string
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
ClusterType string
The type of cluster to create, valid options are k3s or talos the default is k3s
Cni string
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
KubernetesClusterId string
(String) The ID of this resource.
KubernetesVersion string
The version of k3s to install (optional, the default is currently the latest stable available)
Name string
Name for your cluster, must be unique within your account
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes double
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

Region string
The region for the cluster, if not declare we use the region in declared in the provider
Tags string
Space separated list of tags, to be used freely as required
TargetNodesSize string
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

Timeouts KubernetesClusterTimeouts
WriteKubeconfig bool
Whether to write the kubeconfig to state
FirewallId This property is required. string
The existing firewall ID to use for this cluster
Pools This property is required. KubernetesClusterPoolsArgs
Applications string
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
ClusterType string
The type of cluster to create, valid options are k3s or talos the default is k3s
Cni string
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
KubernetesClusterId string
(String) The ID of this resource.
KubernetesVersion string
The version of k3s to install (optional, the default is currently the latest stable available)
Name string
Name for your cluster, must be unique within your account
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes float64
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

Region string
The region for the cluster, if not declare we use the region in declared in the provider
Tags string
Space separated list of tags, to be used freely as required
TargetNodesSize string
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

Timeouts KubernetesClusterTimeoutsArgs
WriteKubeconfig bool
Whether to write the kubeconfig to state
firewallId This property is required. String
The existing firewall ID to use for this cluster
pools This property is required. KubernetesClusterPools
applications String
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
clusterType String
The type of cluster to create, valid options are k3s or talos the default is k3s
cni String
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
kubernetesClusterId String
(String) The ID of this resource.
kubernetesVersion String
The version of k3s to install (optional, the default is currently the latest stable available)
name String
Name for your cluster, must be unique within your account
networkId String
The network for the cluster, if not declare we use the default one
numTargetNodes Double
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

region String
The region for the cluster, if not declare we use the region in declared in the provider
tags String
Space separated list of tags, to be used freely as required
targetNodesSize String
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts KubernetesClusterTimeouts
writeKubeconfig Boolean
Whether to write the kubeconfig to state
firewallId This property is required. string
The existing firewall ID to use for this cluster
pools This property is required. KubernetesClusterPools
applications string
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
clusterType string
The type of cluster to create, valid options are k3s or talos the default is k3s
cni string
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
kubernetesClusterId string
(String) The ID of this resource.
kubernetesVersion string
The version of k3s to install (optional, the default is currently the latest stable available)
name string
Name for your cluster, must be unique within your account
networkId string
The network for the cluster, if not declare we use the default one
numTargetNodes number
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

region string
The region for the cluster, if not declare we use the region in declared in the provider
tags string
Space separated list of tags, to be used freely as required
targetNodesSize string
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts KubernetesClusterTimeouts
writeKubeconfig boolean
Whether to write the kubeconfig to state
firewall_id This property is required. str
The existing firewall ID to use for this cluster
pools This property is required. KubernetesClusterPoolsArgs
applications str
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
cluster_type str
The type of cluster to create, valid options are k3s or talos the default is k3s
cni str
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
kubernetes_cluster_id str
(String) The ID of this resource.
kubernetes_version str
The version of k3s to install (optional, the default is currently the latest stable available)
name str
Name for your cluster, must be unique within your account
network_id str
The network for the cluster, if not declare we use the default one
num_target_nodes float
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

region str
The region for the cluster, if not declare we use the region in declared in the provider
tags str
Space separated list of tags, to be used freely as required
target_nodes_size str
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts KubernetesClusterTimeoutsArgs
write_kubeconfig bool
Whether to write the kubeconfig to state
firewallId This property is required. String
The existing firewall ID to use for this cluster
pools This property is required. Property Map
applications String
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
clusterType String
The type of cluster to create, valid options are k3s or talos the default is k3s
cni String
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
kubernetesClusterId String
(String) The ID of this resource.
kubernetesVersion String
The version of k3s to install (optional, the default is currently the latest stable available)
name String
Name for your cluster, must be unique within your account
networkId String
The network for the cluster, if not declare we use the default one
numTargetNodes Number
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

region String
The region for the cluster, if not declare we use the region in declared in the provider
tags String
Space separated list of tags, to be used freely as required
targetNodesSize String
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts Property Map
writeKubeconfig Boolean
Whether to write the kubeconfig to state

Outputs

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

ApiEndpoint string
(String) The API server endpoint of the cluster
CreatedAt string
(String) The timestamp when the cluster was created
DnsEntry string
(String) The DNS name of the cluster
Id string
The provider-assigned unique ID for this managed resource.
InstalledApplications List<KubernetesClusterInstalledApplication>
(List of Object) (see below for nested schema)
Kubeconfig string
(String, Sensitive) The kubeconfig of the cluster
MasterIp string
(String) The IP address of the master node
Ready bool
(Boolean) When cluster is ready, this will return true
Status string
(String) Status of the cluster
ApiEndpoint string
(String) The API server endpoint of the cluster
CreatedAt string
(String) The timestamp when the cluster was created
DnsEntry string
(String) The DNS name of the cluster
Id string
The provider-assigned unique ID for this managed resource.
InstalledApplications []KubernetesClusterInstalledApplication
(List of Object) (see below for nested schema)
Kubeconfig string
(String, Sensitive) The kubeconfig of the cluster
MasterIp string
(String) The IP address of the master node
Ready bool
(Boolean) When cluster is ready, this will return true
Status string
(String) Status of the cluster
apiEndpoint String
(String) The API server endpoint of the cluster
createdAt String
(String) The timestamp when the cluster was created
dnsEntry String
(String) The DNS name of the cluster
id String
The provider-assigned unique ID for this managed resource.
installedApplications List<KubernetesClusterInstalledApplication>
(List of Object) (see below for nested schema)
kubeconfig String
(String, Sensitive) The kubeconfig of the cluster
masterIp String
(String) The IP address of the master node
ready Boolean
(Boolean) When cluster is ready, this will return true
status String
(String) Status of the cluster
apiEndpoint string
(String) The API server endpoint of the cluster
createdAt string
(String) The timestamp when the cluster was created
dnsEntry string
(String) The DNS name of the cluster
id string
The provider-assigned unique ID for this managed resource.
installedApplications KubernetesClusterInstalledApplication[]
(List of Object) (see below for nested schema)
kubeconfig string
(String, Sensitive) The kubeconfig of the cluster
masterIp string
(String) The IP address of the master node
ready boolean
(Boolean) When cluster is ready, this will return true
status string
(String) Status of the cluster
api_endpoint str
(String) The API server endpoint of the cluster
created_at str
(String) The timestamp when the cluster was created
dns_entry str
(String) The DNS name of the cluster
id str
The provider-assigned unique ID for this managed resource.
installed_applications Sequence[KubernetesClusterInstalledApplication]
(List of Object) (see below for nested schema)
kubeconfig str
(String, Sensitive) The kubeconfig of the cluster
master_ip str
(String) The IP address of the master node
ready bool
(Boolean) When cluster is ready, this will return true
status str
(String) Status of the cluster
apiEndpoint String
(String) The API server endpoint of the cluster
createdAt String
(String) The timestamp when the cluster was created
dnsEntry String
(String) The DNS name of the cluster
id String
The provider-assigned unique ID for this managed resource.
installedApplications List<Property Map>
(List of Object) (see below for nested schema)
kubeconfig String
(String, Sensitive) The kubeconfig of the cluster
masterIp String
(String) The IP address of the master node
ready Boolean
(Boolean) When cluster is ready, this will return true
status String
(String) Status 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,
        api_endpoint: Optional[str] = None,
        applications: Optional[str] = None,
        cluster_type: Optional[str] = None,
        cni: Optional[str] = None,
        created_at: Optional[str] = None,
        dns_entry: Optional[str] = None,
        firewall_id: Optional[str] = None,
        installed_applications: Optional[Sequence[KubernetesClusterInstalledApplicationArgs]] = None,
        kubeconfig: Optional[str] = None,
        kubernetes_cluster_id: Optional[str] = None,
        kubernetes_version: Optional[str] = None,
        master_ip: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        num_target_nodes: Optional[float] = None,
        pools: Optional[KubernetesClusterPoolsArgs] = None,
        ready: Optional[bool] = None,
        region: Optional[str] = None,
        status: Optional[str] = None,
        tags: Optional[str] = None,
        target_nodes_size: Optional[str] = None,
        timeouts: Optional[KubernetesClusterTimeoutsArgs] = None,
        write_kubeconfig: Optional[bool] = 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: civo: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:
ApiEndpoint string
(String) The API server endpoint of the cluster
Applications string
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
ClusterType string
The type of cluster to create, valid options are k3s or talos the default is k3s
Cni string
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
CreatedAt string
(String) The timestamp when the cluster was created
DnsEntry string
(String) The DNS name of the cluster
FirewallId string
The existing firewall ID to use for this cluster
InstalledApplications List<KubernetesClusterInstalledApplication>
(List of Object) (see below for nested schema)
Kubeconfig string
(String, Sensitive) The kubeconfig of the cluster
KubernetesClusterId string
(String) The ID of this resource.
KubernetesVersion string
The version of k3s to install (optional, the default is currently the latest stable available)
MasterIp string
(String) The IP address of the master node
Name string
Name for your cluster, must be unique within your account
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes double
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

Pools KubernetesClusterPools
Ready bool
(Boolean) When cluster is ready, this will return true
Region string
The region for the cluster, if not declare we use the region in declared in the provider
Status string
(String) Status of the cluster
Tags string
Space separated list of tags, to be used freely as required
TargetNodesSize string
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

Timeouts KubernetesClusterTimeouts
WriteKubeconfig bool
Whether to write the kubeconfig to state
ApiEndpoint string
(String) The API server endpoint of the cluster
Applications string
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
ClusterType string
The type of cluster to create, valid options are k3s or talos the default is k3s
Cni string
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
CreatedAt string
(String) The timestamp when the cluster was created
DnsEntry string
(String) The DNS name of the cluster
FirewallId string
The existing firewall ID to use for this cluster
InstalledApplications []KubernetesClusterInstalledApplicationArgs
(List of Object) (see below for nested schema)
Kubeconfig string
(String, Sensitive) The kubeconfig of the cluster
KubernetesClusterId string
(String) The ID of this resource.
KubernetesVersion string
The version of k3s to install (optional, the default is currently the latest stable available)
MasterIp string
(String) The IP address of the master node
Name string
Name for your cluster, must be unique within your account
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes float64
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

Pools KubernetesClusterPoolsArgs
Ready bool
(Boolean) When cluster is ready, this will return true
Region string
The region for the cluster, if not declare we use the region in declared in the provider
Status string
(String) Status of the cluster
Tags string
Space separated list of tags, to be used freely as required
TargetNodesSize string
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

Timeouts KubernetesClusterTimeoutsArgs
WriteKubeconfig bool
Whether to write the kubeconfig to state
apiEndpoint String
(String) The API server endpoint of the cluster
applications String
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
clusterType String
The type of cluster to create, valid options are k3s or talos the default is k3s
cni String
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
createdAt String
(String) The timestamp when the cluster was created
dnsEntry String
(String) The DNS name of the cluster
firewallId String
The existing firewall ID to use for this cluster
installedApplications List<KubernetesClusterInstalledApplication>
(List of Object) (see below for nested schema)
kubeconfig String
(String, Sensitive) The kubeconfig of the cluster
kubernetesClusterId String
(String) The ID of this resource.
kubernetesVersion String
The version of k3s to install (optional, the default is currently the latest stable available)
masterIp String
(String) The IP address of the master node
name String
Name for your cluster, must be unique within your account
networkId String
The network for the cluster, if not declare we use the default one
numTargetNodes Double
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

pools KubernetesClusterPools
ready Boolean
(Boolean) When cluster is ready, this will return true
region String
The region for the cluster, if not declare we use the region in declared in the provider
status String
(String) Status of the cluster
tags String
Space separated list of tags, to be used freely as required
targetNodesSize String
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts KubernetesClusterTimeouts
writeKubeconfig Boolean
Whether to write the kubeconfig to state
apiEndpoint string
(String) The API server endpoint of the cluster
applications string
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
clusterType string
The type of cluster to create, valid options are k3s or talos the default is k3s
cni string
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
createdAt string
(String) The timestamp when the cluster was created
dnsEntry string
(String) The DNS name of the cluster
firewallId string
The existing firewall ID to use for this cluster
installedApplications KubernetesClusterInstalledApplication[]
(List of Object) (see below for nested schema)
kubeconfig string
(String, Sensitive) The kubeconfig of the cluster
kubernetesClusterId string
(String) The ID of this resource.
kubernetesVersion string
The version of k3s to install (optional, the default is currently the latest stable available)
masterIp string
(String) The IP address of the master node
name string
Name for your cluster, must be unique within your account
networkId string
The network for the cluster, if not declare we use the default one
numTargetNodes number
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

pools KubernetesClusterPools
ready boolean
(Boolean) When cluster is ready, this will return true
region string
The region for the cluster, if not declare we use the region in declared in the provider
status string
(String) Status of the cluster
tags string
Space separated list of tags, to be used freely as required
targetNodesSize string
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts KubernetesClusterTimeouts
writeKubeconfig boolean
Whether to write the kubeconfig to state
api_endpoint str
(String) The API server endpoint of the cluster
applications str
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
cluster_type str
The type of cluster to create, valid options are k3s or talos the default is k3s
cni str
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
created_at str
(String) The timestamp when the cluster was created
dns_entry str
(String) The DNS name of the cluster
firewall_id str
The existing firewall ID to use for this cluster
installed_applications Sequence[KubernetesClusterInstalledApplicationArgs]
(List of Object) (see below for nested schema)
kubeconfig str
(String, Sensitive) The kubeconfig of the cluster
kubernetes_cluster_id str
(String) The ID of this resource.
kubernetes_version str
The version of k3s to install (optional, the default is currently the latest stable available)
master_ip str
(String) The IP address of the master node
name str
Name for your cluster, must be unique within your account
network_id str
The network for the cluster, if not declare we use the default one
num_target_nodes float
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

pools KubernetesClusterPoolsArgs
ready bool
(Boolean) When cluster is ready, this will return true
region str
The region for the cluster, if not declare we use the region in declared in the provider
status str
(String) Status of the cluster
tags str
Space separated list of tags, to be used freely as required
target_nodes_size str
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts KubernetesClusterTimeoutsArgs
write_kubeconfig bool
Whether to write the kubeconfig to state
apiEndpoint String
(String) The API server endpoint of the cluster
applications String
Comma separated list of applications to install. Spaces within application names are fine, but shouldn't be either side of the comma. Application names are case-sensitive; the available applications can be listed with the Civo CLI: 'civo kubernetes applications ls'. If you want to remove a default installed application, prefix it with a '-', e.g. -Traefik. For application that supports plans, you can use 'app_name:app_plan' format e.g. 'Linkerd:Linkerd & Jaeger' or 'MariaDB:5GB'.
clusterType String
The type of cluster to create, valid options are k3s or talos the default is k3s
cni String
The cni for the k3s to install (the default is flannel) valid options are cilium or flannel
createdAt String
(String) The timestamp when the cluster was created
dnsEntry String
(String) The DNS name of the cluster
firewallId String
The existing firewall ID to use for this cluster
installedApplications List<Property Map>
(List of Object) (see below for nested schema)
kubeconfig String
(String, Sensitive) The kubeconfig of the cluster
kubernetesClusterId String
(String) The ID of this resource.
kubernetesVersion String
The version of k3s to install (optional, the default is currently the latest stable available)
masterIp String
(String) The IP address of the master node
name String
Name for your cluster, must be unique within your account
networkId String
The network for the cluster, if not declare we use the default one
numTargetNodes Number
The number of instances to create (optional, the default at the time of writing is 3)

Deprecated: Deprecated

pools Property Map
ready Boolean
(Boolean) When cluster is ready, this will return true
region String
The region for the cluster, if not declare we use the region in declared in the provider
status String
(String) Status of the cluster
tags String
Space separated list of tags, to be used freely as required
targetNodesSize String
The size of each node (optional, the default is currently g4s.kube.medium)

Deprecated: Deprecated

timeouts Property Map
writeKubeconfig Boolean
Whether to write the kubeconfig to state

Supporting Types

KubernetesClusterInstalledApplication
, KubernetesClusterInstalledApplicationArgs

Application This property is required. string
(String) name of the application
Category This property is required. string
(String) category of the application
Installed This property is required. bool
(Boolean) whether application is installed or not
Version This property is required. string
(String) version of the application
Application This property is required. string
(String) name of the application
Category This property is required. string
(String) category of the application
Installed This property is required. bool
(Boolean) whether application is installed or not
Version This property is required. string
(String) version of the application
application This property is required. String
(String) name of the application
category This property is required. String
(String) category of the application
installed This property is required. Boolean
(Boolean) whether application is installed or not
version This property is required. String
(String) version of the application
application This property is required. string
(String) name of the application
category This property is required. string
(String) category of the application
installed This property is required. boolean
(Boolean) whether application is installed or not
version This property is required. string
(String) version of the application
application This property is required. str
(String) name of the application
category This property is required. str
(String) category of the application
installed This property is required. bool
(Boolean) whether application is installed or not
version This property is required. str
(String) version of the application
application This property is required. String
(String) name of the application
category This property is required. String
(String) category of the application
installed This property is required. Boolean
(Boolean) whether application is installed or not
version This property is required. String
(String) version of the application

KubernetesClusterPools
, KubernetesClusterPoolsArgs

NodeCount This property is required. double
Number of nodes in the nodepool
Size This property is required. string
Size of the nodes in the nodepool
InstanceNames List<string>
Instance names in the nodepool
Label string
Node pool label, if you don't provide one, we will generate one for you
Labels Dictionary<string, string>
PublicIpNodePool bool
Node pool belongs to the public ip node pool
Taints List<KubernetesClusterPoolsTaint>

(see below for nested schema)

Read-Only Output:

NodeCount This property is required. float64
Number of nodes in the nodepool
Size This property is required. string
Size of the nodes in the nodepool
InstanceNames []string
Instance names in the nodepool
Label string
Node pool label, if you don't provide one, we will generate one for you
Labels map[string]string
PublicIpNodePool bool
Node pool belongs to the public ip node pool
Taints []KubernetesClusterPoolsTaint

(see below for nested schema)

Read-Only Output:

nodeCount This property is required. Double
Number of nodes in the nodepool
size This property is required. String
Size of the nodes in the nodepool
instanceNames List<String>
Instance names in the nodepool
label String
Node pool label, if you don't provide one, we will generate one for you
labels Map<String,String>
publicIpNodePool Boolean
Node pool belongs to the public ip node pool
taints List<KubernetesClusterPoolsTaint>

(see below for nested schema)

Read-Only Output:

nodeCount This property is required. number
Number of nodes in the nodepool
size This property is required. string
Size of the nodes in the nodepool
instanceNames string[]
Instance names in the nodepool
label string
Node pool label, if you don't provide one, we will generate one for you
labels {[key: string]: string}
publicIpNodePool boolean
Node pool belongs to the public ip node pool
taints KubernetesClusterPoolsTaint[]

(see below for nested schema)

Read-Only Output:

node_count This property is required. float
Number of nodes in the nodepool
size This property is required. str
Size of the nodes in the nodepool
instance_names Sequence[str]
Instance names in the nodepool
label str
Node pool label, if you don't provide one, we will generate one for you
labels Mapping[str, str]
public_ip_node_pool bool
Node pool belongs to the public ip node pool
taints Sequence[KubernetesClusterPoolsTaint]

(see below for nested schema)

Read-Only Output:

nodeCount This property is required. Number
Number of nodes in the nodepool
size This property is required. String
Size of the nodes in the nodepool
instanceNames List<String>
Instance names in the nodepool
label String
Node pool label, if you don't provide one, we will generate one for you
labels Map<String>
publicIpNodePool Boolean
Node pool belongs to the public ip node pool
taints List<Property Map>

(see below for nested schema)

Read-Only Output:

KubernetesClusterPoolsTaint
, KubernetesClusterPoolsTaintArgs

Effect This property is required. string
Key This property is required. string
Value This property is required. string
Effect This property is required. string
Key This property is required. string
Value This property is required. string
effect This property is required. String
key This property is required. String
value This property is required. String
effect This property is required. string
key This property is required. string
value This property is required. string
effect This property is required. str
key This property is required. str
value This property is required. str
effect This property is required. String
key This property is required. String
value This property is required. String

KubernetesClusterTimeouts
, KubernetesClusterTimeoutsArgs

Create string
sets timeout for cluster creation - default 30 minutes
Delete string
sets timeout for cluster deletion - default 30 minutes
Update string
sets timeout for cluster update - default 30 minutes
Create string
sets timeout for cluster creation - default 30 minutes
Delete string
sets timeout for cluster deletion - default 30 minutes
Update string
sets timeout for cluster update - default 30 minutes
create String
sets timeout for cluster creation - default 30 minutes
delete String
sets timeout for cluster deletion - default 30 minutes
update String
sets timeout for cluster update - default 30 minutes
create string
sets timeout for cluster creation - default 30 minutes
delete string
sets timeout for cluster deletion - default 30 minutes
update string
sets timeout for cluster update - default 30 minutes
create str
sets timeout for cluster creation - default 30 minutes
delete str
sets timeout for cluster deletion - default 30 minutes
update str
sets timeout for cluster update - default 30 minutes
create String
sets timeout for cluster creation - default 30 minutes
delete String
sets timeout for cluster deletion - default 30 minutes
update String
sets timeout for cluster update - default 30 minutes

Package Details

Repository
Civo civo/terraform-provider-civo
License
Notes
This Pulumi package is based on the civo Terraform Provider.