gateway

The gateway configuration type allows creating and updating gateways.

Configuration files must be inside the project repo, and their names must end with .dstack.yml (e.g. .dstack.yml or gateway.dstack.yml are both acceptable). Any configuration can be run via dstack apply.

Examples

Creating a new gateway

type: gateway
# A name of the gateway
name: example-gateway

# Gateways are bound to a specific backend and region
backend: aws
region: eu-west-1

# This domain will be used to access the endpoint
domain: example.com

Root reference

name - (Optional) The gateway name.

default - (Optional) Make the gateway default.

backend - The gateway backend.

region - The gateway region.

domain - (Optional) The gateway domain, e.g. example.com.

public_ip - (Optional) Allocate public IP for the gateway. Defaults to True.

certificate - (Optional) The SSL certificate configuration. Defaults to type: lets-encrypt.

certificate[type=lets-encrypt]

type - Automatic certificates by Let's Encrypt. Must be lets-encrypt.

certificate[type=acm]

type - Certificates by AWS Certificate Manager (ACM). Must be acm.

arn - The ARN of the wildcard ACM certificate for the domain.