Add WSL2 instructions #807
Conversation
Man, this had me tearing out my hair! I saw a lot of complaints in the forums while searching as well.
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
|
Added full reset instructions to begin anew, quick setup instructions, enumerated minimum dependencies, and everything should be good to go factually. It's now a matter of how to present the information. |
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
Co-authored-by: Franck Nijhof <[email protected]>
|
I already gave feedback on that above. |
|
I'm ok with this PR (language/content-wise). However, as said, I'm the proud owner of no-Windows enabled machines for 13 years already. The factual content has to be verified and approved by someone else. |
|
Does this still need to be reviewed? |
|
Yes. |
WalkthroughWalkthroughThe Documentation for developing the Supervisor has been revamped to include comprehensive guidelines on setting up the development environment. This includes instructions for configuring Windows WSL2, installing essential tools such as NVM, Node, Yarn, and Docker, and setting up Visual Studio Code to run and test the Supervisor and Home Assistant within a Debian environment on WSL2. Changes
Sequence DiagramsNo sequence diagrams are necessary for these documentation-specific changes. Recent review detailsConfiguration used: CodeRabbit UI Files selected for processing (1)
Additional context usedLanguageTool
Markdownlint
Gitleaks
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (invoked as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
|
|
||
| :::tip | ||
| Always run scripts line by line to figure out where the problem lies. If you need to completely start over, you can uninstall the Debian app, then from the Windows command prompt execute `del %HOMEPATH%\AppData\Roaming\Code`. After removing your VSCode settings, launch VS Code, and remove all extensions. Finally either execute `net stop LxssManager` from an administrative `cmd` prompt or reboot your computer and try again. | ||
| ::: |
There was a problem hiding this comment.
This looks like a really brute force kill all your setting approach. This will break other things in your system. I really don't want to promote such actions.
There was a problem hiding this comment.
This is a full reset to stock.
There was a problem hiding this comment.
What do you recommend?
There was a problem hiding this comment.
breaking peoples vscode setups is not acceptable.
| curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - #Add yarn repo certificate | ||
| echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list #Add Yarn repo | ||
| sudo apt update; sudo apt install yarn -y; #Install yarn | ||
| curl -fsSL https://get.docker.com |sudo bash #install docker Community Edition |
There was a problem hiding this comment.
This looks weird. Why is docker installed inside wsl. Any docker instance on windows is fully accessable from inside wsl instances.
It should be installed the official way in windows. Can you explain why that does not work?
Ps. Never done any supervisor development, so i might miss something.
There was a problem hiding this comment.
So that you can use the command line tools.
There was a problem hiding this comment.
Docker works inside wsl2 by default. Standard desktop install will inject the cli commands into your wsl2 images
There was a problem hiding this comment.
This is a new feature. Will verify if this is the case with Rancher Desktop. I shouldn't recommend installing Docker Desktop. https://www.suse.com/c/rancher_blog/using-rancher-desktop-for-local-kubernetes-development/#:~:text=Unlike%20Docker%E2%80%99s%20product%2C%20however%2C%20Rancher%20Desktop%20is%20a%20free%20and%20open%20source%20solution%20developed%20by%20SUSE
There was a problem hiding this comment.
Sure enough. Good catch! I created a new instance of Ubuntu Preview and enabled in Settings->WSL->Integrations. Docker was running immediately. I can work with this.
Will get the system operational with this new guidance. But probably this weekend.
| sudo mount -t cgroup -o none,name=systemd cgroup /sys/fs/cgroup/systemd | ||
| sudo service docker start | ||
| code | ||
| ``` |
There was a problem hiding this comment.
If stuff like this is needed, this instruction should really not use the standard wsl instance since it will break normal wsl uses.
There was a problem hiding this comment.
This was required for wsl1
There was a problem hiding this comment.
Planning to do an integration coming soon. I'll be able to update for WSL 2
|
Please take a look at the requested changes, and use the Ready for review button when you are done, thanks 👍 |
Man, this had me tearing out my hair! I saw a lot of complaints in the forums while searching as well.
Proposed change
Type of change
Additional information
Summary by CodeRabbit