Gateways¶

Gateways manage the ingress traffic of running services and provide them with an HTTPS endpoint mapped to your domain, handling authentication, load distribution, and auto-scaling.

To run a service, you need at least one gateway set up.

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

Define a configuration¶

First, create a YAML file in your project folder. Its name 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

See .dstack.yml for all the options supported by gateways, along with multiple examples.

Create or update a gateway¶

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

$ dstack apply . -f examples/deployment/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 an A DNS record for *.<gateway domain> (e.g., *.example.com) pointing to the gateway's hostname.

Manage gateways¶

List gateways¶

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

Delete a gateway¶

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

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

What's next?¶

See services on how to run services

Reference

See .dstack.yml for all the options supported by gateways, along with multiple examples.