You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I added some things in the contributing documentation
that I realized we didn't cover well after we onboarded Victor to the
project.
Notably:
- Note that the Red Hat Authentication extension is required by VS Code
OpenShift Toolkit
- Explain that different commands are used to run the different suites,
and explain why the suites are split up
- List the different types of clusters that have been well tested
with the extension, and the tradeoffs of using them
Signed-off-by: David Thompson <davthomp@redhat.com>
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+55Lines changed: 55 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,7 @@ There are only a few guidelines that we need contributors to follow.
11
11
*[Node.js](https://nodejs.org/) v16.17.0 or higher
12
12
* It is recommended to set up `nvm` to manage different versions of node, which can be installed by following the instructions [here](https://github.com/nvm-sh/nvm#installing-and-updating).
13
13
* To use the current recommended version for this project (in`./nvmrc`), run `nvm use`.
14
+
*[Red Hat Authentication](https://marketplace.visualstudio.com/items?itemName=redhat.vscode-redhat-account) VS Code plugin (VS Code will prompt to install this when you launch the extension if you don't have it)
14
15
15
16
2. Fork and clone the repository
16
17
3.`cd vscode-openshift-tools`
@@ -21,6 +22,55 @@ There are only a few guidelines that we need contributors to follow.
21
22
```
22
23
5. Open the folder in VS Code
23
24
25
+
## Getting a cluster to use with the extension
26
+
27
+
In order to use many of the features of the extension,
28
+
you will need an OpenShift or Kubernetes cluster.
29
+
Here is a list of the clusters that are known to work well with the extension,
- The binary used to set up the cluster is bundled in VS Code OpenShift Toolkit
36
+
- Cons:
37
+
- Requires a lot of disk space, memory, and CPU
38
+
- Takes a while to start up
39
+
- Some Operators that are set up on OpenShift Dev Sandbox by default are not present on the cluster
40
+
- You might need to [tweak the settings in order to allocate more RAM](https://crc.dev/crc/getting_started/getting_started/configuring/#_configuring_the_instance) to the cluster in order to get it working
41
+
-**[OpenShift Dev Sandbox](https://developers.redhat.com/developer-sandbox)**
42
+
- Pros:
43
+
- Fully featured OpenShift cluster
44
+
- High availability
45
+
- Doesn't run on your computer
46
+
- Many of the Operators you need are installed by default
47
+
- You can expose applications deployed to the cluster publicly
48
+
- Cons:
49
+
- Free trial that ends after 30 days, after which you must pay or your cluster gets wiped
50
+
- No admin access
51
+
- You can only access one namespace
52
+
- Logging in to the cluster is a bit more involved than with a local cluster
0 commit comments