From 070d50804244dd60ac4db2b8b2d44cd46dc0dd02 Mon Sep 17 00:00:00 2001 From: Jan Dubois Date: Tue, 21 Feb 2023 12:44:42 -0800 Subject: [PATCH] Document `rdctl shell` command for Rancher Desktop And discourage us of `limactl` with the Rancher Desktop VM. Signed-off-by: Jan Dubois --- README.md | 23 +++++------------------ 1 file changed, 5 insertions(+), 18 deletions(-) diff --git a/README.md b/README.md index 463e829cc12..64dfdafffc0 100644 --- a/README.md +++ b/README.md @@ -469,27 +469,14 @@ Run `limactl edit ` to open the YAML editor for an existing instance. ### External projects #### "I am using Rancher Desktop. How to deal with the underlying Lima?" -On macOS hosts, Rancher Desktop (as of v1.0) launches Lima with the following configuration: +Rancher Desktop includes the `rdctl` tool (installed in `~/.rd/bin/rdctl`) that provides shell access via `rdctl shell`. -- `$LIMA_HOME` directory: `$HOME/Library/Application Support/rancher-desktop/lima` -- `limactl` binary: `/Applications/Rancher Desktop.app/Contents/Resources/resources/darwin/lima/bin/limactl` -- Lima instance name: `0` +It is not recommended to directly interact with the Rancher Desktop VM via `limactl`. -To open a shell, run the following command: +If you need to create an `override.yaml` file, its location should be: -```shell -LIMA_HOME="$HOME/Library/Application Support/rancher-desktop/lima" "/Applications/Rancher Desktop.app/Contents/Resources/resources/darwin/lima/bin/limactl" shell 0 -``` - -On Linux hosts, try the following command: -```shell -LIMA_HOME="$HOME/.local/share/rancher-desktop/lima" /opt/rancher-desktop/resources/resources/linux/lima/bin/limactl shell 0 -``` - -If you have installed Rancher Desktop as an AppImage: -```shell -LIMA_HOME="$HOME/.local/share/rancher-desktop/lima" "$(ls -d /tmp/.mount_ranche*/opt/rancher-desktop/resources/resources/linux/lima/bin)/limactl" shell 0 -``` +* macOS: `$HOME/Library/Application Support/rancher-desktop/lima/_config/override.yaml` +* Linux: `$HOME/.local/share/rancher-desktop/lima/_config/override.yaml` ### "Hints for debugging other problems?" - Inspect logs: