#584: docker + k8s: improved windows and added mac support #593

hohwille · 2021-07-08T22:12:54Z

For #584 (docker & kubernetes support) I improved Windows support and added MacOS support.

aligned with conventions, removed trailing spaces, fixed bugs, etc.

WSL output is localised, may contain NUL char and gets garbaged, exit code is the only reliable way to check

hohwille · 2021-07-08T22:35:22Z

When I test this on windows it is still not working:

$ devon docker setup
Installing Docker on WSL...
DEVON_IDE_HOME variable set to /mnt/d/projects/test
Hint:You may be required to enter sudo user password of your Windows Subsystem for Linux(WSL) when prompted.
Installing Docker...

We trust you have received the usual lecture from the local System Administrator. It usually boils down to these three things:

   #1) Repsect the privacy of others.
   #2) Think before you type.
   #3) With great power comes great responsibility.

Then nothing happens. The process is stalled forever.
So IMHO all is still not working and we are not where we want to be.

BTW: I have choosen Debian as Linux Distribution in case that matters.

hohwille · 2021-07-08T22:58:14Z

BTW: I have choosen Debian as Linux Distribution in case that matters.

LOL. Indeed this was the problem. Nowhere in the devonfw-ide documentation is stated which linux distribution is required.
In the provided URL from microsoft it says:

Open the Microsoft Store and select your favorite Linux distribution.

However, I now digged in the code again and found this:

ide/scripts/src/main/resources/scripts/setup-docker

Line 10 in 0d89a96

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

So actually the implementation only works for ubuntu.

I thought I had been very pickly already in my reviews. Now, I regret that we have already merged this incomplete feature onto master.
Remaining questions:

Should we detect the linux distribution and support all major linux distros?
Or if we only support ubuntu, we need to document this properly and also we need to verify this AND in case that a WSL2 user already has other linux installed alongside, we would need to find a way to ensure that we run wsl in ubuntu and not any of the other distros. So in the end this option does not seem any easier to me.

SchettlerKoehler · 2021-07-09T04:59:45Z

scripts/src/main/resources/scripts/functions

+  else
+    error="WSL 2 is disabled or no linux distributions found in WSL.\nPlease ensure WSL is enabled and a proper linux distribution is installed in WSL."
+  fi
+  doFail "${error}\nTo fix this follow these instructions:\nhttps://docs.microsoft.com/en-us/windows/wsl/install-win10"


I think it would be better to use the short link here. The content will be displayed in the user's language and the link does not beak when MS restructures the docs. https://aka.ms/wsl2-install

@SchettlerKoehler thanks for this feedback.
However, this PR is about the MacOS support so I will not include further windows changes here and better get this merged now.
For windows I will create another PR immediately after merge but there I will entirely remove this and go to Docker Desktop instead what makes that link to MS obsolete. In case we should decide against this PR and Docker Desktop for Windows we should do what you suggested. You can also edit the URL in the browser on github and create a PR from that with 2 clicks if you fear that this change might be forgotten or lost.

SchettlerKoehler · 2021-07-09T05:02:14Z

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

+      arch="$(uname -m)"
+      if [ "${arch}" = "x86_64" ]
+      then
+        downloadUrl="https://desktop.docker.com/mac/stable/amd64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-mac-amd64"


I think you can just us https://desktop.docker.com/mac/stable/amd64/Docker.dmg
The parameters are just google analytics tracking parameters

Excellent feedback. 👍 GET parameters removed.

SchettlerKoehler · 2021-07-09T05:02:40Z

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

-          # Install Docker on WSL
-          wsl bash ../scripts/setup-docker
-        fi        
+        downloadUrl="https://desktop.docker.com/mac/stable/arm64/Docker.dmg?utm_source=docker&utm_medium=webreferral&utm_campaign=docs-driven-download-mac-arm64"


maybeec · 2021-07-09T06:00:44Z

