Skip to content
Nirvana Labs Nirvana Labs API
Docs
API Reference

NKS

NKSKubernetes Versions

data nirvana_nks_kubernetes_versions

optional Expand Collapse
max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
items: List[Attributes]

The items returned by the data source

created_at: Time

When the Kubernetes version was created.

display_name: String

Display name of the Kubernetes version.

name: String

Name of the Kubernetes version.

nirvana_nks_kubernetes_versions

data "nirvana_nks_kubernetes_versions" "example_nks_kubernetes_versions" {

}

NKSClusters

resource nirvana_nks_cluster

required Expand Collapse
kubernetes_version: String

Kubernetes version for the Cluster.

project_id: String

Project ID to create the Cluster in.

region: String

Region the resource is in.

vpc_id: String

ID of the VPC to use for the Cluster.

autoscaling: Bool

Whether to enable autoscaling for the Cluster.

name: String

Name of the Cluster.

optional Expand Collapse
tags?: List[String]

Tags to attach to the Cluster.

computed Expand Collapse
id: String

Unique identifier for the Operation.

created_at: Time

When the Cluster was created.

kind: String

Kind of Operation.

private_ip: String

Private IP (VIP) of the Cluster.

public_ip: String

Public IP of the Cluster.

resource_id: String

ID of the resource that the Operation is acting on.

status: String

Status of the resource.

type: String

Type of Operation.

updated_at: Time

When the Cluster was last updated.

pool_ids: List[String]

IDs of pools belonging to this Cluster.

details: Attributes

Structured details about what an operation is changing.

changes: Map[Attributes]

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: String

Previous value.

to: String

New value.

nirvana_nks_cluster

resource "nirvana_nks_cluster" "example_nks_cluster" {
  autoscaling = true
  kubernetes_version = "v1.34.4"
  name = "my-cluster"
  project_id = "123e4567-e89b-12d3-a456-426614174000"
  region = "us-sva-2"
  vpc_id = "123e4567-e89b-12d3-a456-426614174000"
  tags = ["production", "ethereum"]
}

data nirvana_nks_cluster

optional Expand Collapse
cluster_id?: String
find_one_by?: Attributes
project_id: String

Project ID of resources to request

computed Expand Collapse
id: String
autoscaling: Bool

Whether autoscaling is enabled for the Cluster.

created_at: Time

When the Cluster was created.

kubernetes_version: String

Kubernetes version of the Cluster.

name: String

Name of the Cluster.

private_ip: String

Private IP (VIP) of the Cluster.

project_id: String

Project ID the Cluster belongs to.

public_ip: String

Public IP of the Cluster.

region: String

Region the resource is in.

status: String

Status of the resource.

updated_at: Time

When the Cluster was last updated.

vpc_id: String

ID of the VPC the Cluster is in.

pool_ids: List[String]

IDs of pools belonging to this Cluster.

tags: List[String]

Tags attached to the Cluster.

nirvana_nks_cluster

data "nirvana_nks_cluster" "example_nks_cluster" {
  cluster_id = "cluster_id"
}

data nirvana_nks_clusters

required Expand Collapse
project_id: String

Project ID of resources to request

optional Expand Collapse
max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
items: List[Attributes]

The items returned by the data source

id: String

Unique identifier for the Cluster.

autoscaling: Bool

Whether autoscaling is enabled for the Cluster.

created_at: Time

When the Cluster was created.

kubernetes_version: String

Kubernetes version of the Cluster.

name: String

Name of the Cluster.

pool_ids: List[String]

IDs of pools belonging to this Cluster.

private_ip: String

Private IP (VIP) of the Cluster.

project_id: String

Project ID the Cluster belongs to.

public_ip: String

Public IP of the Cluster.

region: String

Region the resource is in.

status: String

Status of the resource.

tags: List[String]

Tags attached to the Cluster.

updated_at: Time

When the Cluster was last updated.

vpc_id: String

ID of the VPC the Cluster is in.

nirvana_nks_clusters

data "nirvana_nks_clusters" "example_nks_clusters" {
  project_id = "project_id"
}

NKSClustersKubeconfig

data nirvana_nks_cluster_kubeconfig

required Expand Collapse
cluster_id: String
computed Expand Collapse
kubeconfig: String

Kubeconfig content for the Cluster.

nirvana_nks_cluster_kubeconfig

data "nirvana_nks_cluster_kubeconfig" "example_nks_cluster_kubeconfig" {
  cluster_id = "cluster_id"
}

NKSClustersPools

resource nirvana_nks_node_pool

required Expand Collapse
cluster_id: String
name: String

Name of the node pool.

node_count: Int64

Number of nodes. Must be between 1 and 100.

node_config: Attributes

Node configuration.

boot_volume: Attributes

Boot volume configuration.

size: Int64

Size of the boot volume in GB.

type: String

Type of the Volume.

instance_type: String

Instance type name used for worker nodes.

labels?: List[String]

Kubernetes labels to apply to each node in the pool. Each entry is “key=value”. Keys under kubernetes.io, k8s.io, and nirvanalabs.io prefixes are reserved.

optional Expand Collapse
tags?: List[String]

Tags to attach to the node pool.

computed Expand Collapse
id: String

Unique identifier for the Operation.

created_at: Time

When the node pool was created.

kind: String

Kind of Operation.

project_id: String

Project ID the Operation belongs to.

resource_id: String

ID of the resource that the Operation is acting on.

status: String

Status of the resource.

type: String

Type of Operation.

updated_at: Time

When the node pool was last updated.

details: Attributes

Structured details about what an operation is changing.

changes: Map[Attributes]

Map of changed field names to their from/to diffs. Keys depend on the parent operation’s kind+type.

from: String

Previous value.

to: String

New value.

nirvana_nks_node_pool

resource "nirvana_nks_node_pool" "example_nks_node_pool" {
  cluster_id = "cluster_id"
  name = "my-node-pool"
  node_config = {
    boot_volume = {
      size = 100
      type = "abs"
    }
    instance_type = "n1-standard-8"
    labels = ["env=prod", "team=platform"]
  }
  node_count = 3
  tags = ["production", "ethereum"]
}

data nirvana_nks_node_pool

required Expand Collapse
pool_id: String
cluster_id: String
computed Expand Collapse
id: String
created_at: Time

When the node pool was created.

name: String

Name of the node pool.

node_count: Int64

Number of nodes.

status: String

Status of the resource.

updated_at: Time

When the node pool was last updated.

tags: List[String]

Tags attached to the node pool.

node_config: Attributes

Node configuration.

boot_volume: Attributes

Boot volume configuration.

size: Int64

Size of the boot volume in GB.

type: String

Type of the Volume.

instance_type: String

Instance type name.

labels: List[String]

Kubernetes labels applied to each node in the pool. Each entry is “key=value”.

nirvana_nks_node_pool

data "nirvana_nks_node_pool" "example_nks_node_pool" {
  cluster_id = "cluster_id"
  pool_id = "pool_id"
}

data nirvana_nks_node_pools

required Expand Collapse
cluster_id: String
optional Expand Collapse
max_items?: Int64

Max items to fetch, default: 1000

computed Expand Collapse
items: List[Attributes]

The items returned by the data source

id: String

Unique identifier for the node pool.

cluster_id: String

ID of the Cluster this node pool belongs to.

created_at: Time

When the node pool was created.

name: String

Name of the node pool.

node_config: Attributes

Node configuration.

boot_volume: Attributes

Boot volume configuration.

size: Int64

Size of the boot volume in GB.

type: String

Type of the Volume.

instance_type: String

Instance type name.

labels: List[String]

Kubernetes labels applied to each node in the pool. Each entry is “key=value”.

node_count: Int64

Number of nodes.

status: String

Status of the resource.

tags: List[String]

Tags attached to the node pool.

updated_at: Time

When the node pool was last updated.

nirvana_nks_node_pools

data "nirvana_nks_node_pools" "example_nks_node_pools" {
  cluster_id = "cluster_id"
}