Skip to content

[Docs] Describe some gateway options on Concepts/Gateways page #3287

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
un-def merged 2 commits into from
Nov 14, 2025
Merged

[Docs] Describe some gateway options on Concepts/Gateways page #3287

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5dffde9
[Docs] Describe some gateway options on Concepts/Gateways page
un-def Nov 13, 2025
f61e1ff
[Docs] Gateway docs
peterschmidt85 Nov 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion docs/docs/concepts/gateways.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ provide an HTTPS endpoint mapped to your domain, handle auto-scaling and rate li
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).

<div editor-title="gateway.dstack.yml">
<div editor-title="gateway.dstack.yml">

```yaml
type: gateway
Expand Down Expand Up @@ -47,6 +47,21 @@ Provisioning...

</div>

## Configuration options

### Backend

You can create gateways with the `aws`, `azure`, `gcp`, or `kubernetes` backends, but that does not limit where services run. A gateway can use one backend while services run on any other backend supported by dstack, including backends where gateways themselves cannot be created.

??? info "Kubernetes"
Gateways in `kubernetes` backend require an external load balancer. Managed Kubernetes solutions usually include a load balancer.
For self-hosted Kubernetes, you must provide a load balancer by yourself.

### Public IP

If you don't need/want a public IP for the gateway, you can set the `public_ip` to `false` (the default value is `true`), making the gateway private.
Private gateways are currently supported in `aws` and `gcp` backends.

!!! info "Reference"
For all gateway configuration options, refer to the [reference](../reference/dstack.yml/gateway.md).

Expand Down