1. Pulumi Registry
  2. Civo
  3. API Docs
  4. KubernetesCluster
civo logo
Civo v2.3.3, Feb 17 23

civo.KubernetesCluster

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

Create KubernetesCluster Resource

new KubernetesCluster(name: string, args: KubernetesClusterArgs, opts?: CustomResourceOptions);
@overload
def KubernetesCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      applications: Optional[str] = None,
                      cluster_type: Optional[str] = None,
                      cni: Optional[str] = None,
                      firewall_id: Optional[str] = None,
                      kubernetes_version: Optional[str] = None,
                      name: Optional[str] = None,
                      network_id: Optional[str] = None,
                      num_target_nodes: Optional[int] = None,
                      pools: Optional[KubernetesClusterPoolsArgs] = None,
                      region: Optional[str] = None,
                      tags: Optional[str] = None,
                      target_nodes_size: Optional[str] = None)
@overload
def KubernetesCluster(resource_name: str,
                      args: KubernetesClusterArgs,
                      opts: Optional[ResourceOptions] = 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.
name string
The unique name of the resource.
args KubernetesClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args 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 string
The unique name of the resource.
args KubernetesClusterArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args KubernetesClusterArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args KubernetesClusterArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

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

The KubernetesCluster resource accepts the following input properties:

FirewallId string

The existing firewall ID to use for this cluster

Pools 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 'appname:appplan' 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

KubernetesVersion string

The version of k3s to install (optional, the default is currently the latest 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 int

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

FirewallId string

The existing firewall ID to use for this cluster

Pools 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 'appname:appplan' 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

KubernetesVersion string

The version of k3s to install (optional, the default is currently the latest 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 int

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

firewallId String

The existing firewall ID to use for this cluster

pools 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 'appname:appplan' 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

kubernetesVersion String

The version of k3s to install (optional, the default is currently the latest 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 Integer

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

firewallId string

The existing firewall ID to use for this cluster

pools 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 'appname:appplan' 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

kubernetesVersion string

The version of k3s to install (optional, the default is currently the latest 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:

This field will be deprecated in the next major release, please use the 'pools' field instead

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

firewall_id str

The existing firewall ID to use for this cluster

pools 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 'appname:appplan' 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_version str

The version of k3s to install (optional, the default is currently the latest 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 int

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

firewallId String

The existing firewall ID to use for this cluster

pools 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 'appname:appplan' 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

kubernetesVersion String

The version of k3s to install (optional, the default is currently the latest 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:

This field will be deprecated in the next major release, please use the 'pools' field instead

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

Outputs

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

ApiEndpoint string

The API server endpoint of the cluster

CreatedAt string

The timestamp when the cluster was created

DnsEntry string

The DNS name of the cluster

Id string

The provider-assigned unique ID for this managed resource.

InstalledApplications List<KubernetesClusterInstalledApplication>
Kubeconfig string

The kubeconfig of the cluster

MasterIp string

The IP address of the master node

Ready bool

When cluster is ready, this will return true

Status string

Status of the cluster

ApiEndpoint string

The API server endpoint of the cluster

CreatedAt string

The timestamp when the cluster was created

DnsEntry string

The DNS name of the cluster

Id string

The provider-assigned unique ID for this managed resource.

InstalledApplications []KubernetesClusterInstalledApplication
Kubeconfig string

The kubeconfig of the cluster

MasterIp string

The IP address of the master node

Ready bool

When cluster is ready, this will return true

Status string

Status of the cluster

apiEndpoint String

The API server endpoint of the cluster

createdAt String

The timestamp when the cluster was created

dnsEntry String

The DNS name of the cluster

id String

The provider-assigned unique ID for this managed resource.

installedApplications List<KubernetesClusterInstalledApplication>
kubeconfig String

The kubeconfig of the cluster

masterIp String

The IP address of the master node

ready Boolean

When cluster is ready, this will return true

status String

Status of the cluster

apiEndpoint string

The API server endpoint of the cluster

createdAt string

The timestamp when the cluster was created

dnsEntry string

The DNS name of the cluster

id string

The provider-assigned unique ID for this managed resource.

installedApplications KubernetesClusterInstalledApplication[]
kubeconfig string

The kubeconfig of the cluster

masterIp string

The IP address of the master node

ready boolean

When cluster is ready, this will return true

status string

Status of the cluster

api_endpoint str

The API server endpoint of the cluster

created_at str

The timestamp when the cluster was created

dns_entry str

The DNS name of the cluster

id str

The provider-assigned unique ID for this managed resource.

installed_applications Sequence[KubernetesClusterInstalledApplication]
kubeconfig str

The kubeconfig of the cluster

master_ip str

The IP address of the master node

ready bool

When cluster is ready, this will return true

status str

Status of the cluster

apiEndpoint String

The API server endpoint of the cluster

createdAt String

The timestamp when the cluster was created

dnsEntry String

The DNS name of the cluster

id String

The provider-assigned unique ID for this managed resource.

installedApplications List<Property Map>
kubeconfig String

The kubeconfig of the cluster

masterIp String

The IP address of the master node

ready Boolean

When cluster is ready, this will return true

status 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_version: Optional[str] = None,
        master_ip: Optional[str] = None,
        name: Optional[str] = None,
        network_id: Optional[str] = None,
        num_target_nodes: Optional[int] = 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) -> 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)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ApiEndpoint 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 'appname:appplan' 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

The timestamp when the cluster was created

DnsEntry string

The DNS name of the cluster

FirewallId string

The existing firewall ID to use for this cluster

InstalledApplications List<KubernetesClusterInstalledApplicationArgs>
Kubeconfig string

The kubeconfig of the cluster

KubernetesVersion string

The version of k3s to install (optional, the default is currently the latest available)

MasterIp 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 int

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

Pools KubernetesClusterPoolsArgs
Ready bool

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

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

ApiEndpoint 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 'appname:appplan' 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

The timestamp when the cluster was created

DnsEntry string

The DNS name of the cluster

FirewallId string

The existing firewall ID to use for this cluster

InstalledApplications []KubernetesClusterInstalledApplicationArgs
Kubeconfig string

The kubeconfig of the cluster

KubernetesVersion string

The version of k3s to install (optional, the default is currently the latest available)

MasterIp 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 int

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

Pools KubernetesClusterPoolsArgs
Ready bool

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

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

apiEndpoint 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 'appname:appplan' 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

The timestamp when the cluster was created

dnsEntry String

The DNS name of the cluster

firewallId String

The existing firewall ID to use for this cluster

installedApplications List<KubernetesClusterInstalledApplicationArgs>
kubeconfig String

The kubeconfig of the cluster

kubernetesVersion String

The version of k3s to install (optional, the default is currently the latest available)

masterIp 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 Integer

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

pools KubernetesClusterPoolsArgs
ready 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

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

apiEndpoint 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 'appname:appplan' 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

The timestamp when the cluster was created

dnsEntry string

The DNS name of the cluster

firewallId string

The existing firewall ID to use for this cluster

installedApplications KubernetesClusterInstalledApplicationArgs[]
kubeconfig string

The kubeconfig of the cluster

kubernetesVersion string

The version of k3s to install (optional, the default is currently the latest available)

masterIp 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:

This field will be deprecated in the next major release, please use the 'pools' field instead

pools KubernetesClusterPoolsArgs
ready 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

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

api_endpoint str

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 'appname:appplan' 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

The timestamp when the cluster was created

dns_entry str

The DNS name of the cluster

firewall_id str

The existing firewall ID to use for this cluster

installed_applications Sequence[KubernetesClusterInstalledApplicationArgs]
kubeconfig str

The kubeconfig of the cluster

kubernetes_version str

The version of k3s to install (optional, the default is currently the latest available)

master_ip str

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 int

The number of instances to create (optional, the default at the time of writing is 3)

Deprecated:

This field will be deprecated in the next major release, please use the 'pools' field instead

pools KubernetesClusterPoolsArgs
ready bool

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

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

apiEndpoint 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 'appname:appplan' 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

The timestamp when the cluster was created

dnsEntry String

The DNS name of the cluster

firewallId String

The existing firewall ID to use for this cluster

installedApplications List<Property Map>
kubeconfig String

The kubeconfig of the cluster

kubernetesVersion String

The version of k3s to install (optional, the default is currently the latest available)

masterIp 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:

This field will be deprecated in the next major release, please use the 'pools' field instead

pools Property Map
ready 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

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:

This field will be deprecated in the next major release, please use the 'pools' field instead

Supporting Types

KubernetesClusterInstalledApplication

Application string
Category string
Installed bool
Version string
Application string
Category string
Installed bool
Version string
application String
category String
installed Boolean
version String
application string
category string
installed boolean
version string
application String
category String
installed Boolean
version String

KubernetesClusterPools

NodeCount int

Number of nodes in the nodepool

Size 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

NodeCount int

Number of nodes in the nodepool

Size 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

nodeCount Integer

Number of nodes in the nodepool

size 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

nodeCount number

Number of nodes in the nodepool

size 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

node_count int

Number of nodes in the nodepool

size 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

nodeCount Number

Number of nodes in the nodepool

size 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

Import

using ID

 $ pulumi import civo:index/kubernetesCluster:KubernetesCluster my-cluster 1b8b2100-0e9f-4e8f-ad78-9eb578c2a0af

Package Details

Repository
Civo pulumi/pulumi-civo
License
Apache-2.0
Notes

This Pulumi package is based on the civo Terraform Provider.