Patch cluster

• state

  string required
  Current state of the cluster.

• transitionTime

  string
  Time of the last state transition.

• reason

  string
  The reason, given the cluster is in an error state.

• {object}

• id

  string required

• name

  string required

• description

  string

• type

  string
  one of

  storage-class, snapshot-class

• kubernetesName

  string required

• defaultSnapshotClass

  string

• options

  {object}

• capabilities

  {object}

• expansion

  boolean
  Increasing volume size after provisioning.

• snapshot

  boolean
  Point in time snapshotting of volumes.

• accessModes

  {object}

• ReadWriteOnce

  boolean
  Access mode where a volume is exclusively attached to a single pod at a time.

• ReadWriteMany

  boolean
  Access mode where a volume can be attached to multiple single pods at a time for read and write operations.

• storageSize

  {object}

• minValidSize

  integer
  Enforces a minimum storage size per addon or volume.
  min

  1

• maxValidSize

  integer
  Enforces a maximum storage size per addon or volume.
  min

  1

• suggestedOptions

  [array]
  Specific storage size options to suggest in the UI.
• integer
  min

  1

• platform

  {object}

• supportedResources

  [array]
• string
  one of

  addon, volume, build-cache

• {object}

• id

  string required

• name

  string required

• description

  string

• kubernetesName

  string required

OR

• mode

  string
  Determines where builds are run: on Northflank infrastructure (paas), on this cluster (internal) or on a dedicated build cluster (build-cluster).
  one of

  paas, internal, build-cluster

• plan

  string
  Plan to use for builds if they are run on the cluster
  min length

  3

  max length

  39

  pattern

  ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• clusterId

  string
  Cluster to use for scheduling builds
  pattern

  ^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• caching

  {object}
  Cache settings for builds

• allow

  boolean
  Whether to allow local disk based caching for builds.

• storageClassName

  string
  Storage class used by default for local disk based caching.

• mode

  string
  Determines where built images are stored: in the Northflank registry (paas) or in a self-hosted registry.
  one of

  paas, self-hosted

• registryId

  string
  Credentials to use for storing of images.
  pattern

  ^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

{object}
Logging via PaaS.
• mode

  string
  The logging mode. `paas` stores logs on Northflank infrastructure.
  one of

  paas

OR

{object}
Logging via Loki (S3 storage).
• mode

  string required
  The logging mode. `loki` stores logs in your own storage via Loki.
  one of

  loki

• loki

  {object}

• storageType

  string required
  one of

  s3

• s3BucketName

  string required
  Name of the S3 bucket used for Loki log storage.

• s3AccessKey

  string required
  Access key for the S3 bucket used for Loki log storage.

• s3SecretKey

  string required
  Secret key for the S3 bucket used for Loki log storage.

• s3Region

  string required
  Region of the S3 bucket used for Loki log storage.

OR

{object}
Logging via Loki (GCS storage).
• mode

  string required
  The logging mode. `loki` stores logs in your own storage via Loki.
  one of

  loki

• loki

  {object}

• storageType

  string required
  one of

  gcs

• gcsBucketName

  string required
  Name of the GCS bucket used for Loki log storage.

