Skip to content

Commit cddff7b

Browse files
authored
accessing_virtual_machines: Remove virtctl local ssh flag (#915)
virtctl now only supports wrapping local ssh and scp clients. The --local-ssh flag was dropped, therefore remove it from the user guide. Signed-off-by: Felix Matouschek <[email protected]>
1 parent a93679d commit cddff7b

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

docs/user_workloads/accessing_virtual_machines.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -258,8 +258,8 @@ a `VirtualMachineInstance` either from the CLI or a web-UI. The `VirtualMachine`
258258
subresource will automatically look up the corresponding `VirtualMachineInstance`.
259259

260260
To connect to a `VirtualMachineInstance` from your local machine, `virtctl`
261-
provides an SSH client with the `ssh` command, that uses port
262-
forwarding. Refer to the command's help for more details.
261+
wraps the local SSH client with the `ssh` command and transparently uses port
262+
forwarding as described above. Refer to the command's help for more details.
263263

264264
```shell
265265
virtctl ssh
@@ -277,12 +277,11 @@ virtctl scp
277277

278278
The preferred way of connecting to VMs and VMIs is to use `virtctl` to wrap
279279
local OpenSSH clients. If you prefer to use your local OpenSSH client directly
280-
instead, there are two ways of doing that in combination with `virtctl`.
280+
instead, there is also a way of doing that in combination with `virtctl`.
281281

282282
> Note: Most of this applies to the `virtctl scp` command too.
283283
284-
1. The `virtctl ssh` command has a `--local-ssh` option, which is set to `true` by
285-
default. With this option, `virtctl` wraps the local OpenSSH client transparently
284+
1. By default `virtctl` wraps the local OpenSSH client transparently
286285
to the user. The executed SSH command can be viewed by increasing the verbosity (`-v 3`).
287286

288287
```shell

0 commit comments

Comments
 (0)