Clarify Docker installation #1038
Conversation
And also fix some trailing whitespace. We previously recommended a Docker Desktop installation with Hyper-V. This is presumably because: * Docker Toolbox was not as polished * WSL2 was still new, at the time of writing (late 2020) Advantages to the changes here: * we remove the mention of Docker Toolbox, which is now deprecated * WSL2 works on Windows Home editions * there's no confusion over our guidance saying "use Hyper-V" and Docker Desktop's installer saying "use WSL2"
Deploying with
|
| Latest commit: |
cf20c57
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4b17107f.opensafely-docs.pages.dev |
| Branch Preview URL: | https://steve-clarify-docker-install.opensafely-docs.pages.dev |
|
The caveat here is that I haven't got a Windows install to test WSL2 with. I assume it works because it's the recommended default for Docker Desktop on Windows, and I don't believe we're doing anything particularly exotic in Windows. One thing is that Windows 10 doesn't directly support GUI apps via WSL2. Windows 11 does. But I don't think that is likely to affect us. If it is, I can reword to still just suggesting Hyper-V. |
| !!! note | ||
| We previously recommended Docker Desktop with the Hyper-V backend. | ||
|
|
||
| Windows users who log into an Active Directory domain (i.e., a network login) may find they lack permissions to start Docker correctly. | ||
| If so, [follow these instructions](https://github.com/docker/for-win/issues/785#issuecomment-344805180). | ||
| It is best to install using the default settings. | ||
| Docker Desktop's recommended configuration is now the WSL2 backend. | ||
| We have not thoroughly tested OpenSAFELY with WSL2, | ||
| but there is no reason why WSL2 should be incompatible with OpenSAFELY's tooling. | ||
|
|
||
| You may be asked to enable the Hyper-V and Containers features, which you should do. | ||
| You can do this by [following these instructions](https://docs.microsoft.com/en-us/virtualization/hyper-v-on-windows/quick-start/enable-hyper-v). | ||
| You only need to choose either Hyper-V or WSL2. | ||
| It is fine to continue to use the Hyper-V backend. |
There was a problem hiding this comment.
As a reader, this makes me nervous. The Docker people say "WSL2". The OpenSAFELY people say "WSL2, but we haven't tested it, and Hyper-V is fine".
Could we (as OpenSAFELY people) commit to WSL2, and keep a very close eye out for issues?
There was a problem hiding this comment.
Could we (as OpenSAFELY people) commit to WSL2, and keep a very close eye out for issues?
This is probably the right thing to do seeing as that's where Docker looks to be headed.
I'd be happier if a friendly Windows user could test WSL2 so that we know it does work. (I don't expect that it won't. But confirmation would be great ✔️)
I don't have a native Windows install to test with, unfortunately.
Fixes #191.
And also fix some trailing whitespace.
We previously recommended a Docker Desktop installation with Hyper-V.
This is presumably because:
Advantages to the changes here: