Skip to content

Commit e9d81fa

Browse files
committed
Updated CONTRIBUTING docs with info on microshift and k3s
After talking with Armel from `odo` and testing a bit more myself, I figured out how to get MicroShift and k3s working with VS Code OpenShift toolkit. The key is to avoid using the default namespace. Signed-off-by: David Thompson <davthomp@redhat.com>
1 parent 05ca618 commit e9d81fa

File tree

1 file changed

+19
-5
lines changed

1 file changed

+19
-5
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -65,11 +65,25 @@ along with the tradeoffs in using them:
6565
- Requires a functioning `docker` or `podman` installation
6666
- Not OpenShift, so it can't be used to test OpenShift-specific features
6767
- Some features require additional commands to set up eg. [dashboard](https://kubernetes.io/docs/tasks/access-application-cluster/web-ui-dashboard/)
68-
69-
Here are some Kubernetes clusters that currently don't work well with VS Code OpenShift Toolkit
70-
(see [this issue on odo](https://github.com/redhat-developer/odo/issues/7032)):
71-
- MicroShift (or crc MicroShift)
72-
- k3s
68+
- **[OpenShift Local with MicroShift](https://crc.dev/crc/getting_started/getting_started/configuring/#_changing_the_selected_preset)**
69+
- Pros:
70+
- More lightweight than regular OpenShift Local
71+
- [Some of the OpenShift features are present](https://github.com/openshift/microshift/blob/main/docs/contributor/enabled_apis.md)
72+
(although Routes don't appear to work as expected)
73+
- No username/password system
74+
- Cons:
75+
- You can't create pods in the default namespace
76+
- Many OpenShift-specific features are not present in order to reduce the memory and CPU usage,
77+
so it can't be used to test OpenShift-specific features
78+
- **[k3s](https://k3s.io/)**
79+
- Pros:
80+
- Much more lightweight than OpenShift Local
81+
- No username/password system
82+
- Cons:
83+
- You can't create pods in the default namespace
84+
- It doesn't set your kube context to point to the cluster,
85+
you must set it up yourself by copying the one it creates in a separate kube config
86+
- Not OpenShift, so it can't be used to test OpenShift-specific features
7387

7488
## Run and debug the extension locally
7589

0 commit comments

Comments
 (0)