KubernetesCluster

Import

Then the Kubernetes cluster can be imported using the cluster’s id, e.g.

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

Create a KubernetesCluster Resource

new KubernetesCluster(name: string, args?: KubernetesClusterArgs, opts?: CustomResourceOptions);
@overload
def KubernetesCluster(resource_name: str,
                      opts: Optional[ResourceOptions] = None,
                      applications: Optional[str] = None,
                      kubernetes_version: Optional[str] = None,
                      name: Optional[str] = None,
                      network_id: Optional[str] = None,
                      num_target_nodes: Optional[int] = None,
                      region: Optional[str] = None,
                      tags: Optional[str] = None,
                      target_nodes_size: Optional[str] = None)
@overload
def KubernetesCluster(resource_name: str,
                      args: Optional[KubernetesClusterArgs] = None,
                      opts: Optional[ResourceOptions] = None)
func NewKubernetesCluster(ctx *Context, name string, args *KubernetesClusterArgs, opts ...ResourceOption) (*KubernetesCluster, error)
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.
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.

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:

Applications string
This field is a case-sensitive, a 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
KubernetesVersion string
The version of k3s to install (The default is currently the latest available).
Name string
A name for the Kubernetes cluster, if is not declare the provider will generate one for you.
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
Region string
The region for the cluster.
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 g3.k3s.small)
Applications string
This field is a case-sensitive, a 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
KubernetesVersion string
The version of k3s to install (The default is currently the latest available).
Name string
A name for the Kubernetes cluster, if is not declare the provider will generate one for you.
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
Region string
The region for the cluster.
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 g3.k3s.small)
applications string
This field is a case-sensitive, a 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
kubernetesVersion string
The version of k3s to install (The default is currently the latest available).
name string
A name for the Kubernetes cluster, if is not declare the provider will generate one for you.
networkId string
The network for the cluster, if not declare we use the default one
numTargetNodes number
The number of instances to create (The default at the time of writing is 3).
region string
The region for the cluster.
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 g3.k3s.small)
applications str
This field is a case-sensitive, a 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
kubernetes_version str
The version of k3s to install (The default is currently the latest available).
name str
A name for the Kubernetes cluster, if is not declare the provider will generate one for you.
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 (The default at the time of writing is 3).
region str
The region for the cluster.
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 g3.k3s.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.
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>
A list of instance inside the pool
Kubeconfig string
A representation of the Kubernetes cluster’s kubeconfig in yaml format.
MasterIp string
The Ip of the Kubernetes master node.
Pools List<KubernetesClusterPool>
A list of node pools associated with the cluster. Each node pool exports the following attributes:
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.
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
A list of instance inside the pool
Kubeconfig string
A representation of the Kubernetes cluster’s kubeconfig in yaml format.
MasterIp string
The Ip of the Kubernetes master node.
Pools []KubernetesClusterPool
A list of node pools associated with the cluster. Each node pool exports the following attributes:
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.
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[]
A list of instance inside the pool
kubeconfig string
A representation of the Kubernetes cluster’s kubeconfig in yaml format.
masterIp string
The Ip of the Kubernetes master node.
pools KubernetesClusterPool[]
A list of node pools associated with the cluster. Each node pool exports the following attributes:
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.
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]
A list of instance inside the pool
kubeconfig str
A representation of the Kubernetes cluster’s kubeconfig in yaml format.
master_ip str
The Ip of the Kubernetes master node.
pools Sequence[KubernetesClusterPool]
A list of node pools associated with the cluster. Each node pool exports the following attributes:
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,
        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,
        network_id: Optional[str] = None,
        num_target_nodes: Optional[int] = None,
        pools: Optional[Sequence[KubernetesClusterPoolArgs]] = 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)
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
This field is a case-sensitive, a 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
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>
A list of instance inside the pool
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, if is not declare the provider will generate one for you.
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
Pools List<KubernetesClusterPoolArgs>
A list of node pools associated with the cluster. Each node pool exports the following attributes:
Ready bool
Region string
The region for the cluster.
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 g3.k3s.small)
ApiEndpoint string
The base URL of the API server on the Kubernetes master node.
Applications string
This field is a case-sensitive, a 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
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 []KubernetesClusterInstalledApplicationArgs
A unique ID that can be used to identify and reference a Kubernetes cluster.
Instances []KubernetesClusterInstanceArgs
A list of instance inside the pool
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, if is not declare the provider will generate one for you.
NetworkId string
The network for the cluster, if not declare we use the default one
NumTargetNodes int
The number of instances to create (The default at the time of writing is 3).
Pools []KubernetesClusterPoolArgs
A list of node pools associated with the cluster. Each node pool exports the following attributes:
Ready bool
Region string
The region for the cluster.
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 g3.k3s.small)
apiEndpoint string
The base URL of the API server on the Kubernetes master node.
applications string
This field is a case-sensitive, a 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
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 KubernetesClusterInstalledApplicationArgs[]
A unique ID that can be used to identify and reference a Kubernetes cluster.
instances KubernetesClusterInstanceArgs[]
A list of instance inside the pool
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, if is not declare the provider will generate one for you.
networkId string
The network for the cluster, if not declare we use the default one
numTargetNodes number
The number of instances to create (The default at the time of writing is 3).
pools KubernetesClusterPoolArgs[]
A list of node pools associated with the cluster. Each node pool exports the following attributes:
ready boolean
region string
The region for the cluster.
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 g3.k3s.small)
api_endpoint str
The base URL of the API server on the Kubernetes master node.
applications str
This field is a case-sensitive, a 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
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]
A list of instance inside the pool
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, if is not declare the provider will generate one for you.
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 (The default at the time of writing is 3).
pools Sequence[KubernetesClusterPoolArgs]
A list of node pools associated with the cluster. Each node pool exports the following attributes:
ready bool
region str
The region for the cluster.
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 g3.k3s.small)

