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
Rename Theia.Cloud to Theia Cloud and Improve Ingress/Host configuration (#59)
* Update Theia.Cloud to Theia Cloud
* move hosts.tls to ingress.tls
* move hosts.paths.tlsSecretName to ingress.addTLSSecretName
* default is set to true which is a change for path based installs
* move hosts.paths to hosts.configuration
* remove hosts.useServicePortInHostname
* no replacement
* move hosts.servicePort to service.port
* move hosts.serviceProtocol to service.protocol
* removed hosts.service
* hosts.configuration.service + hosts.configuration.baseHost
* removed hosts.landing
* hosts.configuration.landing + hosts.configuration.baseHost
* removed hosts.instance
* hosts.configuration.instance + hosts.configuration.baseHost
Contributed on behalf of STMicroelectronics
Copy file name to clipboardExpand all lines: CHANGELOG.md
+14
Original file line number
Diff line number
Diff line change
@@ -11,6 +11,20 @@
11
11
-[theia-cloud] Add `hosts.paths.tlsSecretName` to values which allows to optionally set the tls secretName on the ingress tls section when using paths [#57](https://github.com/eclipsesource/theia-cloud-helm/pull/57)
12
12
-[theia-cloud] Add `ingress.certManagerAnnotations` to values which allows to configure whether cert manager annotations will be added to the ingresses [#57](https://github.com/eclipsesource/theia-cloud-helm/pull/57)
13
13
14
+
### Breaking Changes in 0.11.0
15
+
16
+
In preparation for a first major release we will introduce some breaking changes in order to make the helm chart configuration easier to understand.
17
+
18
+
-[theia-cloud] move `hosts.tls` to `ingress.tls`[#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
19
+
-[theia-cloud] move `hosts.paths.tlsSecretName` to `ingress.addTLSSecretName` (default is set to `true` which is a change for path based installs) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
20
+
-[theia-cloud] move `hosts.paths` to `hosts.configuration`[#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
21
+
-[theia-cloud] remove `hosts.useServicePortInHostname` (no replacement) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
22
+
-[theia-cloud] move `hosts.servicePort` to `service.port`[#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
23
+
-[theia-cloud] move `hosts.serviceProtocol` to `service.protocol`[#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
-[theia-cloud-crds] Provide conversion webhook for newer versions of CRDs [#49](https://github.com/eclipsesource/theia-cloud-helm/pull/49) | [#283](https://github.com/eclipsesource/theia-cloud/pull/283) - contributed on behalf of STMicroelectronics
| demoApplication.pullSecret | string |`""`| the image pull secret. Leave empty if registry is public |
27
27
| demoApplication.timeout | string |`"30"`| Limit in minutes |
28
28
| hosts | object | (see details below) | You may adjust the hostname below. |
29
-
| hosts.allWildcardInstances | list |`["*.webview."]`| all additional wildcard hostnames that may be required in the launched Theia-applications, e.g. "*.webview." which leads to "*.webview.ws.192.168.39.173.nip.io" to expose webviews. Please note that this means that this usually means that all "ingressHostnamePrefixes" patterns from all app definitions need to be added. These are required to configure TLS (if enabled via hosts.tls == true) |
30
-
| hosts.instance | string |`"ws.192.168.39.173.nip.io"`| hostname for the launched Theia-applications |
31
-
| hosts.landing | string |`"theia.cloud.192.168.39.173.nip.io"`| hostname of the landing page |
32
-
| hosts.paths | object | (see details below) | Only needed when usePaths == true. Contains the baseHost and paths for all services |
33
-
| hosts.paths.baseHost | string |`"192.168.39.173.nip.io"`| baseHost configures the host for all services when usePaths == true. Otherwise the explicit host definitions of the services are used. |
34
-
| hosts.paths.instance | string |`"instances"`| path for deployed instances |
35
-
| hosts.paths.landing | string |`"trynow"`| path of the landing page |
36
-
| hosts.paths.service | string |`"servicex"`| path of the REST service |
37
-
| hosts.paths.tlsSecretName | bool |`false`| whether the default Theia Cloud tls secret names should be used. If false no tls secret name will be set on the ingress only needed when hosts.usePaths == true and hosts.tls == true |
38
-
| hosts.service | string |`"service.192.168.39.173.nip.io"`| hostname of the REST-API |
39
-
| hosts.servicePort | int |`8081`| service port (default: 8081) |
40
-
| hosts.serviceProtocol | string |`"https"`| protocol of the REST-API |
41
-
| hosts.tls | bool |`true`| Does Theia Cloud expect TLS connections (true) or is TLS terminated outside of Theia Cloud (e.g. via a Load Balancer) (false) |
29
+
| hosts.allWildcardInstances | list |`["*.webview."]`| all additional wildcard hostnames that may be required in the launched Theia-applications, e.g. "*.webview." which leads to "*.webview.ws.192.168.39.173.nip.io" to expose webviews. Please note that this means that this usually means that all "ingressHostnamePrefixes" patterns from all app definitions need to be added. These are required to configure TLS (if enabled via ingress.tls == true) |
30
+
| hosts.configuration | object | (see details below) | Configuration for the hostnames. Contains the baseHost and afixes for all services |
31
+
| hosts.configuration.baseHost | string |`"192.168.39.173.nip.io"`| baseHost configures the host for all services. Depending on hosts.usePaths the services will be prepended as a subdomain or appended as a path |
32
+
| hosts.configuration.instance | string |`"instances"`| afix for deployed instances |
33
+
| hosts.configuration.landing | string |`"trynow"`| afix of the landing page |
34
+
| hosts.configuration.service | string |`"servicex"`| afix of the REST service |
42
35
| hosts.usePaths | bool |`false`| Use paths configures that all services should run on the same host but on different paths. true uses paths false uses an explicit host for each service |
43
-
| hosts.useServicePortInHostname | bool |`false`| whether the service port needs to be part of the service URL (default: false) |
44
36
| imagePullPolicy | string |`"Always"`| The default imagePullPolicy for containers of theia cloud. Can be overridden for individual components by specifying the imagePullPolicy variable there. Possible values: - Always - IfNotPresent - Never |
45
37
| ingress | object | (see details below) | Values to influence the ingresses |
46
-
| ingress.certManagerAnnotations | bool |`true`| When set to true the cert-manager.io annotations will be set. When false certificate management is handled outside of Theia Cloud. |
38
+
| ingress.addTLSSecretName | bool |`true`| whether the default Theia Cloud tls secret names should be used. If false no tls secret name will be set on the ingress only needed when ingress.tls == true |
39
+
| ingress.certManagerAnnotations | bool |`true`| When set to true the cert-manager.io annotations will be set. Only used when ingress.addTLSSecretName === true When false certificate management is handled outside of Theia Cloud. |
47
40
| ingress.clusterIssuer | string |`"letsencrypt-prod"`| The cluster issuer to use Only needed when ingress.certManagerAnnotations is true |
48
-
| ingress.instanceName | string |`"theia-cloud-demo-ws-ingress"`| The name of the ingress which will be updated to publish new theia application. If this is not existing it will be created. You may chose to set the ingress up yourself and point theia.cloud to the ingress via the name |
41
+
| ingress.instanceName | string |`"theia-cloud-demo-ws-ingress"`| The name of the ingress which will be updated to publish new theia application. If this is not existing it will be created. You may chose to set the ingress up yourself and point Theia Cloud to the ingress via the name |
49
42
| ingress.proxyBodySize | string |`"1m"`| Sets the maximum allowed size of the client request body inside the application (e.g. file uploads in Theia). Defaults to 1m. Setting size to 0 disables checking of client request body size. |
50
43
| ingress.theiaCloudCommonName | bool |`false`| When set to true the cert-manager.io/common-name annotation will be set. This is only required when the issued certificate by the cert-manager misses a common-name Only needed when ingress.certManagerAnnotations is true |
44
+
| ingress.tls | bool |`true`| Does Theia Cloud expect TLS connections (true) or is TLS terminated outside of Theia Cloud (e.g. via a Load Balancer) (false) |
51
45
| issuer | object | (see details below) | Values related to certificates/Cert-manager |
52
46
| issuer.email | string |`"[email protected]"`| EMail address of the certificate issuer. |
53
47
| keycloak | object | (see details below) | Values related to Keycloak |
@@ -95,10 +89,12 @@ A Helm chart for Theia.cloud
95
89
| preloading.enable | bool |`true`| Is image preloading enabled. |
96
90
| preloading.imagePullPolicy | string |`nil`| Optional: Override the imagePullPolicy for the image preloading containers. If this is omitted or empty, the root at .Values.imagePullPolicy is used. |
97
91
| preloading.images | list |`[]`| Images to preload. Images must support running /bin/sh. If the list is empty and demoApplication.install == true, demoApplication.name is automatically added. |
98
-
| service | object | (see details below) | Values of the Theia.cloud REST service |
92
+
| service | object | (see details below) | Values of the Theia Cloud REST service |
99
93
| service.image | string |`"theiacloud/theia-cloud-service:0.11.0-next"`| The image to use |
100
94
| service.imagePullPolicy | string |`nil`| Optional: Override the imagePullPolicy for the service's docker image. If this is omitted or empty, the root at .Values.imagePullPolicy is used. |
0 commit comments