#690: add support for rancher desktop

documentation/LICENSE.asciidoc

@@ -60,6 +60,7 @@ The following table shows the components that may be used. The column `inclusion
 |https://helm.sh/[helm]|Optional|https://github.com/devonfw/ide/blob/master/LICENSE[ASL 2.0]
 |https://terraform.io/[terraform]|Optional|https://github.com/hashicorp/terraform/blob/main/LICENSE[Mozilla Public License 2.0]
 |https://www.graalvm.org/[GraalVM] |Optional|https://github.com/oracle/graal/blob/master/LICENSE[GPLv2] (with the “Classpath” Exception)
+|https://rancherdesktop.io/[Rancher Desktop]|Optional|https://github.com/rancher-sandbox/rancher-desktop/blob/main/LICENSE[ASL 2.0]
 |=======================
 
 == Apache Software License - Version 2.0

documentation/devonfw-ide-usage.asciidoc

@@ -18,6 +18,8 @@ include::build.asciidoc[leveloffset=3]
 
 include::docker.asciidoc[leveloffset=3]
 
+include::docker-desktop-alternative.asciidoc[leveloffset=3]
+
 include::eclipse.asciidoc[leveloffset=3]
 
 include::gradle.asciidoc[leveloffset=3]

documentation/docker.asciidoc

@@ -5,7 +5,10 @@ toc::[]
 
 The Docker commandlet allows to install and use https://www.docker.com/[Docker].
 On Windows https://docs.microsoft.com/en-us/windows/wsl/install-win10[WSL 2](Windows Subsystem for Linux) has to be installed properly as a prerequisite.
-
+It also offers the installation of https://rancherdesktop.io/[Rancher Desktop], which works on Windows, Mac and Linux.
+To run the tools installed and managed by Rancher Desktop it is necessary to have Rancher Desktop up and running.  
+To assure that you are able to use these tools directly after startup, you can add Rancher Desktop to the startup programs
+of your Operating System. Such instructions will be given below inside the sections for Windows, Mac and Linux.
 *ATTENTION:*
 Currently this feature is new and therefore experimental.
 It may change in incompatible ways in the next releases until we reach a stable state.
@@ -25,9 +28,20 @@ The arguments (`devon docker «args»`) are explained by the following table:
 |=======================
 
 == setup
-The Docker commandlet will install Docker automatically.
+The Docker commandlet will install Docker Desktop or Rancher Desktop automatically.
+This depends on how the variable DOCKER_EDITION was set. We chose to set Rancher Desktop as standard
+for our installation, due to it being license free compared to Docker Desktop while offering a similar tool set (please read the document link:docker-desktop-alternative.asciidoc[docker-desktop-alternative] motivating why we added Rancher Desktop to the docker commandlet).
+Docker Desktop can still be used as before, by setting the variable DOCKER_EDITION equal to "DOCKERDESKTOP". 
+This can be done by your projects ide-admin in the link:usage.asciidoc#developer[settings file]. If you want to switch from Rancher Desktop to Docker Desktop, then add a line with the following content 
+"DOCKER_EDITION=DOCKERDESKTOP" 
+(without the quotes around the allocation) to the file devon.properties located at the path ${DEVON_IDE_HOME}/conf/devon.properties.
+
+After successfull installation please start Rancher Desktop and go to the menu point "Kubernetes Settings". Under "Container Runtime" choose dockerd(moby) to enable the docker-cli. If you use Windows, then make sure to go to the Settings named "WSL Integration".
+There you can choose the WSL Shells you want Rancher Desktop to work on. Besides that the tools like docker or kubectl should 
+directly work with CMD or Powershell.
+
 Please note that besides the sandbox concept of devonfw-ide this is a global installation on your system.
-When uninstalling devonfw-ide, you may have to manually uninstall Docker and Kubernetes if you do not need it anymore.
+When uninstalling devonfw-ide, you may have to manually uninstall Docker and Kubernetes, or Rancher Desktop if you do not need it anymore. At least uninstalling Rancher Desktop should leave way less remains if you did not install one of the related software  Rancher Desktop offers separately.
 
 === requirements
 Running Docker and especially link:kubectl.asciidoc[Kubernetes] on your machine in the background will require quite some resources.
@@ -36,15 +50,17 @@ This will allocate at least 2GB of additional RAM.
 You will need at least 8GB of total RAM while we recommend to use 16GB+.
 
 You may also tune and scale it to your needs.
-When using Docker Desktop (Windows or MacOS) simply go to the https://docs.docker.com/docker-for-windows/#resources[resources tab in the settings].
+When using Docker Desktop (Windows or MacOS) simply go to the https://docs.docker.com/docker-for-windows/#resources[resources tab in the settings]. 
 It will depend on your usage frequency if you want to have it running in the background all the time.
 This is a balance between resource utilization and convenience.
 If you use Docker and Kubernetes on your local machine on a daily basis this makes sense.
 
 In case you only use Docker rarely, you can save resources by stopping it when not needed after it has been installed.
 
 === Windows and macOS
-To enable or disable autostart, you can launch Docker Desktop on Windows or MacOS got to the `Preferences` (gear icon in the title bar). Then in the `General` tab you can check or uncheck the option `Start Docker Desktop when you login` (see also https://docs.docker.com/docker-for-windows/#general[here]). When autostart is disabled and you launch Docker Desktop it will notice and ask your to start the service or do this automatically for you.
+For Windows 10 you can use the following https://www.dell.com/support/kbdoc/de-de/000124550/how-to-add-app-to-startup-in-windows-10[Instructions on how to set startup programs for Windows 10], so that Rancher Desktop starts with your OS.
+
+To enable or disable autostart, you can launch Docker Desktop on Windows or MacOS go to the `Preferences` (gear icon in the title bar). Then in the `General` tab you can check or uncheck the option `Start Docker Desktop when you login` (see also https://docs.docker.com/docker-for-windows/#general[here]). When autostart is disabled and you launch Docker Desktop it will notice and ask your to start the service or do this automatically for you.
 On Windows you can also manually tweak this:
 
 * Hit `[windows][r]`
@@ -55,7 +71,9 @@ On Windows you can also manually tweak this:
 * Also when right clicking on Docker Desktop Service and selecting `Options` from the context-menu, you can change the start type to `automatic` or `manual`.
 
 ==== Mac A1
-In case you have a new Mac with A1 CPU, we automatically download and install the according ARM version of Docker Desktop for macOS.
+Have a look at the https://www.makeuseof.com/tag/add-remove-delay-startup-items-mac/[Instructions on how to set startup programs for MacOS] to make Rancher Desktop run directly after starting up your OS.
+
+In case you have a new Mac with A1 CPU, we automatically download and install the according ARM version of Docker Desktop or Rancher Desktop for macOS.
 However, if you use Docker and search for images you may end up with errors like:
 ```
 docker: no matching manifest for linux/arm64/v8 in the manifest list entries.
