diff --git a/versioned_docs/version-latest/ui/preferences/application.md b/versioned_docs/version-latest/ui/preferences/application.md deleted file mode 100644 index c94445aa71..0000000000 --- a/versioned_docs/version-latest/ui/preferences/application.md +++ /dev/null @@ -1,171 +0,0 @@ ---- -sidebar_label: Application -title: Application ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import TabsConstants from '@site/core/TabsConstants'; - -### General - -Allows for enablement of automatic updates, as well as an optional field to allow Rancher Desktop to collect anonymous statistics to help improve the application. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Windows_application_tabGeneral.png) - -#### Automatic Updates - -When an update is available, users are provided a notification and the release notes for the upgrade target. This happens whether automatic updates are enabled or not. If this option is enabled, the update is downloaded and then installed the next time Rancher Desktop is started. - -#### Statistics - -This option allows Rancher Desktop to collect information on how you interact with the Rancher Desktop application. Information such as what workloads you run are not collected. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.12/preferences/macOS_application_tabGeneral.png) - -#### Administrative Access - -Allows Rancher Desktop to acquire administrative access (sudo access) when starting for some operations. This allows for enhanced functionality, including bridged networking and default docker socket support. Changes will only be applied next time Rancher Desktop starts. - -#### Automatic Updates - -When an update is available, users are provided a notification and the release notes for the upgrade target. This happens whether automatic updates are enabled or not. If this option is enabled, the update is downloaded and then installed the next time Rancher Desktop is started. - -#### Statistics - -This option allows Rancher Desktop to collect information on how you interact with the Rancher Desktop application. Information such as what workloads you run are not collected. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Linux_application_tabGeneral.png) - -#### Administrative Access - -Allows Rancher Desktop to acquire administrative access (sudo access) when starting for some operations. This allows for enhanced functionality, including bridged networking and default docker socket support. Changes will only be applied next time Rancher Desktop starts. - -#### Automatic Updates - -When an update is available, users are provided a notification and the release notes for the upgrade target. This happens whether automatic updates are enabled or not. If this option is enabled, the update is downloaded and then installed the next time Rancher Desktop is started. - -#### Statistics - -This option allows Rancher Desktop to collect information on how you interact with the Rancher Desktop application. Information such as what workloads you run are not collected. - - - - -### Behavior - -Allows for configuration of application behavior upon startup, background process behavior, and notification icon display. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Windows_application_tabBehavior.png) - -#### Startup - -Rancher Desktop can automatically be started as part of the user login process. This will take all other behavior settings from the page into account as well. - -#### Background - -When Rancher Desktop is started in the background, it will not have an application window, nor an entry in the task switcher or task bar. The application window can still be opened via the context menu of the notification icon. - -When Rancher Desktop is launched again while already running in the background then the application window is shown and the application is added to the task switcher and task bar. This can be used to gain access to the background application again when the notification icon is unavailable as well. - -Rancher Desktop normally remains running in the background even when the main application window is closed (and the application therefore removed from the task switcher and task bar), but can be configured to terminate the application as well when the main window is closed. - -#### Notification Icon - -Rancher Desktop shows the application status with a notification icon. The context menu of the icon provides more status information and provides quick access to other functionality of the application. This options will disable the creation of the notification icon. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.12/preferences/macOS_application_tabBehavior.png) - -#### Startup - -Rancher Desktop can automatically be started as part of the user login process. This will take all other behavior settings from the page into account as well. - -#### Background - -When Rancher Desktop is started in the background, it will not have an application window, nor an entry in the app switcher or the dock. The application window can still be opened via the context menu of the notification icon in the menu bar. - -When Rancher Desktop is launched again while already running in the background then the application window is shown and the application is added to the app switcher and the dock. This can be used to gain access to the background application again when the notification icon is unavailable as well. - -Rancher Desktop normally remains running in the background even when the main application window is closed (and the application therefore removed from the app switcher and the dock), but can be configured to terminate the application as well when the main window is closed. - -#### Notification Icon - -Rancher Desktop shows the application status with a notification icon in the menu bar. The context menu of the icon provides more status information and provides quick access to other functionality of the application. This options will disable the creation of the notification icon. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Linux_application_tabBehavior.png) - -#### Startup - -Rancher Desktop can automatically be started as part of the user login process. This will take all other behavior settings from the page into account as well. - -#### Background - -When Rancher Desktop is started in the background, it will not have an application window, nor an entry in the task switcher or task bar. The application window can still be opened via the context menu of the notification icon. - -When Rancher Desktop is launched again while already running in the background then the application window is shown and the application is added to the task switcher and task bar. This can be used to gain access to the background application again when the notification icon is unavailable as well. - -Rancher Desktop normally remains running in the background even when the main application window is closed (and the application therefore removed from the task switcher and task bar), but can be configured to terminate the application as well when the main window is closed. - -#### Notification Icon - -Rancher Desktop shows the application status with a notification icon. The context menu of the icon provides more status information and provides quick access to other functionality of the application. This options will disable the creation of the notification icon. - - - - -### Environment - -Allows for configuration of the `$PATH` variable in the users shell in order to interact with Rancher Desktop installed utilities. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.12/preferences/macOS_application_tabEnvironment.png) - -#### Configure PATH - -A Rancher Desktop installation comes with command-line utilities that are used to interface with its various features. Some examples of these utilities are `docker`, `nerdctl`, `kubectl`, and `helm`. These utilities are located in `~/.rd/bin` - you may see which utilities are included in your installation by running `ls ~/.rd/bin`. - -In order to use the utilities, `~/.rd/bin` must be in the `PATH` variable in your shell. - -There are two options for doing this: - -- **Automatic**: `PATH` management will add `~/.rd/bin` to your `PATH` by modifying your shell .rc files for you. -- **Manual**: `PATH` management does not change anything - in this mode, you must add `~/.rd/bin` to your `PATH` yourself. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Linux_application_tabEnvironment.png) - -#### Configure PATH - -A Rancher Desktop installation comes with command-line utilities that are used to interface with its various features. Some examples of these utilities are `docker`, `nerdctl`, `kubectl`, and `helm`. These utilities are located in `~/.rd/bin` - you may see which utilities are included in your installation by running `ls ~/.rd/bin`. - -In order to use the utilities, `~/.rd/bin` must be in the `PATH` variable in your shell. - -There are two options for doing this: - -- **Automatic**: `PATH` management will add `~/.rd/bin` to your `PATH` by modifying your shell .rc files for you. -- **Manual**: `PATH` management does not change anything - in this mode, you must add `~/.rd/bin` to your `PATH` yourself. - - - diff --git a/versioned_docs/version-latest/ui/preferences/container-engine.md b/versioned_docs/version-latest/ui/preferences/container-engine.md deleted file mode 100644 index 6fe60dcea2..0000000000 --- a/versioned_docs/version-latest/ui/preferences/container-engine.md +++ /dev/null @@ -1,95 +0,0 @@ ---- -sidebar_label: Container Engine -title: Container Engine ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import TabsConstants from '@site/core/TabsConstants'; - -### General - -Set the [container runtime] for Rancher Desktop. Users have the option of [containerd] which provides namespaces for containers and the use of nerdctl or [dockerd (moby)] which enables the Docker API and the use of the Docker CLI. Only one container runtime will function at a time. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Windows_containerEngine_tabGeneral.png) - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.12/preferences/macOS_containerEngine_tabGeneral.png) - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Linux_containerEngine_tabGeneral.png) - - - - -#### Container Engine - -When switching to a different container runtime: Workloads and images that have been built or pulled using the current container runtime are not available on the container runtime being switched to. - - -### Allowed Images - -The `Allowed Images` tab lets you control which registry artifacts you can access within Rancher Desktop. For example, you may want to pull container images only from your organization's private registry or only from your department-specific namespace in your organization's registry, etc. You can specify image name patterns to allow accessing images only from specific registries and/or repositories. - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Windows_containerEngine_tabAllowedImages.png) - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/macOS_containerEngine_tabAllowedImages.png) - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Linux_containerEngine_tabAllowedImages.png) - - - - -#### Allowed image patterns - -Check the **Enable** checkbox to enable Rancher Desktop to apply the specified patterns while pulling or pushing images, which means only images whose names match at least one of the specified patterns will be allowed. - -You can use the **+** and **-** buttons to add/remove image name patterns. - -##### How to specify Allowed Image patterns - -You can specify Allowed Image patterns using the format `[registry/][:port/][organization/]repository[:tag]`. - -> If not specified in an Allowed Image pattern, -> * `registry` defaults to Docker Hub (`docker.io`). -> * `port` defaults to 443. -> * `organization` for Docker Hub defaults to `library`, and does not apply to other registries. -> * `tag` defaults to anything and **not** just to `latest`. - -**Note:** Filtering by `tag` does not actually work; the corresponding digests (`repository@digest`) will have to be added to the allow list as well, making this impractical. Please file a Github issue if you have a use-case that requires filtering based on tags! - -#### Examples - -| Pattern | Meaning | -|---------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| -| `busybox` | Allow the `busybox` repository in the `library` organization of the `docker.io` registry. | -| `suse/` | Allow any image in the `suse` organization of the `docker.io` registry.
**Note:** A trailing slash at the end of the repository means a single segment follows, e.g. `suse/nginx`, but not `suse/cap/uaa`. | -| `suse//` | Allow any image in the `suse` organization of the `docker.io` registry.
**Note:** A trailing double slash at the end of the repository means one or more segments follow, e.g. `suse/cap/uaa`. | -| `registry.internal:5000` | Allow any image from the `registry.internal:5000` registry. | -| `registry.suse.com/nginx` | Allow the image `nginx` from the `registry.suse.com` registry.
**Note:** Non-DockerHub registries do not have the concept of organizations at the top level, so no default `library` organization is implied. | - - -[container runtime]: -https://kubernetes.io/docs/setup/production-environment/container-runtimes/ - -[containerd]: -https://containerd.io/ - -[dockerd (moby)]: -https://mobyproject.org/ diff --git a/versioned_docs/version-latest/ui/preferences/virtual-machine.md b/versioned_docs/version-latest/ui/preferences/virtual-machine.md deleted file mode 100644 index 4443e301ef..0000000000 --- a/versioned_docs/version-latest/ui/preferences/virtual-machine.md +++ /dev/null @@ -1,29 +0,0 @@ ---- -sidebar_label: Virtual Machine -title: Virtual machine (macOS & Linux) ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; -import TabsConstants from '@site/core/TabsConstants'; - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/macOS_virtualMachine.png) - - - - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Linux_virtualMachine.png) - - - - -#### Memory - -The amount of memory to allocate to Rancher Desktop. The selectable range is based on your system. The red area within the range indicates an allocation that may affect system services. - -#### CPUs - -The number of CPUs to allocate to Rancher Desktop. The selectable range is based on your system. The red area within the range indicates an allocation that may affect system services. diff --git a/versioned_docs/version-latest/ui/preferences/wsl.md b/versioned_docs/version-latest/ui/preferences/wsl.md deleted file mode 100644 index f9dc7fb6ac..0000000000 --- a/versioned_docs/version-latest/ui/preferences/wsl.md +++ /dev/null @@ -1,16 +0,0 @@ ---- -sidebar_label: WSL -title: WSL (Windows) ---- - -import Tabs from '@theme/Tabs'; -import TabItem from '@theme/TabItem'; - -The option to make the Rancher Desktop Kubernetes configuration accessible to any Linux distributions configured for WSL. Once enabled, you can communicate with the Rancher Desktop Kubernetes cluster using tools like `kubectl` from within the WSL distribution. - -![](https://suse-rancher-media.s3.amazonaws.com/desktop/v1.8/preferences/Windows_wsl.png) - -With WSL, memory and CPU allocation is configured globally across all Linux distributions. Refer to the [WSL documentation] for instructions. - -[WSL documentation]: -https://docs.microsoft.com/en-us/windows/wsl/wsl-config#options-for-wslconfig