Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update Windows docs for WSL2 #2816

Merged
merged 4 commits into from
Jun 11, 2020
Merged

Update Windows docs for WSL2 #2816

merged 4 commits into from
Jun 11, 2020

Conversation

kiview
Copy link
Member

@kiview kiview commented May 29, 2020

This will fix the incompatibility of Docker with WSL2 backend with outdated images.

Not 100% sure what is the actual problem, but pulling the old images resulted in the following warning:

Image docker.io/library/rabbitmq:3.5.4 uses outdated schema1 manifest format. Please upgrade to a schema2 image for better future compatibility. More information at https://docs.docker.com/registry/spec/deprecated-schema-v1/

This will fix incompatibility of Docker with WSL2 backend with outdated images.
Also add section about WSL2 to docs.
@kiview kiview marked this pull request as ready for review May 29, 2020 22:02

WSL2 should work out of the box.

However, we have observed some problems using Docker for Windows with WSL2 backend with regards to very old images from the Docker Hub that would not start, so some caution when upgrading might be in order.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should be clearer to give people confidence: either we should work out why these old images aren't working and declare a specific limitation, or tell people what to look out for (or both!)

We should probably also attach a 'beta' label to WSL2 compatibility.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep, both sounds good.
I am also confident that we might fight a corresponding issue in Docker or WSL repo somewhere that we can reference.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See the last comment for the reason of the images failing. I will update docs accordingly.

@kiview
Copy link
Member Author

kiview commented May 30, 2020

After digging a little bit deeper into the issue with the old images, I found out it is related to this WSL issue with regards to support for vsyscall linking.

The preferred workaround seems to be, to enable vsyscall emulation in the wsl2 config ($USERDIR\.wslconfig):

[wsl2]
kernelCommandLine = vsyscall=emulate # Make old Docker images work  

@kiview kiview changed the title Make tests compatible with WSL2 Update Windows docs for WSL2 May 30, 2020
@rnorth rnorth merged commit 5566597 into master Jun 11, 2020
@rnorth rnorth deleted the wsl2 branch June 11, 2020 12:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants