Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
Skip to Content
CLICommands

orl kubernetes node-pool create

Add a node pool to a cluster, part of the orl CLI for OpenRelay GPU VMs, pods, batches and billing. Usage, every flag and an example.

orl kubernetes node-pool create <id> --count <count> --name <name> --sku <sku>

Adds a pool of count nodes of one SKU, a GPU model or a CPU size, to the cluster and answers 202 with the new pool as creating. The nodes run in the cluster's data center. A GPU node is a whole host of the model; a CPU node is a VM of the size alone on its host, with diskSizeGb as its data disk. A cluster that is creating, deleting or failed answers 409 INVALID_CLUSTER_STATE; a failed cluster has no control plane to join. A pool answers 503 VM_IMAGE_CATALOG_UNAVAILABLE while the control plane has not read the image catalog yet; retry it. A legacy API key needs clusters:write.

Flags

FlagTypeRequired
--annotationsmap[string]stringnoAnnotations the control plane puts on each of the pool's nodes before the node takes workloads. Absent or empty, it puts none.
--countintyesNumber of nodes.
--disk-size-gbintnoA CPU pool's data disk per node, in GB: container images, kubelet and containerd state, and local volumes. The node's 100 GB root disk is separate. Optional, 100 when omitted, within getPricing's vmDisk bounds, and fixed for the pool's life. It bills as a CPU VM's disk does. A GPU pool that sends it is rejected: a GPU node takes its host's free disk.
--labelsmap[string]stringnoLabels the control plane puts on each of the pool's nodes before the node takes workloads. Absent or empty, it puts none.
--namestringyes
--public-portsjsonnoThe ports each node's public IP forwards to the node. Absent or empty, no port is forwarded; updateKubernetesNodePool changes the list.
--skujsonyesWhat every node in a pool is: exactly one of gpuModelId or resourceSize. A GPU node is a whole host of that model with every GPU passed through to it. A CPU node is a VM of that size alone on a host that sells no GPU, billed as a CPU VM of the size; the rest of the host is left unused. A cluster mixes SKUs through several pools.
--taintsjsonnoTaints the control plane puts on each of the pool's nodes. Absent or empty, it puts none.
--bodystringnoa JSON object of request body fields, merged under any of this command's own flags that are also set, e.g. {"key":"value"}
--body-filestringnoread the --body JSON object from a file (- for stdin)

This wraps the createKubernetesNodePool API operation.

On this page