Skip to content

Commit 646abbc

Browse files
authored
Add Cluster Prerequisites to README (#68)
* Add cluster prerequisites * Fix typo
1 parent 20fbba4 commit 646abbc

File tree

1 file changed

+10
-1
lines changed

1 file changed

+10
-1
lines changed

README.md

+10-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,16 @@ There are three charts:
66

77
* `theia-cloud-base` installs cluster wide resources that may be used by multiple Theia Cloud installations
88
* `theia-cloud-crds` installs the custom resource definitions
9-
* `theia-cloud` installs Theia Cloud itself and depends on `theia-cloud-base` and `theia-cloud-cds`
9+
* `theia-cloud` installs Theia Cloud itself and depends on `theia-cloud-base` and `theia-cloud-crds`
10+
11+
## Cluster Prerequisites
12+
The charts depend on well-established software in the Kubernetes ecosystem. Please make sure to install the dependencies before releasing with _helm_.
13+
14+
* **cert-manager.io** is used for certificate management, supports internal/testing issuers and supports Let's Encrypt certificates. Installation instructions can be found [here](https://cert-manager.io), a helm chart [here](https://cert-manager.io/docs/installation/helm/).
15+
16+
* **ingress-nginx** is used to performantly assemble _nginx_ configuration files and synchronizes changes. Learn more about it [here](https://kubernetes.github.io/ingress-nginx/).
17+
18+
You can find more information in the official [Theia Cloud documentation](https://theia-cloud.io/documentation/setuptheiacloud/).
1019

1120
## Versioning
1221

0 commit comments

Comments
 (0)