The Automation API is now available. No CLI. No human-in-the-loop. Just your code. Learn More

KubernetesCluster

Create a KubernetesCluster Resource

def KubernetesCluster(resource_name: str, opts: Optional[ResourceOptions] = None, applications: Optional[str] = None, kubernetes_version: Optional[str] = None, name: Optional[str] = None, num_target_nodes: Optional[int] = None, tags: Optional[str] = None, target_nodes_size: Optional[str] = None)
public KubernetesCluster(string name, KubernetesClusterArgs? args = null, CustomResourceOptions? opts = null)
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.
opts ResourceOptions
A bag of options that control this 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.

KubernetesCluster Resource Properties

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

Inputs

The KubernetesCluster resource accepts the following input properties:

Applications string

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

KubernetesVersion string

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

Name string

A name for the Kubernetes cluster.

NumTargetNodes int

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

Tags string

A space separated list of tags, to be used freely as required.

TargetNodesSize string

The size of each node (The default is currently g2.small)

Applications string

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

KubernetesVersion string

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

Name string

A name for the Kubernetes cluster.

NumTargetNodes int

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

Tags string

A space separated list of tags, to be used freely as required.

TargetNodesSize string

The size of each node (The default is currently g2.small)

applications string

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

kubernetesVersion string

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

name string

A name for the Kubernetes cluster.

numTargetNodes number

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

tags string

A space separated list of tags, to be used freely as required.

targetNodesSize string

The size of each node (The default is currently g2.small)

applications str

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

kubernetes_version str

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

name str

A name for the Kubernetes cluster.

num_target_nodes int

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

tags str

A space separated list of tags, to be used freely as required.

target_nodes_size str

The size of each node (The default is currently g2.small)

Outputs

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

ApiEndpoint string

The base URL of the API server on the Kubernetes master node.

BuiltAt string

The date where the Kubernetes cluster was build.

CreatedAt string

The date where the Kubernetes cluster was create.

DnsEntry string

The unique dns entry for the cluster in this case point to the master.

Id string
The provider-assigned unique ID for this managed resource.
InstalledApplications List<KubernetesClusterInstalledApplication>

A unique ID that can be used to identify and reference a Kubernetes cluster.

Instances List<KubernetesClusterInstance>

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

Kubeconfig string

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

MasterIp string

The Ip of the Kubernetes master node.

Ready bool
Status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

ApiEndpoint string

The base URL of the API server on the Kubernetes master node.

BuiltAt string

The date where the Kubernetes cluster was build.

CreatedAt string

The date where the Kubernetes cluster was create.

DnsEntry string

The unique dns entry for the cluster in this case point to the master.

Id string
The provider-assigned unique ID for this managed resource.
InstalledApplications []KubernetesClusterInstalledApplication

A unique ID that can be used to identify and reference a Kubernetes cluster.

Instances []KubernetesClusterInstance

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

Kubeconfig string

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

MasterIp string

The Ip of the Kubernetes master node.

Ready bool
Status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

apiEndpoint string

The base URL of the API server on the Kubernetes master node.

builtAt string

The date where the Kubernetes cluster was build.

createdAt string

The date where the Kubernetes cluster was create.

dnsEntry string

The unique dns entry for the cluster in this case point to the master.

id string
The provider-assigned unique ID for this managed resource.
installedApplications KubernetesClusterInstalledApplication[]

A unique ID that can be used to identify and reference a Kubernetes cluster.

instances KubernetesClusterInstance[]

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

kubeconfig string

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

masterIp string

The Ip of the Kubernetes master node.

ready boolean
status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

api_endpoint str

The base URL of the API server on the Kubernetes master node.

built_at str

The date where the Kubernetes cluster was build.

created_at str

The date where the Kubernetes cluster was create.

dns_entry str

The unique dns entry for the cluster in this case point to the master.

id str
The provider-assigned unique ID for this managed resource.
installed_applications Sequence[KubernetesClusterInstalledApplication]

A unique ID that can be used to identify and reference a Kubernetes cluster.

instances Sequence[KubernetesClusterInstance]

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

kubeconfig str

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

master_ip str

The Ip of the Kubernetes master node.

ready bool
status str

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

Look up an 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, built_at: Optional[str] = None, created_at: Optional[str] = None, dns_entry: Optional[str] = None, installed_applications: Optional[Sequence[KubernetesClusterInstalledApplicationArgs]] = None, instances: Optional[Sequence[KubernetesClusterInstanceArgs]] = None, kubeconfig: Optional[str] = None, kubernetes_version: Optional[str] = None, master_ip: Optional[str] = None, name: Optional[str] = None, num_target_nodes: Optional[int] = None, ready: Optional[bool] = 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)
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.

The following state arguments are supported:

ApiEndpoint string

The base URL of the API server on the Kubernetes master node.

Applications string

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

BuiltAt string

The date where the Kubernetes cluster was build.

CreatedAt string

The date where the Kubernetes cluster was create.

DnsEntry string

The unique dns entry for the cluster in this case point to the master.

InstalledApplications List<KubernetesClusterInstalledApplicationArgs>

A unique ID that can be used to identify and reference a Kubernetes cluster.

Instances List<KubernetesClusterInstanceArgs>

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

Kubeconfig string

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

KubernetesVersion string

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

MasterIp string

The Ip of the Kubernetes master node.

Name string

A name for the Kubernetes cluster.

NumTargetNodes int

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

Ready bool
Status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

Tags string

A space separated list of tags, to be used freely as required.

TargetNodesSize string

The size of each node (The default is currently g2.small)

ApiEndpoint string

The base URL of the API server on the Kubernetes master node.

Applications string

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

BuiltAt string

The date where the Kubernetes cluster was build.

CreatedAt string

The date where the Kubernetes cluster was create.

DnsEntry string

The unique dns entry for the cluster in this case point to the master.

InstalledApplications []KubernetesClusterInstalledApplication

A unique ID that can be used to identify and reference a Kubernetes cluster.

Instances []KubernetesClusterInstance

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

Kubeconfig string

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

KubernetesVersion string

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

MasterIp string

The Ip of the Kubernetes master node.

Name string

A name for the Kubernetes cluster.

NumTargetNodes int

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

Ready bool
Status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

Tags string

A space separated list of tags, to be used freely as required.

TargetNodesSize string

The size of each node (The default is currently g2.small)

apiEndpoint string

The base URL of the API server on the Kubernetes master node.

applications string

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

builtAt string

The date where the Kubernetes cluster was build.

createdAt string

The date where the Kubernetes cluster was create.

dnsEntry string

The unique dns entry for the cluster in this case point to the master.

installedApplications KubernetesClusterInstalledApplication[]

A unique ID that can be used to identify and reference a Kubernetes cluster.

instances KubernetesClusterInstance[]

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

kubeconfig string

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

kubernetesVersion string

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

masterIp string

The Ip of the Kubernetes master node.

name string

A name for the Kubernetes cluster.

numTargetNodes number

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

ready boolean
status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

tags string

A space separated list of tags, to be used freely as required.

targetNodesSize string

The size of each node (The default is currently g2.small)

api_endpoint str

The base URL of the API server on the Kubernetes master node.

applications str

A comma separated list of applications to install. Spaces within application names are fine, but shouldn’t be either side of the comma. If you want to remove a default installed application, prefix it with a ‘-’, e.g. -traefik

built_at str

The date where the Kubernetes cluster was build.

created_at str

The date where the Kubernetes cluster was create.

dns_entry str

The unique dns entry for the cluster in this case point to the master.

installed_applications Sequence[KubernetesClusterInstalledApplicationArgs]

A unique ID that can be used to identify and reference a Kubernetes cluster.

instances Sequence[KubernetesClusterInstanceArgs]

In addition to the arguments provided, these additional attributes about the cluster’s default node instance are exported.

kubeconfig str

A representation of the Kubernetes cluster’s kubeconfig in yaml format.

kubernetes_version str

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

master_ip str

The Ip of the Kubernetes master node.

name str

A name for the Kubernetes cluster.

num_target_nodes int

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

ready bool
status str

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

tags str

A space separated list of tags, to be used freely as required.

target_nodes_size str

The size of each node (The default is currently g2.small)

Supporting Types

KubernetesClusterInstalledApplication

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

Application string

The name of the application

Category string

The category of the application

Installed bool

if installed or not

Version string

The version of the application

Application string

The name of the application

Category string

The category of the application

Installed bool

if installed or not

Version string

The version of the application

application string

The name of the application

category string

The category of the application

installed boolean

if installed or not

version string

The version of the application

application str

The name of the application

category str

The category of the application

installed bool

if installed or not

version str

The version of the application

KubernetesClusterInstance

See the output API doc for this type.

See the output API doc for this type.

See the output API doc for this type.

CpuCores int

Total cpu of the inatance.

CreatedAt string

The date where the Kubernetes cluster was create.

DiskGb int

The size of the disk.

FirewallId string

The firewall id assigned to the instance

Hostname string

The hostname of the instance.

PublicIp string

The public ip of the instances, only available if the instances is the master

RamMb int

Total ram of the instance.

Region string

The region where instance are.

Size string

The size of the instance.

Status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

Tags List<string>

A space separated list of tags, to be used freely as required.

CpuCores int

Total cpu of the inatance.

CreatedAt string

The date where the Kubernetes cluster was create.

DiskGb int

The size of the disk.

FirewallId string

The firewall id assigned to the instance

Hostname string

The hostname of the instance.

PublicIp string

The public ip of the instances, only available if the instances is the master

RamMb int

Total ram of the instance.

Region string

The region where instance are.

Size string

The size of the instance.

Status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

Tags []string

A space separated list of tags, to be used freely as required.

cpuCores number

Total cpu of the inatance.

createdAt string

The date where the Kubernetes cluster was create.

diskGb number

The size of the disk.

firewallId string

The firewall id assigned to the instance

hostname string

The hostname of the instance.

publicIp string

The public ip of the instances, only available if the instances is the master

ramMb number

Total ram of the instance.

region string

The region where instance are.

size string

The size of the instance.

status string

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

tags string[]

A space separated list of tags, to be used freely as required.

cpu_cores int

Total cpu of the inatance.

created_at str

The date where the Kubernetes cluster was create.

disk_gb int

The size of the disk.

firewall_id str

The firewall id assigned to the instance

hostname str

The hostname of the instance.

public_ip str

The public ip of the instances, only available if the instances is the master

ram_mb int

Total ram of the instance.

region str

The region where instance are.

size str

The size of the instance.

status str

The status of Kubernetes cluster. * ready -If the Kubernetes cluster is ready.

tags Sequence[str]

A space separated list of tags, to be used freely as required.

Package Details

Repository
https://github.com/pulumi/pulumi-civo
License
Apache-2.0
Notes
This Pulumi package is based on the civo Terraform Provider.