Skip to content

Commit 58a62f7

Browse files
[Docs] Describe some gateway options on Concepts/Gateways page (#3287)
Co-authored-by: peterschmidt85 <andrey.cheptsov@gmail.com>
1 parent b1d0507 commit 58a62f7

1 file changed

Lines changed: 16 additions & 1 deletion

File tree

docs/docs/concepts/gateways.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ provide an HTTPS endpoint mapped to your domain, handle auto-scaling and rate li
1111
First, define a gateway configuration as a YAML file in your project folder.
1212
The filename must end with `.dstack.yml` (e.g. `.dstack.yml` or `gateway.dstack.yml` are both acceptable).
1313

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

1616
```yaml
1717
type: gateway
@@ -47,6 +47,21 @@ Provisioning...
4747

4848
</div>
4949

50+
## Configuration options
51+
52+
### Backend
53+
54+
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.
55+
56+
??? info "Kubernetes"
57+
Gateways in `kubernetes` backend require an external load balancer. Managed Kubernetes solutions usually include a load balancer.
58+
For self-hosted Kubernetes, you must provide a load balancer by yourself.
59+
60+
### Public IP
61+
62+
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.
63+
Private gateways are currently supported in `aws` and `gcp` backends.
64+
5065
!!! info "Reference"
5166
For all gateway configuration options, refer to the [reference](../reference/dstack.yml/gateway.md).
5267

0 commit comments

Comments
 (0)