Skip to content

Commit f77c2ef

Browse files
authored
Merge pull request #306 from Dstack-TEE/rdme-portmap
rdme: Update access for non-kms apps
2 parents 6f44274 + 9ec77c0 commit f77c2ef

File tree

1 file changed

+14
-17
lines changed

1 file changed

+14
-17
lines changed

README.md

Lines changed: 14 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -183,23 +183,15 @@ Open the dstack-vmm webpage [http://localhost:9080](http://localhost:9080) (chan
183183

184184
After the container is deployed, it should take some time to start the CVM and the containers. Time would be vary depending on your workload.
185185

186-
- **[Logs]**: Click the button to see the logs of the CVM, you can see if the container is finished starting there
187-
- **[Dashboard]**: Once the container is running, you can click the button to see some information about the container. The logs of the containers can be seen in the Dashboard page
186+
- **[Logs]**: Click this button to view the CVM logs and monitor container startup progress
187+
- **[Dashboard]**: Once the container is running, click this button to view container information and logs. (Note: This button is only visible when dstack-gateway is enabled. If disabled, you'll need to add a port mapping to port 8090 to access the CVM dashboard)
188188

189189
<div align="center">
190190

191191
<img src="./docs/assets/guest-agent.png" alt="Guest Agent Dashboard" height="300">
192192

193193
</div>
194194

195-
- **Gateway Dashboard**: You can open dstack-gateway's dashboard at [https://localhost:9070](https://localhost:9070) to see the CVM's wireguard ip address:
196-
197-
<div align="center">
198-
199-
<img src="./docs/assets/gateway.png" alt="Gateway Dashboard" height="150">
200-
201-
</div>
202-
203195
### Pass Secrets to Apps
204196

205197
When deploying a new App, you can pass private data via Encrypted Environment Variables. These variables can be referenced in the docker-compose.yaml file as shown below:
@@ -214,19 +206,24 @@ The environment variables will be encrypted in the client-side and decrypted in
214206

215207
### Access the App
216208

217-
Once the app is deployed and listening on an HTTP port, you can access the HTTP service via dstack-gateway's public domain. The ingress mapping rules are:
209+
Once your app is deployed and listening on an HTTP port, you can access it through dstack-gateway's public domain using these ingress mapping rules:
210+
211+
- `<id>[-[<port>][s|g]].<base_domain>` → maps to port `<port>` in the CVM
212+
213+
**Examples**:
218214

219-
- `<id>[s].<base_domain>` maps to port `80` or `443` if with `s` in the CVM
220-
- `<id>-<port>[s].<base_domain>` maps to port `<port>` in the CVM
215+
- `3327603e03f5bd1f830812ca4a789277fc31f577-8080.app.kvin.wang` → port `8080` (TLS termination to any TCP)
216+
- `3327603e03f5bd1f830812ca4a789277fc31f577-8080g.app.kvin.wang` → port `8080` (TLS termination with HTTP/2 negotiation)
217+
- `3327603e03f5bd1f830812ca4a789277fc31f577-8080s.app.kvin.wang` → port `8080` (TLS passthrough to any TCP)
221218

222-
**Example**: `3327603e03f5bd1f830812ca4a789277fc31f577-8080.app.kvin.wang` maps to port `8080` in the CVM.
219+
The `<id>` can be either the app ID or instance ID. When using the app ID, the load balancer will select one of the available instances. Adding an `s` suffix enables TLS passthrough to the app instead of terminating at dstack-gateway. Adding a `g` suffix enables HTTPS/2 with TLS termination for gRPC applications.
223220

224-
Where the `<id>` can be either the app id or the instance id. If the app id is used, one of the instances will be selected by the load balancer. If the `id-port` part ends with `s`, it means the TLS connection will be passthrough to the app rather than terminating at dstack-gateway.
221+
**Note**: If dstack-gateway is disabled, you'll need to use port mappings configured during deployment to access your application via the host's IP address and mapped ports.
225222

226-
You can also ssh into the CVM to inspect more information, if your deployment uses the image `dstack-x.x.x-dev`:
223+
For development images (`dstack-x.x.x-dev`), you can SSH into the CVM for inspection:
227224

228225
```bash
229-
# The IP address of the CVM can be found in the dstack-gateway dashboard
226+
# Find the CVM wg IP address in the dstack-vmm dashboard
230227
231228
```
232229

0 commit comments

Comments
 (0)