Skip to content

Need help?

Reach out to us on Discord

Discord

gateway

The gateway configuration type allows creating and updating gateways.

Root reference

name - (Optional) str The gateway name.
default - (Optional) bool Whether the gateway is the project's default. Can be updated in-place. If unset when creating a new gateway, the gateway will become the default unless there is already a default gateway. If unset when updating the gateway in-place, the gateway's default status will not change.
backend - (Required) "amddevcloud" | "aws" | "azure" | "cloudrift" | "crusoe" | "cudo" | "datacrunch" | "digitalocean" | "dstack" | "gcp" | "hotaisle" | "jarvislabs" | "kubernetes" | "lambda" | "remote" | "nebius" | "oci" | "runpod" | "tensordock" | "vastai" | "verda" | "vultr" | "slurm" The gateway backend.
region - (Required) str The gateway region.
instance_type - (Optional) str Backend-specific instance type to use for the gateway instance. Omit to use the backend's default, which is typically a small non-GPU instance.
domain - (Optional) str The gateway wildcard domain name, e.g. example.com. Service domain names are constructed as <run name>.<gateway domain. The domain name can use the ${{ run.project_name }} variable to include the service’s project name. Can be updated in-place. Updates do not affect existing services.
public_ip - (Optional) bool Allocate public IP for the gateway. Defaults to true.
certificate - (Optional) object The SSL certificate configuration. Set to null to disable. Defaults to type: lets-encrypt.
replicas - (Optional) int The number of gateway replicas. Defaults to 1.
tags - (Optional) dict The custom tags to associate with the gateway. The tags are also propagated to the underlying backend resources. If there is a conflict with backend-level tags, does not override them.

certificate

Set to null to disable certificates (e.g. for private gateways).

type - (Required) "lets-encrypt" Automatic certificates by Let's Encrypt. Must be lets-encrypt.
type - (Required) "acm" Certificates by AWS Certificate Manager (ACM). Must be acm.
arn - (Required) str The ARN of the wildcard ACM certificate for the domain.