@@ -64,18 +82,14 @@ docker: no matching manifest for linux/arm64/v8 in the manifest list entries.
 So with A1 CPU you may need to add `--platform linux/x86_64` as option to your Docker command to find the expected container image.
 
 === Linux
-There is no Docker Desktop for Linux.
-As Docker initially comes from the Linux world, it is easy to set it up on a Linux machine and use it from the commandline.
-Therefore we do not install a GUI for you in case you are a Linux user.
-In case you need a GUI for Docker and Kubernetes on Linux you can choose from the following options:
+Docker Desktop isn't available for Linux, but Rancher Desktop can be used as compareable alternative as mentioned before.
 
-* https://dockstation.io/[DockStation]
-* https://portainer.io/[Portainer]
-* https://kitematic.com/[Kitematic]
-* https://shipyard-project.com/[Shipyard]
+To make the usage of Rancher Desktop more comfortable and reliable let your operating system run it after starting up your system.
+On many Linux distributions you can just go to your menu (usually by clicking the icon at your screens left bottom), type "startup" and start your systems GUI-startup manager, if popping up. At the following website you can find some https://www.simplified.guide/linux/automatically-run-program-on-startup[examples or other options on how to set startup programs for some Linux distributions].
 
 == usage
-Once installed via setup, you can run Docker directly from any shell of your OS directly.
+Once installed via setup, you can run Docker from any shell of your OS directly. If you use Rancher Desktop just
+make sure that Rancher Desktop runs in the background.
 Run `docker help` to get started and use the online documentations and resources on the web to get familiar with Docker.
 It is not our intention to repeat this here.
 

