docs: add WSL2 + Docker Desktop setup guide for running KubeEdge on Windows#801
docs: add WSL2 + Docker Desktop setup guide for running KubeEdge on Windows#801Gurkaran18 wants to merge 3 commits into
Conversation
Add a comprehensive guide covering all six WSL2-specific requirements that must be satisfied before EdgeCore can run inside WSL2 with Docker Desktop: 1. Enabling systemd (not active by default in WSL2) 2. Installing native containerd (Docker Desktop's containerd is not accessible at the expected socket path) 3. Setting cgroupDriver to systemd (WSL2 uses cgroupv2) 4. Disabling swap validation (WSL2 has swap enabled by default) 5. Installing CNI plugins manually (not included in keadm quickstart) 6. Installing iptables (not pre-installed on WSL2 Ubuntu 22.04+) Also adds a Chinese locale mirror to satisfy the Docusaurus i18n build. Signed-off-by: Gurkaran Singh <gurkaranbirsingh@example.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
There was a problem hiding this comment.
Code Review
This pull request introduces a new documentation guide for running KubeEdge on Windows using WSL2 and Docker Desktop, including both English and Chinese versions. The guide outlines essential configuration steps such as enabling systemd, installing containerd, and configuring CNI plugins. The review feedback suggests improving maintainability by using variables for the CNI plugin version instead of hardcoding it in both the English and Chinese documentation files.
Signed-off-by: Gurkaran Singh <gurkaranbirsingh@example.com>
|
Hi maintainers! I investigated the Netlify build failure and wanted to clarify: The 4 failing Netlify checks are caused by pre-existing broken links in i18n/zh/...advanced/cloudcore-logs.md (missing zh mirrors for debug.md, install-with-keadm.md, config.md, and faq/setup.md). These broken links exist on master and are not introduced by this PR. The WSL2 guide files added in this PR are clean — I confirmed by running a local yarn build with only the cloudcore-logs errors appearing (same as master baseline). Would it be okay to proceed with merging, or would you like me to fix the pre-existing cloudcore-logs broken links in a separate PR? |
Signed-off-by: Gurkaran Singh <gurkaranbirsingh@example.com>
fujitatomoya
left a comment
There was a problem hiding this comment.
i am not necessarily against this documentation. but i would suggest to move this doc under https://github.com/kubeedge/website/tree/master/blog at this moment, instead of official documentation setup procedure with a couple of reasons.
- for real situation, it is highly likely that business developers use linux based platform instead of windows WSL environment.
- without having the CI/CD pipleline for WSL, it is so easy to break and generate the gap between official documentation and what user can do. especially on this point, i would recommend to move this doc under blog as community support section.
What type of PR is this?
/kind documentation
What this PR does / why we need it:
I went through the issue carefully and noticed that there's currently no
documentation for setting up KubeEdge on Windows using WSL2 + Docker Desktop,
which is a really common environment for students and developers who don't have
a dedicated Linux machine.
This PR adds a new guide at
docs/setup/wsl2-docker-desktop.mdthat coversall six undocumented failure points mentioned in the issue:
is not accessible from within WSL2 at the expected socket path)
defaults to cgroupfs)
get stuck in ContainerCreating silently)
Each step includes the exact commands to run and also explains what symptom
you'll see if you skip that step, so it's useful both for initial setup and
for debugging.
I also added a Chinese locale mirror file under
i18n/zh/to make sure theDocusaurus build doesn't fail.
Which issue(s) this PR fixes:
Fixes #797
Special notes for reviewer:
Only 2 new files added, no existing files modified. All commands were taken
directly from the verified steps documented in the original issue report.
Does this PR introduce a user-facing change?:
Yes — adds a new setup guide for Windows developers using WSL2 + Docker Desktop.