I feel we should support Debian and Ubuntu, nothing more. These are the most often used ones by users, especially windows users, who most often just know these distributions. For sure we can wait for contributions to support more if there are people who want to support more.
Nevertheless, I fully agree that we have to make it transparent. I would propose that we implement kind of a wsl adapter which checks for the current distribution installed. If a distribution is not supported, it should give a proper error message if trying to execute any command on wsl

isandesh1986 · 2021-07-09T06:44:16Z

BTW: I have choosen Debian as Linux Distribution in case that matters.

LOL. Indeed this was the problem. Nowhere in the devonfw-ide documentation is stated which linux distribution is required.
In the provided URL from microsoft it says:

Open the Microsoft Store and select your favorite Linux distribution.

However, I now digged in the code again and found this:

ide/scripts/src/main/resources/scripts/setup-docker

Line 10 in 0d89a96

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

So actually the implementation only works for ubuntu.

I thought I had been very pickly already in my reviews. Now, I regret that we have already merged this incomplete feature onto master.
Remaining questions:

Should we detect the linux distribution and support all major linux distros?

Or if we only support ubuntu, we need to document this properly and also we need to verify this AND in case that a WSL2 user already has other linux installed alongside, we would need to find a way to ensure that we run wsl in ubuntu and not any of the other distros. So in the end this option does not seem any easier to me.

I think we should go with the 2nd one - mentioning in our documentation that we are supporting only these distros rather than not mentioning anything which gives the impression that it should work in any distro.

isandesh1986 · 2021-07-09T07:42:45Z

BTW: I have choosen Debian as Linux Distribution in case that matters.

LOL. Indeed this was the problem. Nowhere in the devonfw-ide documentation is stated which linux distribution is required.
In the provided URL from microsoft it says:

Open the Microsoft Store and select your favorite Linux distribution.

However, I now digged in the code again and found this:

ide/scripts/src/main/resources/scripts/setup-docker

Line 10 in 0d89a96

curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo apt-key add -

So actually the implementation only works for ubuntu.
I thought I had been very pickly already in my reviews. Now, I regret that we have already merged this incomplete feature onto master.
Remaining questions:

Should we detect the linux distribution and support all major linux distros?

Or if we only support ubuntu, we need to document this properly and also we need to verify this AND in case that a WSL2 user already has other linux installed alongside, we would need to find a way to ensure that we run wsl in ubuntu and not any of the other distros. So in the end this option does not seem any easier to me.

I think we should go with the 2nd one - mentioning in our documentation that we are supporting only these distros rather than not mentioning anything which gives the impression that it should work in any distro.

Just FYI:- We used the instructions from one of the 1000kit guides
https://1000kit.gitlab.io/guides/docs/dev-environment/wsl2-pure/#docker

hohwille · 2021-07-09T08:03:28Z

I will evaluate Docker Desktop for Windows as I feel we are pointlessly reinventing the wheel here. Feedback will follow.

isandesh1986 · 2021-07-09T08:29:46Z

I will evaluate Docker Desktop for Windows as I feel we are pointlessly reinventing the wheel here. Feedback will follow.

If DockerDesktop is installed on Windows - its anyways accessible from the WSL.

hohwille · 2021-07-09T13:51:21Z

I tested the Docker Desktop installation on Windows:

It works like a charm
It comes with a GUI installer that leads you through the required steps
At the end you have WSL2 properly setup
Also you get native docker and kubectl Commands that are directly available in your windows path and can be used in CMD and git-bash without prefixing via WSL.
For Kubernetes support to work properly you once have to do an additional step: inside Docker Desktop go to the settings then choose Kubernetes and check "Enable Kubernetes". That is all.
Docker Desktop gives the end user the same UX on all major OS: Linux, MacOS, and Windows.

Is there any rationale why we should not simply use Docker Desktop and reinvent the wheel?
My doubts are that with our handmade scripts it will take us > 1/2 year to get this production ready and work on all OS without users getting lost in space what is all already solved with Docker Desktop.

hohwille · 2021-07-09T13:56:44Z

FYI: When I run wsl -l I now get 2 additional distros:

docker-desktop-data
docker-desktop

