Rancher Desktop Documentation
website·Indexed 37 days ago
https://docs.rancherdesktop.io/Documentation for Rancher Desktop, a tool for managing containers and Kubernetes on Windows, macOS, and Linux. Includes guides on container engine configuration (dockerd and containerd), multi-node cluster setup, snapshot management, and integration with tools like Skaffold, odo, and VS Code Remote Containers. Provides version information for bundled utilities such as nerdctl, trivy, and docker.
What's inside Rancher Desktop
- Rancher Desktop is a local application for Mac (Intel and Apple Silicon), Windows, and Linux that provides integrated container management and a local Kubernetes environment. It is distinct from the Rancher cluster management solution, although Rancher can be installed into Rancher Desktop.
Overview of rdctl CLI
rdctlis a command-line tool included with Rancher Desktop that provides programmatic access to GUI features, facilitating automation, CI/CD, and troubleshooting.Constraints:
- The Rancher Desktop application must be running to use
rdctlcommands. rdctlis currently experimental; subcommand names, arguments, and outputs are subject to change.
- The Rancher Desktop application must be running to use
Overview of Rancher Desktop capabilities
Rancher Desktop is a local application for Mac (Intel and Apple Silicon), Windows, and Linux that provides container management and a local Kubernetes environment. It is distinct from Rancher (the cluster management solution), though Rancher can be installed within Rancher Desktop.Overview of Rancher Desktop Extensions
Rancher Desktop supports Docker Desktop Extensions, allowing users to extend the functionality of the desktop environment. This feature is available in Rancher Desktop versionv1.9.0-tech-previewand later.Overview of Rancher Desktop capabilities
Rancher Desktop is a local application for Mac (Intel and Apple Silicon), Windows, and Linux that provides container management and a built-in Kubernetes environment. It allows developers to build, push, and pull container images and run containers locally.Overview of rdctl CLI
rdctlis a command-line tool included with Rancher Desktop that provides programmatic access to GUI features, facilitating automation, CI/CD scripting, and troubleshooting. Note thatrdctlis currently experimental, and subcommand names, arguments, and output are subject to change.Certain commands (such as
list-settings,set, andshutdown) require the Rancher Desktop application to be running.Credentials used by the CLI are located at:
- Linux:
~/.local/share/rancher-desktop/ - macOS:
~/Library/Application Support/rancher-desktop/ - Windows:
%LOCALAPPDATA%\rancher-desktop\
- Linux:
Overview of Rancher Desktop 2.0 Architecture
Rancher Desktop 2.0 is a full rewrite that decouples the engine from the GUI. The core of the system is
rdd(Rancher Desktop Daemon), a self-contained executable that manages the virtual machine (using Lima on all platforms, including Windows), starts the container engine, and manages the Kubernetes cluster.Key architectural changes include:
- API-Driven:
rddexposes its functionality via the standard Kubernetes API, allowing users to interact with it usingkubectlor standard client libraries without a new SDK. - Headless Operation: Because the logic resides in
rdd, the product can be run without a GUI, making it suitable for headless servers or CI runners. - Guest OS: The guest VM now uses openSUSE Leap (instead of Alpine) to provide glibc support, enabling future GPU and AI tooling compatibility.
- API-Driven:
Overview of rdctl command-line tool
rdctlis a command-line tool included with Rancher Desktop that provides access to GUI features for scripting, automation, CI/CD, troubleshooting, and remote management. Note thatrdctlis currently experimental, and subcommand names, arguments, and output are subject to change. For certain commands (such aslist-settings,set, andshutdown), the Rancher Desktop application must be running.Overview of rdctl command-line tool
rdctlis a command-line tool included with Rancher Desktop that provides access to GUI features for automation, CI/CD scripting, troubleshooting, and remote management. Note thatrdctlis currently experimental, and subcommand names, arguments, and output are subject to change. For certain commands (likelist-settings,set, andshutdown), the Rancher Desktop application must be running.rdctl helpOverview of Rancher Desktop capabilities
Rancher Desktop is a desktop application for Mac (Intel and Apple Silicon), Windows, and Linux that provides local container management and a built-in Kubernetes environment. It allows developers to build, push, and pull container images and run containers locally.Overview of the rdctl command-line tool
rdctlis a command-line tool included with Rancher Desktop that provides terminal access to GUI features. It is primarily used for automation, CI/CD scripting, troubleshooting, and remote management.Prerequisites: The Rancher Desktop application must be running on the machine to use
rdctlcommands.Warning:
rdctlis currently experimental; subcommand names, arguments, and output are subject to change.Overview of the rdctl command-line tool
rdctlis a command-line tool included with Rancher Desktop that provides access to GUI features for scripting, automation, CI/CD, troubleshooting, and remote management. Note thatrdctlis currently experimental, and subcommand names, arguments, and output are subject to change. For certain commands (likelist-settings,set, andshutdown), the Rancher Desktop application must be running.