Skip to content

Commit 070d508

Browse files
committed
Document rdctl shell command for Rancher Desktop
And discourage us of `limactl` with the Rancher Desktop VM. Signed-off-by: Jan Dubois <[email protected]>
1 parent f9e7b00 commit 070d508

File tree

1 file changed

+5
-18
lines changed

1 file changed

+5
-18
lines changed

README.md

Lines changed: 5 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -469,27 +469,14 @@ Run `limactl edit <INSTANCE>` to open the YAML editor for an existing instance.
469469
### External projects
470470
#### "I am using Rancher Desktop. How to deal with the underlying Lima?"
471471

472-
On macOS hosts, Rancher Desktop (as of v1.0) launches Lima with the following configuration:
472+
Rancher Desktop includes the `rdctl` tool (installed in `~/.rd/bin/rdctl`) that provides shell access via `rdctl shell`.
473473

474-
- `$LIMA_HOME` directory: `$HOME/Library/Application Support/rancher-desktop/lima`
475-
- `limactl` binary: `/Applications/Rancher Desktop.app/Contents/Resources/resources/darwin/lima/bin/limactl`
476-
- Lima instance name: `0`
474+
It is not recommended to directly interact with the Rancher Desktop VM via `limactl`.
477475

478-
To open a shell, run the following command:
476+
If you need to create an `override.yaml` file, its location should be:
479477

480-
```shell
481-
LIMA_HOME="$HOME/Library/Application Support/rancher-desktop/lima" "/Applications/Rancher Desktop.app/Contents/Resources/resources/darwin/lima/bin/limactl" shell 0
482-
```
483-
484-
On Linux hosts, try the following command:
485-
```shell
486-
LIMA_HOME="$HOME/.local/share/rancher-desktop/lima" /opt/rancher-desktop/resources/resources/linux/lima/bin/limactl shell 0
487-
```
488-
489-
If you have installed Rancher Desktop as an AppImage:
490-
```shell
491-
LIMA_HOME="$HOME/.local/share/rancher-desktop/lima" "$(ls -d /tmp/.mount_ranche*/opt/rancher-desktop/resources/resources/linux/lima/bin)/limactl" shell 0
492-
```
478+
* macOS: `$HOME/Library/Application Support/rancher-desktop/lima/_config/override.yaml`
479+
* Linux: `$HOME/.local/share/rancher-desktop/lima/_config/override.yaml`
493480

494481
### "Hints for debugging other problems?"
495482
- Inspect logs:

0 commit comments

Comments
 (0)