Create NKS Cluster

$ nirvana nks:clusters create

POST/v1/nks/clusters

Create an NKS Cluster

ParametersExpand Collapse

--autoscaling: boolean

Whether to enable autoscaling for the Cluster.

--kubernetes-version: string

Kubernetes version for the Cluster.

--name: string

Name of the Cluster.

--project-id: string

Project ID to create the Cluster in.

--region: "us-sva-2"

Region the resource is in.

--vpc-id: string

ID of the VPC to use for the Cluster.

--tag: optional array of string

Tags to attach to the Cluster.

ReturnsExpand Collapse

operation: object { id, created_at, details, 6 more }

Operation details.

id: string

Unique identifier for the Operation.

created_at: string

When the Operation was created.

details: object { changes }

Structured details about what an operation is changing.

changes: map[OperationFieldDiff { from, to } ]

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

from: string or number or boolean or array of string

Previous value.

union_member_0: string

union_member_1: number

union_member_2: boolean

union_member_3: array of string

to: string or number or boolean or array of string

New value.

union_member_0: string

union_member_1: number

union_member_2: boolean

union_member_3: array of string

kind: "vm" or "volume" or "vpc" or 3 more

Kind of Operation.

"vm"

"volume"

"vpc"

"firewall_rule"

"nks_cluster"

"nks_node_pool"

project_id: string

Project ID the Operation belongs to.

resource_id: string

ID of the resource that the Operation is acting on.

status: "pending" or "running" or "done" or 2 more

Status of the Operation.

"pending"

"running"

"done"

"failed"

"unknown"

type: "create" or "update" or "delete" or "restart"

Type of Operation.

"create"

"update"

"delete"

"restart"

updated_at: string

When the Operation was updated.

Create NKS Cluster

nirvana nks:clusters create \
  --api-key 'My API Key' \
  --autoscaling \
  --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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "details": {
    "changes": {
      "foo": {
        "from": "string",
        "to": "string"
      }
    }
  },
  "kind": "vm",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "type": "create",
  "updated_at": "2025-01-01T00:00:00Z"
}

Returns Examples

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "created_at": "2025-01-01T00:00:00Z",
  "details": {
    "changes": {
      "foo": {
        "from": "string",
        "to": "string"
      }
    }
  },
  "kind": "vm",
  "project_id": "123e4567-e89b-12d3-a456-426614174000",
  "resource_id": "123e4567-e89b-12d3-a456-426614174000",
  "status": "pending",
  "type": "create",
  "updated_at": "2025-01-01T00:00:00Z"
}