Skip to content

Commit 0a62ede

Browse files
jfaltermeierjfaltermeier
committed
Add Readme Generation Template to include tested helm version
1 parent 7d2c586 commit 0a62ede

File tree

6 files changed

+76
-2
lines changed

6 files changed

+76
-2
lines changed

‎charts/theia-cloud-base/README.md

+4-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# theia-cloud-base
22

3-
![Version: 1.1.0-next.0](https://img.shields.io/badge/Version-1.1.0--next.0-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0-next](https://img.shields.io/badge/AppVersion-1.1.0--next-informational?style=flat-square)
3+
![Version: 1.1.0-next.1](https://img.shields.io/badge/Version-1.1.0--next.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0-next](https://img.shields.io/badge/AppVersion-1.1.0--next-informational?style=flat-square)
44

55
Theia-cloud base chart
66

7+
*This chart was tested with Helm version v3.17.0.*
8+
*Other versions may work as well, but if you encounter any issues, we recommend trying with the tested version to rule out version-specific problems.*
9+
710
## Values
811

912
| Key | Type | Default | Description |

‎charts/theia-cloud-base/README.md.gotmpl

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{{ template "chart.header" . }}
2+
{{ template "chart.deprecationWarning" . }}
3+
4+
{{ template "chart.badgesSection" . }}
5+
6+
{{ template "chart.description" . }}
7+
8+
*This chart was tested with Helm version v3.17.0.*
9+
*Other versions may work as well, but if you encounter any issues, we recommend trying with the tested version to rule out version-specific problems.*
10+
11+
{{ template "chart.homepageLine" . }}
12+
13+
{{ template "chart.maintainersSection" . }}
14+
15+
{{ template "chart.sourcesSection" . }}
16+
17+
{{ template "chart.requirementsSection" . }}
18+
19+
{{ template "chart.valuesSection" . }}
20+
21+
{{ template "helm-docs.versionFooter" . }}

‎charts/theia-cloud-crds/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@
44

55
A Helm chart for the custom resource definitions (CRDs) of Theia Cloud
66

7+
*This chart was tested with Helm version v3.17.0.*
8+
*Other versions may work as well, but if you encounter any issues, we recommend trying with the tested version to rule out version-specific problems.*
9+
710
## Values
811

912
| Key | Type | Default | Description |

‎charts/theia-cloud-crds/README.md.gotmpl

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{{ template "chart.header" . }}
2+
{{ template "chart.deprecationWarning" . }}
3+
4+
{{ template "chart.badgesSection" . }}
5+
6+
{{ template "chart.description" . }}
7+
8+
*This chart was tested with Helm version v3.17.0.*
9+
*Other versions may work as well, but if you encounter any issues, we recommend trying with the tested version to rule out version-specific problems.*
10+
11+
{{ template "chart.homepageLine" . }}
12+
13+
{{ template "chart.maintainersSection" . }}
14+
15+
{{ template "chart.sourcesSection" . }}
16+
17+
{{ template "chart.requirementsSection" . }}
18+
19+
{{ template "chart.valuesSection" . }}
20+
21+
{{ template "helm-docs.versionFooter" . }}

‎charts/theia-cloud/README.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
# theia-cloud
22

3-
![Version: 1.1.0-next.1](https://img.shields.io/badge/Version-1.1.0--next.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0-next](https://img.shields.io/badge/AppVersion-1.1.0--next-informational?style=flat-square)
3+
![Version: 1.1.0-next.3](https://img.shields.io/badge/Version-1.1.0--next.3-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.1.0-next](https://img.shields.io/badge/AppVersion-1.1.0--next-informational?style=flat-square)
44

55
A Helm chart for Theia Cloud
66

7+
*This chart was tested with Helm version v3.17.0.*
8+
*Other versions may work as well, but if you encounter any issues, we recommend trying with the tested version to rule out version-specific problems.*
9+
710
## Values
811

912
| Key | Type | Default | Description |
@@ -56,6 +59,7 @@ A Helm chart for Theia Cloud
5659
| landingPage.additionalApps | string | `nil` | The page may show these additional apps in a drop down. This is a map. The key maps to the app definition name The value is the label that is supposed to be shown in the UI Example: different-app-definition: label: "Different App Definition" further-app-definition: label: "Further App Definition" |
5760
| landingPage.appDefinition | string | `"theia-cloud-demo"` | the app id to launch |
5861
| landingPage.disableInfo | bool | `false` | Should showing info title and text below the launch button be disabled true hides the info title and text false shows the info title and text |
62+
| landingPage.enabled | bool | `true` | Whether the landing page shall be enabled |
5963
| landingPage.ephemeralStorage | bool | `true` | If set to true no persisted storage is used when creating sessions on the landing page. Set to false if you want to use persisted storage. |
6064
| landingPage.image | string | `"theiacloud/theia-cloud-landing-page:1.1.0-next"` | the landing page image to use |
6165
| landingPage.imagePullPolicy | string | `nil` | Optional: Override the imagePullPolicy for the landing page's docker image. If this is omitted or empty, the root at .Values.imagePullPolicy is used. |
@@ -71,6 +75,7 @@ A Helm chart for Theia Cloud
7175
| monitor.activityTracker.enable | bool | `true` | Should the activityTracker module be enabled |
7276
| monitor.activityTracker.interval | int | `1` | Minutes between re-pinging the pods |
7377
| monitor.enable | bool | `true` | Should the monitor be enabled |
78+
| oauth2Proxy | object | `{"cookieDomains":[],"whitelistDomains":[]}` | Values related to OAuth2 Proxy configuration |
7479
| operator | object | (see details below) | Values related to the operator |
7580
| operator.bandwidthLimiter | string | `"K8SANNOTATION"` | Whether Theia Cloud shall limit network speed. This might not be fully supported on all cloud provider/in all clusters. Possible values: - K8SANNOTATION Set via kubernetes annotations (kubernetes.io/egress-bandwidth and kubernetes.io/ingress-bandwidth) - WONDERSHAPER Set via wondershaper init container - K8SANNOTATIONANDWONDERSHAPER Set Kubernetes annotations and use wondershaper init container |
7681
| operator.cloudProvider | string | `"K8S"` | Select your cloud provider. Possible values: - K8S Plain Kubernetes - MINIKUBE Local deployment on Minikube |

‎charts/theia-cloud/README.md.gotmpl

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
{{ template "chart.header" . }}
2+
{{ template "chart.deprecationWarning" . }}
3+
4+
{{ template "chart.badgesSection" . }}
5+
6+
{{ template "chart.description" . }}
7+
8+
*This chart was tested with Helm version v3.17.0.*
9+
*Other versions may work as well, but if you encounter any issues, we recommend trying with the tested version to rule out version-specific problems.*
10+
11+
{{ template "chart.homepageLine" . }}
12+
13+
{{ template "chart.maintainersSection" . }}
14+
15+
{{ template "chart.sourcesSection" . }}
16+
17+
{{ template "chart.requirementsSection" . }}
18+
19+
{{ template "chart.valuesSection" . }}
20+
21+
{{ template "helm-docs.versionFooter" . }}

0 commit comments

Comments
 (0)