documentation/variables.asciidoc

@@ -26,6 +26,7 @@ Please note that we are trying to minimize any potential side-effect from `devon
 |*`M2_REPO`*|`$DEVON_IDE_HOME/conf/.m2/repository`|Path to your local maven repository. For projects without high security demands, you may change this to the maven default `~/.m2/repository` and share your repository among multiple projects.
 |*`MAVEN_HOME`*|`$DEVON_IDE_HOME/software/maven`|Path to Maven
 |*`MAVEN_OPTS`*|`-Xmx512m -Duser.home=$DEVON_IDE_HOME/conf`|Maven options
+|*`DOCKER_EDITION`*|e.g. `DOCKERDESKTOP`| If set as `DOCKERDESKTOP` the command `devon docker setup` will setup Docker Desktop globally at the users computer. Otherwise the setup of Rancher Desktop will be started.| 
 |*`GRAALVM_HOME`*|`$DEVON_IDE_HOME/software/extra/graalvm`|Path to GraalVM
 |`DEVON_SOFTWARE_REPOSITORY`|`-`|Project specific or custom link:software.asciidoc#repository[software-repository].
 |`DEVON_SOFTWARE_PATH`|`-`|Globally shared user-specific link:software.asciidoc#shared[local software installation location].

scripts/src/main/resources/scripts/command/docker

@@ -16,46 +16,100 @@ source "$(dirname "${0}")"/../functions
 
 # $1: optional setup
 function doSetup() {  
-  if doIsDockerInstalled 
+  if [ "${DOCKER_EDITION}" != "DOCKERDESKTOP" ]
   then
-    if [ "${1}" != "silent" ] && ! doIsQuiet
-    then
-      doEcho "docker is already installed at $(command -v docker)"
-      docker version
+    echo "Rancher Desktop set as option"
+    if uname -r | grep -i microsoft
+    then 
+      echo "It seems that you are running the setup from inside a WSL shell."
+      echo "Please use git-bash for that purpose. Otherwise your OS will be interpreted as Linux"
+    else
+      if doIsRancherInstalled 
+      then
+        doIsWindows 
+        queryWin=$?
+        if [ "${1}" != "silent" ] && ! doIsQuiet
+        then
+          #give the User the installation location when using linux or mac
+          if [ $queryWin != 0 ]
+          then
+            doEcho "Rancher Desktop is already installed at $(command -v devon docker)"
+          else
+            doEcho "Rancher Desktop is already installed"
+          fi
+        fi
+      else
+        doRequireNotBatch
+        local version="${RANCHER_VERSION}"
+  	  	if [ -z "${version}" ]
+        then 
+          version="1.3.0"
+          latestversion=$(curl -Ls -o /dev/null -w '%{url_effective}' https://github.com/rancher-sandbox/rancher-desktop/releases/latest | sed 's/.*\([0-9]\.[0-9]\.[0-9]\).*/\1/')
+          doVersionCompare "${latestversion}" "${version}"
+          VersCompRes=${?}
+          if [ "${VersCompRes}" = 1 ]
+          then
+            version=${latestversion}
+          fi
+        fi
+        local rancher_install_dir="${DEVON_IDE_HOME}/updates/install/rancherdesktop"
+        doInstall "-" "${rancher_install_dir}" "rancher" "${version}" 
+        if doIsWindows
+        then
+          doEcho "Installing Rancher Desktop for Windows..."
+          doInstallVpnkit
+          doRunCommand "${rancher_install_dir}/rancher-${version}-windows.exe" 
+        elif doIsMacOs
+        then
+          doRunCommand "cp -a '${rancher_install_dir}'/*.app /Applications/"
+        else
+          doFail "Your OS is not supported currently"
+        fi
+        read -r -p "Rancher Desktop has been installed. Please read https://github.com/devonfw/ide/blob/master/documentation/docker.asciidoc#setup for enabling kubernetes and further important details. Press enter to continue" answer
+      fi
     fi
   else
-    doRequireNotBatch
-    #Start setup
-    local version="${DOCKER_VERSION:-stable}"
-    local code
-    if doIsWindows
+    if doIsDockerInstalled 
     then
-      code="Docker%20Desktop%20Installer"
-    elif doIsMacOs
-    then
-      code="Docker"
+      if [ "${1}" != "silent" ] && ! doIsQuiet
+      then
+        doEcho "docker is already installed at $(command -v docker)"
+        docker version
+      fi
     else
-      doFail "Sorry, docker-installation support is not yet implemented for your OS. Please install manually or help devonfw-ide to support it for your OS by contributing a pull-request."
+      doRequireNotBatch
+      local version="${DOCKER_VERSION:-stable}"
+      local code
+      if doIsWindows
+      then
+        code="Docker%20Desktop%20Installer"
+      elif doIsMacOs
+      then
+        code="Docker"
+      else
+        doFail "Sorry, docker-installation support is not yet implemented for your OS. Please use Rancher Desktop instead, or install manually or help devonfw-ide to support it for your OS by contributing a pull-request."
+      fi
+      doDownload "-" "" "docker" "${version}" "" "${code}"
+      if doIsWindows
+      then
+        doEcho "installing Docker Desktop for Windows..."
+        doRunCommand "${DEVON_DOWNLOAD_DIR}/docker-stable-win.exe"
+      elif doIsMacOs
+      then
+        doEcho "installing Docker Desktop for MacOS..."
+        local mount_dir="${DEVON_IDE_HOME}/updates/volume"
+        mkdir -p "${mount_dir}"
+        doRunCommand "hdiutil attach -quiet -nobrowse -mountpoint '${mount_dir}' '${DEVON_DOWNLOAD_DIR}/Docker.dmg'"
+        doRunCommand "cp -a '${mount_dir}'/*.app /Applications/"
+        doRunCommand "hdiutil detach -force '${mount_dir}'"
+      fi
+      read -r -p "Docker Desktop has been installed. Please read https://github.com/devonfw/ide/blob/master/documentation/docker.asciidoc#setup for enabling kubernetes and further important details. Press enter to continue" answer
     fi
-    doDownload "-" "" "docker" "${version}" "" "${code}"
-    if doIsWindows
-    then
-      doEcho "Installating Docker Desktop for Windows..."
-      doRunCommand "${DEVON_DOWNLOAD_DIR}/docker-stable-win.exe"
-    elif doIsMacOs
-    then
-      doEcho "Installating Docker Desktop for MacOS..."
-      local mount_dir="${DEVON_IDE_HOME}/updates/volume"
-      mkdir -p "${mount_dir}"
-      doRunCommand "hdiutil attach -quiet -nobrowse -mountpoint '${mount_dir}' '${DEVON_DOWNLOAD_DIR}/Docker.dmg'"
-      doRunCommand "cp -a '${mount_dir}'/*.app /Applications/"
-      doRunCommand "hdiutil detach -force '${mount_dir}'"
-    fi
-    read -r -p "Docker Desktop has been installed. Please read https://github.com/devonfw/ide/blob/master/documentation/docker.asciidoc#setup for enabling kubernetes and further important details. Press enter to continue" answer
   fi
 }
 
-# Call Docker with specified arguments.
+
+# Call Docker with specified arguments.   
 function doRun() {
   doSetup silent
   doEcho "Running: docker ${*}"
@@ -72,6 +126,66 @@ function doIsDockerInstalled() {
   fi
 }
 
+#OS independent check if Rancher Desktop is installed.
+function doIsRancherInstalled() {
+    if doIsWindows
+    then
+      touch tmp-res-install-query rd-install-test.ps1
+      # shellcheck disable=SC2016,2028
+      echo 'if($env:Path -like "*Rancher Desktop*") { set-content .\tmp-res-install-query "installed"} else {set-content .\tmp-res-install-query "not"}' > rd-install-test.ps1
+      powershell.exe -Command ".\rd-install-test.ps1"
+      installvar=$(awk 'NR=1' tmp-res-install-query)
+      rm tmp-res-install-query rd-install-test.ps1
+      if [ "${installvar}" = "installed" ]
+      then
+        return 
+      else
+        return 255
+      fi
+    else
+      if command -v rancher-desktop &> /dev/null
+      then
+        return
+      else
+        return 255
+      fi
+    fi
+}
+
+function doInstallVpnkit() {
+  #get latest version of the vpnkit and download its tar.gz file
+  local partialUrl
+  # shellcheck disable=SC1083  
+  partialUrl=$(curl -Ls -o /dev/null -w %{url_effective} https://github.com/sakai135/wsl-vpnkit/releases/latest)
+  local VPNversion=${partialUrl##*/}
+  local downloadUrl="https://github.com/sakai135/wsl-vpnkit/releases/download/${VPNversion}/wsl-vpnkit.tar.gz"
+  curl -fL "${downloadUrl}" -o "wsl-vpnkit.tar.gz"
+
+  #at first write a bash-script
+  touch activate-vpnkit
+  echo '#!/bin/bash' > activate-vpnkit
+  echo 'cd' >> activate-vpnkit
+  echo 'wsl.exe -d wsl-vpnkit service wsl-vpnkit start' >> activate-vpnkit
+  #now write a pwsh-script which also executes the above bash-script in WSL
+  touch vpnkit-setup.ps1
+  #go to needed path by using pushd to be able to get back easily with popd for running the above bash script
+  # shellcheck disable=SC1083,SC2129,SC2016
+  echo 'mv wsl-vpnkit.tar.gz $env:USERPROFILE' >> vpnkit-setup.ps1
+  echo 'echo "between mv and pushd"' >> vpnkit-setup.ps1  
+  # shellcheck disable=SC1083,SC2016
+  echo 'pushd $env:USERPROFILE' >> vpnkit-setup.ps1
+  # shellcheck disable=SC1083,SC2016
+  echo 'wsl --import wsl-vpnkit $env:USERPROFILE\wsl-vpnkit wsl-vpnkit.tar.gz --version 2' >> vpnkit-setup.ps1
+  echo 'wsl -d wsl-vpnkit' >> vpnkit-setup.ps1
+  echo 'popd' >> vpnkit-setup.ps1
+  echo 'wsl.exe bash activate-vpnkit' >> vpnkit-setup.ps1
+
+  #execute the powershell-script directly and the script for inside wsl indirectly
+  powershell.exe -Command ".\vpnkit-setup.ps1"
+  rm activate-vpnkit vpnkit-setup.ps1
+}
+
+
 # CLI
 case ${1} in 
 "help" | "-h")
@@ -80,7 +194,7 @@ case ${1} in
   echo "Arguments:"
   echo " setup                    setup docker on your machine (global installation)."
   echo " «args»                   call docker with the specified arguments. Call docker help for details or use docker directly as preferred."
-  echo
+  echo 
 ;;
 "setup" | "s" | "")
   doSetup setup "${2}"