Gateways¶

Gateways manage the ingress traffic of running services, provide an HTTPS endpoint mapped to your domain, and handle auto-scaling.

If you're using dstack Sky , the gateway is already set up for you.

Define a configuration¶

First, define a gateway configuration as a YAML file in your project folder. The filename must end with .dstack.yml (e.g. .dstack.yml or gateway.dstack.yml are both acceptable).

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

A domain name is required to create a gateway.

Reference

For all gateway configuration options, refer to the reference.

Create or update a gateway¶

To create or update the gateway, simply call the dstack apply command:

$ dstack apply -f gateway.dstack.yml
The example-gateway doesn't exist. Create it? [y/n]: y

 BACKEND  REGION     NAME             HOSTNAME  DOMAIN       DEFAULT  STATUS
 aws      eu-west-1  example-gateway            example.com  ✓        submitted

Update DNS records¶

Once the gateway is assigned a hostname, go to your domain's DNS settings and add a DNS record for *.<gateway domain>, e.g. *.example.com. The record should point to the gateway's hostname shown in dstack and should be of type A if the hostname is an IP address (most cases), or of type CNAME if the hostname is another domain (some private gateways and Kubernetes).

Manage gateways¶

List gateways¶

The dstack gateway list command lists existing gateways and their status.

Delete a gateway¶

To delete a gateway, pass the gateway configuration to dstack delete:

$ dstack delete -f examples/deployment/gateway.dstack.yml

Alternatively, you can delete a gateway by passing the gateway name to dstack gateway delete.

What's next?

See services on how to run services