This does not interfere with any other WSL distro already installed and always uses the correct WSL distro.
All this is currently not functional with our current approach...

hohwille · 2021-07-09T14:00:17Z

Also for the record: My test laptop has only 8GB of memory. With kubernetes enabled and all running it shows that 6 GB are used. That is significant but IMHO not much overhead from Docker Desktop at all.

hohwille added 4 commits July 8, 2021 18:57

#584: preparation and cleanup

b0843aa

aligned with conventions, removed trailing spaces, fixed bugs, etc.

#584: fixed newline

a542ef7

#584: fixed WSL check

54094f0

WSL output is localised, may contain NUL char and gets garbaged, exit code is the only reliable way to check

#584: improved win, added mac

52be630

hohwille added enhancement New feature or request software software-package with 3rd party products commandlet related to commandlets (scripts/command/*) setup related to the setup process of devonfw-ide (setup[.bat] and devon ... setup) labels Jul 8, 2021

hohwille added this to the release:2021.04.002 milestone Jul 8, 2021

hohwille added macOS specific for Apple MacOS windows specific for Microsoft Windows OS labels Jul 8, 2021

#584: fixed stupid bug

5c4cf8e

hohwille linked an issue Jul 8, 2021 that may be closed by this pull request

add commandlets for docker and kubernetes #584

Closed

#584: another stupid bug - thanks to shellcheck

20ccb00

SchettlerKoehler reviewed Jul 9, 2021

View reviewed changes

#584: removed analytics get params (review)

e706de5

hohwille and others added 2 commits July 12, 2021 12:01

#584: renamed kubernetes cmd to kubectl

4fdf288

Merge branch 'master' into feature/584-docker-k8s-mac

862c0e5

hohwille merged commit 22cb583 into devonfw:master Jul 13, 2021

hohwille mentioned this pull request Jul 13, 2021

add commandlets for docker and kubernetes #584

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#584: docker + k8s: improved windows and added mac support #593

#584: docker + k8s: improved windows and added mac support #593

hohwille commented Jul 8, 2021

hohwille commented Jul 8, 2021 •

edited

Loading

hohwille commented Jul 8, 2021

SchettlerKoehler Jul 9, 2021

hohwille Jul 13, 2021

SchettlerKoehler Jul 9, 2021

hohwille Jul 9, 2021

SchettlerKoehler Jul 9, 2021

hohwille Jul 9, 2021

maybeec commented Jul 9, 2021

isandesh1986 commented Jul 9, 2021

isandesh1986 commented Jul 9, 2021 •

edited

Loading

hohwille commented Jul 9, 2021

isandesh1986 commented Jul 9, 2021

hohwille commented Jul 9, 2021 •

edited

Loading

hohwille commented Jul 9, 2021

hohwille commented Jul 9, 2021

#584: docker + k8s: improved windows and added mac support #593

#584: docker + k8s: improved windows and added mac support #593

Conversation

hohwille commented Jul 8, 2021

hohwille commented Jul 8, 2021 • edited Loading

hohwille commented Jul 8, 2021

SchettlerKoehler Jul 9, 2021

Choose a reason for hiding this comment

hohwille Jul 13, 2021

Choose a reason for hiding this comment

SchettlerKoehler Jul 9, 2021

Choose a reason for hiding this comment

hohwille Jul 9, 2021

Choose a reason for hiding this comment

SchettlerKoehler Jul 9, 2021

Choose a reason for hiding this comment

hohwille Jul 9, 2021

Choose a reason for hiding this comment

maybeec commented Jul 9, 2021

isandesh1986 commented Jul 9, 2021

isandesh1986 commented Jul 9, 2021 • edited Loading

hohwille commented Jul 9, 2021

isandesh1986 commented Jul 9, 2021

hohwille commented Jul 9, 2021 • edited Loading

hohwille commented Jul 9, 2021

hohwille commented Jul 9, 2021

hohwille commented Jul 8, 2021 •

edited

Loading

isandesh1986 commented Jul 9, 2021 •

edited

Loading

hohwille commented Jul 9, 2021 •

edited

Loading