• gcpIntegrationId

  string required
  ID of the GCP integration used to access the GCS bucket.
  pattern

  ^((org|team)\/)?[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• overlayNetwork

  boolean
  Whether overlay networking is enabled for this cluster.

• overlayCIDR

  string
  CIDR range for the overlay network.
  pattern

  ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$

• istio

  {object}

• enablePublicLoadBalancer

  boolean
  Whether the cluster runs a public ingress load balancer. Defaults to true.

• enablePrivateLoadBalancer

  boolean
  Whether the cluster runs a VPC ingress load balancer. Defaults to false; BYOK exposure is customer-controlled.

• privateLoadBalancerAwsSecurityGroupId

  string | null
  Customer-managed frontend security group for a private AWS NLB managed by the AWS Load Balancer Controller.
  pattern

  ^sg-(?:[a-f0-9]{8}|[a-f0-9]{17})$

• publicLoadBalancer

  {object}
  Customer configuration for a BYOK ingress Service. Immutable after first assignment; exposure is controlled by the customer.

• serviceAnnotations

  {object}

• loadBalancerClass

  string
  pattern

  ^(?:(?=[^/]{1,253}\/)[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*\/)?[a-zA-Z0-9](?:[a-zA-Z0-9_.-]{0,61}[a-zA-Z0-9])?(?![\s\S])

• privateLoadBalancer

  {object}
  Customer configuration for a BYOK ingress Service. Immutable after first assignment; exposure is controlled by the customer.

• serviceAnnotations

  {object}

• loadBalancerClass

  string
  pattern

  ^(?:(?=[^/]{1,253}\/)[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?(?:\.[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?)*\/)?[a-zA-Z0-9](?:[a-zA-Z0-9_.-]{0,61}[a-zA-Z0-9])?(?![\s\S])

• apps

  {object}

• zoneName

  string required

• integrationId

  string required

• customDomains

  {object}

• zoneName

  string required

• integrationId

  string required

• loadBalancers

  {object}

• zoneName

  string required

• integrationId

  string required

• workloads

  {object}
  DEPRECATED: This field will be removed in the near future.

• runtimeClass

  string
  Defines which runtime scheduling constraints apply for workloads
  one of

  none, gvisor, kata-clh, kata-qemu

• builds

  {object}
  DEPRECATED: This field will be removed in the near future.

• runtimeClass

  string
  Defines which runtime scheduling constraints apply for builds
  one of

  none, gvisor, kata-clh, kata-qemu

• sandboxing

  {object}

• installGvisor

  boolean

• installMicroVm

  boolean

• defaultSandbox

  {object}

• builds

  string
  Default runtime class used for builds if none is configured
  one of

  none, gvisor, kata-clh, kata-qemu

• jobs

  string
  Default runtime class used for jobs if none is configured
  one of

  none, gvisor, kata-clh, kata-qemu

• services

  string
  Default runtime class used for services if none is configured
  one of

  none, gvisor, kata-clh, kata-qemu

• addons

  string
  Default runtime class used for addons if none is configured
  one of

  none, gvisor, kata-clh, kata-qemu

• installKata

  boolean
  DEPRECATED: This field will be removed in the near future.

• installGvisor

  boolean
  DEPRECATED: This field will be removed in the near future.

• cleanupVolumes

  boolean

• cleanupSnapshots

  boolean

• cephStorageProvider

  {object}

• enabled

  boolean

• resources

  {object}

• cpu

  number
  Configure the CPU resources per Ceph replica
  min

  1

  max

  20

• memory

  number
  Configure the memory resources per Ceph replica
  min

  4096

  max

  40960

• storage

  number
  Configure the data disk size per Ceph replica
  min

  102400

  max

  5242880

• enableMultiReadWriteStorage

  boolean
  Configure Ceph to be enable use of multi read write storage for persistent volumes on the cluster.

• enableSingleReadWriteStorage

  boolean
  Configure Ceph to be used as default storage class for single read write storage. This will replace the default storage of the cloud provider.

• enableErasureCoding

  boolean
  Configure Ceph to be set up with erasure coding. This will be less fault tolerant but more cost effective.

• enableTopologyAwareScheduling

  boolean
  Configure Ceph to be set up with topology aware scheduling, enforcing deployment across multiple zones.

• services

  {object}
  Request modifiers for services

• cpu

  number required
  min

  0.2

  max

  1

• memory

  number required
  min

  0.4

  max

  1

• jobs

  {object}
  Request modifiers for jobs

• cpu

  number required
  min

  0.2

  max

  1

• memory

  number required
  min

  0.4

  max

  1

• builds

  {object}
  Request modifiers for builds

• cpu

  number required
  min

  0.1

  max

  1

• memory

  number required
  min

  0.1

  max

  1

• addons

  {object}
  Request modifiers for addons

• cpu

  number required
  min

  0.2

  max

  1

• memory

  number required
  min

  0.4

  max

  1

• {object}

• teamId

  string required
  The ID of the team that has access to this BYOC cluster
  min length

  3

  max length

  45

  pattern

  ^[a-zA-Z](-?[a-zA-Z0-9]+(-[a-zA-Z0-9]+)*)?$

• network

  string
  Name of the GCP network the cluster should be created in. By default a new network will be created.

• subnetwork

  string
  Name of the GCP subnetwork the cluster should be created in. By default a new subnetwork will be created.

• string
  pattern

  ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$

• string
  pattern

  ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$

• mode

  string required
  The mode of the AWS subnet configuration
  one of

  default-subnets-for-azs, explicit-subnets

• vpcId

  string
  Id of the VPC

• subnets

  [array] required
  List of subnets the cluster should be created for. At least 2 must be specified.
• string

• vcnId

  string required
  ID of the OCI VCN the cluster should be created in.

• subnetIdForKubernetesApi

  string required
  ID of the subnet to use for the Kubernetes API endpoint.

• subnetIdsForServiceLBs

  [array] required
  IDs of the subnets to use for service load balancers.
• string

• vnetConfiguration

  {object}

• mode

  string required
  The vnet mode to use for this cluster. Use this to switch between creation of a new vnet per cluster or specifying a custom vnet.
  one of

  create-default, custom-vnet

• vnetId

  string
  Azure vnetId that should be used for this cluster. By default a new vnet will be created.

• networkPluginMode

  string
  Optional setting to configure overlay mode on Azure.
  one of

  overlay

• string
  pattern

  ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\/([0-9]|[1-2][0-9]|3[0-2]))$

• networkMode

  string required
  The network mode to use for this cluster. Use this to switch between the default network configuration and a custom VPC.
  one of

  create-default, custom

• vpcId

  string
  ID of the CoreWeave VPC to use for this cluster.

• customPrefixNames

  {object}

• podCidrName

  string required
  Name of the VPC prefix to use for the pod CIDR.

• serviceCidrName

  string required
  Name of the VPC prefix to use for the service CIDR.

• internalLbCidrNames

  [array] required
  Names of the VPC prefixes to use for internal load balancer CIDRs.
• string