Skip to content

Commit 8422e48

Browse files
author
Andrey Cheptsov
committed
Fix CLI API guide SSH docs
1 parent 725e44e commit 8422e48

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

mkdocs/docs/guides/cli-api.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -158,8 +158,8 @@ $ dstack apply -f .dstack.yml
158158

159159
!!! info "Attached by default"
160160
For run configurations, `dstack apply` automatically attaches after
161-
submitting the run. This streams logs, forwards declared ports, and
162-
configures SSH access. See [Attach to runs](#attach-to-runs).
161+
submitting the run. This configures SSH access, forwards declared ports, and
162+
streams logs. See [Attach to runs](#attach-to-runs).
163163

164164
Use `-d` to submit in detached mode.
165165

@@ -181,24 +181,26 @@ $ dstack attach <run name>
181181
`dstack attach <run name>`, the CLI downloads the current user's built-in
182182
private SSH key if needed and stores it under `~/.dstack/ssh/`.
183183

184-
While attached, the CLI updates `~/.dstack/ssh/config` with the run name as
185-
an SSH host alias and ensures this file is included from `~/.ssh/config`:
184+
While attached, the CLI updates `~/.dstack/ssh/config` and ensures this file
185+
is included from `~/.ssh/config`. The file contains a `Host <run name>`
186+
alias used by `ssh <run name>` to SSH into the run container:
186187

187188
<div editor-title="~/.dstack/ssh/config">
188189

189190
```ssh-config
190-
Host &lt;run name&gt;
191-
HostName localhost
192-
Port &lt;local SSH port&gt;
193-
User root
194-
IdentityFile ~/.dstack/ssh/&lt;key&gt;
191+
Host <run name>
192+
HostName <host>
193+
Port <ssh port>
194+
User <user>
195+
IdentityFile <private user SSH key>
195196
IdentitiesOnly yes
196197
```
197198

198199
</div>
199200

200-
For VM-based and SSH fleets, `dstack` may also configure the
201-
`<run name>-host` alias for SSH access to the host.
201+
> For [VM-based backends](../concepts/backends.md#vm-based) and
202+
> [SSH fleets](../concepts/fleets.md), `dstack` may add an additional alias
203+
> `<run name>-host` and use it as a proxy jump for `ssh <run name>`.
202204

203205
While attached, connect to the run with:
204206

0 commit comments

Comments
 (0)