Skip to content

Commit e58a3f2

Browse files
*: Document development in WSL2 (thanos-io#5927)
* Document development in WSL2 Signed-off-by: Douglas Camata <[email protected]> * Fix docs lint Signed-off-by: Douglas Camata <[email protected]> Signed-off-by: Douglas Camata <[email protected]>
1 parent 368765e commit e58a3f2

File tree

1 file changed

+5
-1
lines changed

1 file changed

+5
-1
lines changed

CONTRIBUTING.md

+5-1
Original file line numberDiff line numberDiff line change
@@ -66,10 +66,14 @@ The following section explains various suggestions and procedures to note during
6666

6767
### Prerequisites
6868

69-
* It is strongly recommended that you use Linux distributions systems or OSX for development.
69+
* It is strongly recommended that you use Linux distributions systems or macOS for development.
70+
* Running [WSL 2 (on Windows)](https://learn.microsoft.com/en-us/windows/wsl/) is also possible. Note that if during development you run a local Kubernetes cluster and have a Service with `service.spec.sessionAffinity: ClientIP`, it will break things until it's removed[^windows_xt_recent].
7071
* Go 1.19.x or higher.
72+
* Docker (to run e2e tests)
7173
* For React UI, you will need a working NodeJS environment and the npm package manager to compile the Web UI assets.
7274

75+
[^windows_xt_recent]: A WSL 2 kernel recompilation is required to enable the `xt_recent` kernel module, used by `iptables` in `kube-proxy` to implement ClientIP session affinity. See [issue in WSL](https://github.com/microsoft/WSL/issues/7124).
76+
7377
### First Steps
7478

7579
It's key to get familiarized with the style guide and mechanics of Thanos, especially if your contribution touches more than one component of the Thanos distributed system. We recommend:

0 commit comments

Comments
 (0)