Skip to content

Commit

Permalink
Merge branch 'rancher-sandbox:main' into rd-update-urls
Browse files Browse the repository at this point in the history
  • Loading branch information
sunilarjun authored Aug 18, 2023
2 parents 8f93160 + 492b17f commit 4b19494
Showing 1 changed file with 84 additions and 1 deletion.
85 changes: 84 additions & 1 deletion docs/references/rdctl-command-reference.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,38 @@ rdctl set --kubernetes-enabled=false

but less concise and user-friendly.

## rdctl create-profile

Generates a deployment profile for Rancher Desktop settings in either macOS `.plist` or Windows `.reg` format.

```console
rdctl create-profile <options> <options-input>
```

<details>
<summary>Options & Example Command</summary>

**Options**

```console
--input [FILE] File containing a JSON document.
--body [JSON] Command-line option containing a JSON document
--from-settings Use current settings.
--output [plist, reg] An output of .plist files for macOS and .reg files for Windows.

Additional options for --output reg:
--type [locked, defaults] The locked field is set as default, otherwise the default type can be specified.
--hive [hklm, hkcu] The hklm field is set as default, otherwise hkcu can be specified.
```

**Example**

```console
rdctl create-profile --output reg --hive=Hkcu --from-settings
```

</details>

## rdctl extension install

Installs a Rancher Desktop extension.
Expand Down Expand Up @@ -411,9 +443,60 @@ shutdown: curl -s -H "Authorization: Basic $AUTH" http://localhost:6107/v0/shutd
Run `rdctl start` to ensure that Rancher Desktop is running and configured as requested.

<details>
<summary>Example Output</summary>
<summary>Options & Example Command</summary>

**Options:**

```console
Usage:
rdctl start [flags]

Flags:
--application.admin-access enable privileged operations
--application.auto-start start app when logging in
--application.debug generate more verbose logging
--application.hide-notification-icon don't show notification icon
--application.path-management-strategy string update PATH to include ~/.rd/bin (allowed values: [manual, rcfiles])
--application.start-in-background start app without window
--application.telemetry.enabled allow collection of anonymous statistics
--application.updater.enabled automatically update to the latest release
--application.window.quit-on-close terminate app when the main window is closed
--container-engine.allowed-images.enabled only allow images to be pulled that match the allowed patterns
--container-engine.name string set engine (allowed values: [containerd, docker, moby])
--diagnostics.show-muted unhide muted diagnostics
--experimental.virtual-machine.mount.9p.cache-mode string (allowed values: [none, loose, fscache, mmap])
--experimental.virtual-machine.mount.9p.msize-in-kib int maximum packet size
--experimental.virtual-machine.mount.9p.protocol-version string (allowed values: [9p2000, 9p2000.u, 9p2000.L])
--experimental.virtual-machine.mount.9p.security-model string (allowed values: [passthrough, mapped-xattr, mapped-file, none])
--experimental.virtual-machine.mount.type string how directories are shared (allowed values: [reverse-sshfs, 9p, virtiofs])
--experimental.virtual-machine.socket-vmnet use socket-vmnet instead of vde-vmnet
--experimental.virtual-machine.type string (allowed values: [qemu, vz])
--experimental.virtual-machine.use-rosetta
-h, --help help for start
--images.namespace string select only images from this namespace (containerd only)
--images.show-all show system images on Images page
--kubernetes.enabled run Kubernetes
--kubernetes.options.flannel use flannel networking; disable to install your own CNI
--kubernetes.options.traefik install and run traefik
--kubernetes.port int apiserver port
--kubernetes.version string choose which version of Kubernetes to run
--no-modal-dialogs avoid displaying dialog boxes
-p, --path string path to main executable
--port-forwarding.include-kubernetes-services show Kubernetes system services on Port Forwarding page
--virtual-machine.memory-in-gb int reserved RAM size
--virtual-machine.number-cpus int reserved number of CPUs

Global Flags:
--config-path string config file (default /Users/{username}/Library/Application Support/rancher-desktop/rd-engine.json)
--host string default is localhost; most useful for WSL
--password string overrides the password setting in the config file
--port string overrides the port setting in the config file
--user string overrides the user setting in the config file
```

**Example:**

```console
> rdctl start --container-runtime dockerd -- kubernetes-version 1.19.3
```

Expand Down

0 comments on commit 4b19494

Please sign in to comment.