Supporting Types

KubernetesClusterInstalledApplication

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

CpuCores int
Total cpu of the inatance.
DiskGb int
The size of the disk.
Hostname string
The hostname of the instance.
RamMb int
Total ram of the instance
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.
DiskGb int
The size of the disk.
Hostname string
The hostname of the instance.
RamMb int
Total ram of the instance
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.
diskGb number
The size of the disk.
hostname string
The hostname of the instance.
ramMb number
Total ram of the instance
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.
disk_gb int
The size of the disk.
hostname str
The hostname of the instance.
ram_mb int
Total ram of the instance
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.

KubernetesClusterPool

Count int
The size of the pool
Id string
The ID of the pool
InstanceNames List<string>
A list of the instance in the pool
Instances List<KubernetesClusterPoolInstance>
A list of instance inside the pool
Size string
The size of the instance.
Count int
The size of the pool
Id string
The ID of the pool
InstanceNames []string
A list of the instance in the pool
Instances []KubernetesClusterPoolInstance
A list of instance inside the pool
Size string
The size of the instance.
count number
The size of the pool
id string
The ID of the pool
instanceNames string[]
A list of the instance in the pool
instances KubernetesClusterPoolInstance[]
A list of instance inside the pool
size string
The size of the instance.
count int
The size of the pool
id str
The ID of the pool
instance_names Sequence[str]
A list of the instance in the pool
instances Sequence[KubernetesClusterPoolInstance]
A list of instance inside the pool
size str
The size of the instance.

KubernetesClusterPoolInstance

CpuCores int
Total cpu of the inatance.
DiskGb int
The size of the disk.
Hostname string
The hostname of the instance.
RamMb int
Total ram of the instance
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.
DiskGb int
The size of the disk.
Hostname string
The hostname of the instance.
RamMb int
Total ram of the instance
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.
diskGb number
The size of the disk.
hostname string
The hostname of the instance.
ramMb number
Total ram of the instance
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.
disk_gb int
The size of the disk.
hostname str
The hostname of the instance.
ram_mb int
Total ram of the instance
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.