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

docs: Windows(WSL2) installation #21542

Open
arukiidou opened this issue Oct 1, 2022 · 4 comments
Open

docs: Windows(WSL2) installation #21542

arukiidou opened this issue Oct 1, 2022 · 4 comments
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. good-first-issue Good starting point for new developers, which requires minimal understanding of Cilium. help-wanted Please volunteer for this by adding yourself as an assignee! kind/feature This introduces new functionality. sig/agent Cilium agent related.

Comments

@arukiidou
Copy link

arukiidou commented Oct 1, 2022

Cilium Feature Proposal

Add instructions for Windows(WSL2) to the kind installation docs.
I would like to contribute to the cilium docs,but I do not have enough bandwidth now.

Background

  • Cilium cannot be install out of the box with Windows(WSL2).
    • Windows (WSL2) does not have kernel features to run cilium

Goals

  • Documentation
    • Restrictions when using Windows (WSL2)
    • Additional installation steps (custom kernel) for Windows(WSL2)

Non-goals

  • Using Windows (WSL2) for production use
  • Using "Windows Container"

Expected Effects

  • Expansion of the cilium user base, developer who only have Windows
    • There are many hobby, evaluation and training developers

Is your feature request related to a problem?

@arukiidou arukiidou added the kind/feature This introduces new functionality. label Oct 1, 2022
@arukiidou arukiidou changed the title docs: Add instructions for windows(wsl2)-kind to the kind installation docs docs: Add instructions for windows(wsl2) to the kind installation docs Oct 1, 2022
@joestringer joestringer added the help-wanted Please volunteer for this by adding yourself as an assignee! label Oct 4, 2022
@arukiidou arukiidou changed the title docs: Add instructions for windows(wsl2) to the kind installation docs docs: kind with windows(wsl2) installation Oct 6, 2022
@aanm aanm added area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. good-first-issue Good starting point for new developers, which requires minimal understanding of Cilium. sig/agent Cilium agent related. labels Nov 8, 2022
@ShivangShandilya
Copy link

ShivangShandilya commented Jan 10, 2023

Can you please elaborate on this issue @arukiidou 😄.

@arukiidou
Copy link
Author

@ShivangShandilya
Updated the description a bit.

@arukiidou arukiidou changed the title docs: kind with windows(wsl2) installation docs: kind with Windows(WSL2) installation Jan 11, 2023
@arukiidou arukiidou changed the title docs: kind with Windows(WSL2) installation docs: Windows(WSL2) installation Jan 11, 2023
@ShivangShandilya
Copy link

so basically we have to update the documentation by telling the user how to add cilium on WSL2 and what are its restrictions right??

@HummingMind
Copy link

HummingMind commented Jun 20, 2023

There is a nice guide here, but yes, there should be some official guidance on this in the Cilium docs. A lot of developers are using Windows 11 with WSL2 and Docker with Kind/K3d for K8S for their dev workflow.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Impacts the documentation, including textual changes, sphinx, or other doc generation code. good-first-issue Good starting point for new developers, which requires minimal understanding of Cilium. help-wanted Please volunteer for this by adding yourself as an assignee! kind/feature This introduces new functionality. sig/agent Cilium agent related.
Projects
Status: No status
Development

No branches or pull requests

5 participants