Skip to content

Commit dd202ac

Browse files
jfaltermeierjfaltermeier
committed
Move logo related values from app to landing page
* also add missing documentation
1 parent 33f323f commit dd202ac

File tree

9 files changed

+35
-30
lines changed

9 files changed

+35
-30
lines changed

‎CHANGELOG.md

+1
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@ In preparation for a first major release we will introduce some breaking changes
2424
- [theia-cloud] removed `hosts.service` (now `hosts.configuration.service` + `hosts.configuration.baseHost`) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
2525
- [theia-cloud] removed `hosts.landing` (now `hosts.configuration.landing` + `hosts.configuration.baseHost`) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
2626
- [theia-cloud] removed `hosts.instance` (now `hosts.configuration.instance` + `hosts.configuration.baseHost`) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
27+
- [theia-cloud] move `app.logo`, `app.logoData`, and `app.logoFileExtension` to `landingPage.logo`, `landingPage.logoData`, and `landingPage.logoFileExtension` [#63](https://github.com/eclipsesource/theia-cloud-helm/pull/63)
2728

2829
## [0.10.0] - 2024-04-02
2930

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

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

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

55
Theia-cloud base chart
66

@@ -10,11 +10,13 @@ Theia-cloud base chart
1010
|-----|------|---------|-------------|
1111
| certmanager.namespace | string | `"cert-manager"` | the namespace where the cert-manager is installed |
1212
| issuer.email | string | `"[email protected]"` | email used to issue let's encrypt certificates |
13+
| issuerca.enable | bool | `true` | whether to install the CA certificate signer |
1314
| issuerca.name | string | `"theia-cloud-ca-certificate-signer"` | name for the issuer preparing a self signed CA certificate |
15+
| issuerprod.enable | bool | `true` | whether to install the let's encrypt production cluster issuer |
1416
| issuerprod.name | string | `"letsencrypt-prod"` | name for the let's encrypt production cluster issuer |
1517
| issuerstaging.name | string | `"theia-cloud-selfsigned-issuer"` | name for the self signed cluster issuer |
1618
| operatorrole.name | string | `"operator-api-access"` | name for the operator's cluster role |
1719
| servicerole.name | string | `"service-api-access"` | name for the services' cluster role |
1820

1921
----------------------------------------------
20-
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
22+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

‎charts/theia-cloud-base/values.yaml

+2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,11 @@
11
issuerca:
2+
# -- whether to install the CA certificate signer
23
enable: true
34
# -- name for the issuer preparing a self signed CA certificate
45
name: theia-cloud-ca-certificate-signer
56

67
issuerprod:
8+
# -- whether to install the let's encrypt production cluster issuer
79
enable: true
810
# -- name for the let's encrypt production cluster issuer
911
name: letsencrypt-prod

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,4 +13,4 @@ A Helm chart for the custom resource definitions (CRDs) of Theia Cloud
1313
| conversion.image | string | `"theiacloud/theia-cloud-conversion-webhook:0.11.0-next"` | The image of the webhook container |
1414

1515
----------------------------------------------
16-
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
16+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

‎charts/theia-cloud/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ type: application
1515
# This is the chart version. This version number should be incremented each time you make changes
1616
# to the chart and its templates, including the app version.
1717
# Versions are expected to follow Semantic Versioning (https://semver.org/)
18-
version: 0.11.0-next.4
18+
version: 0.11.0-next.5
1919

2020
# This is the version number of the application being deployed. This version number should be
2121
# incremented each time you make changes to the application. Versions are not expected to

‎charts/theia-cloud/README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ A Helm chart for Theia Cloud
1010
|-----|------|---------|-------------|
1111
| app | object | (see details below) | General information about the deployed app |
1212
| app.id | string | `"asdfghjkl"` | The app id which is used in the communication between website and REST-API as a spam migitation. This id is public. Please choose an random generated string. |
13-
| app.logo | string | `"logos/theiablueprint.svg"` | The logo of the application that should be displayed on the landing pages |
14-
| app.logoData | string | `nil` | set app.logoData=$(cat path/to/file.svg | base64 -w 0 -) Another way is to directly add the base64 string to the values file. |
15-
| app.logoFileExtension | string | `"svg"` | The file extension of the logo. Must be set to match the logo respectively the logoData. This is required because browsers cannot show a binary image (e.g. png) with a svg ending and vice-versa. |
16-
| app.name | string | `"Theia Blueprint"` | The name of the application that should be displayed on the landing pages |
13+
| app.name | string | `"Theia Blueprint"` | The name of the application that may be displayed e.g. on the landing pages |
1714
| demoApplication | object | (see details below) | Information about the demo application to be installed |
1815
| demoApplication.imagePullPolicy | string | `nil` | Optional: Override the imagePullPolicy for the main application's docker image. If this is omitted or empty, the root at .Values.imagePullPolicy is used. |
1916
| demoApplication.install | bool | `true` | Should the demo application be installed |
@@ -62,6 +59,9 @@ A Helm chart for Theia Cloud
6259
| landingPage.infoText | string | `nil` | Optional: If specified with a value, this overrides the info text shown on the landing page. Empty values are ignored. Use `disableInfo` to deactivate showing the info completely. |
6360
| landingPage.infoTitle | string | `nil` | Optional: If specified with a value, this overrides the title of the info text shown on the landing page. Empty values are ignored. Use `disableInfo` to deactivate showing the info completely. |
6461
| landingPage.loadingText | string | `nil` | Optional: If specified with a value, this overrides the message shown to the user while the session is started. Empty values are ignored and the default text is used. |
62+
| landingPage.logo | string | `"logos/theiablueprint.svg"` | The logo of the application that should be displayed on the landing pages |
63+
| landingPage.logoData | string | `nil` | set landingPage.logoData=$(cat path/to/file.svg | base64 -w 0 -) Another way is to directly add the base64 string to the values file. |
64+
| landingPage.logoFileExtension | string | `"svg"` | The file extension of the logo. Must be set to match the logo respectively the logoData. This is required because browsers cannot show a binary image (e.g. png) with a svg ending and vice-versa. |
6565
| monitor | object | (see details below) | Values to influence the monitor initialization on the operator |
6666
| monitor.activityTracker | object | (see details below) | Values to influence the activityTracker module |
6767
| monitor.activityTracker.enable | bool | `true` | Should the activityTracker module be enabled |
@@ -98,4 +98,4 @@ A Helm chart for Theia Cloud
9898
| servicerole.name | string | `"service-api-access"` | |
9999

100100
----------------------------------------------
101-
Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
101+
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)

‎charts/theia-cloud/templates/landing-page-config-map.yaml

+4-4
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{- $logoFileExtension := tpl (.Values.app.logoFileExtension | toString) . -}}
1+
{{- $logoFileExtension := tpl (.Values.landingPage.logoFileExtension | toString) . -}}
22
apiVersion: v1
33
kind: ConfigMap
44
metadata:
@@ -41,10 +41,10 @@ data:
4141
{{- end }}
4242
};
4343
binaryData:
44-
{{- if .Values.app.logoData }}
45-
{{ printf "logo.%s: " $logoFileExtension }}{{ .Values.app.logoData }}
44+
{{- if .Values.landingPage.logoData }}
45+
{{ printf "logo.%s: " $logoFileExtension }}{{ .Values.landingPage.logoData }}
4646
{{- else }}
47-
{{- range $path, $bytes := .Files.Glob (printf "%s" .Values.app.logo)}}
47+
{{- range $path, $bytes := .Files.Glob (printf "%s" .Values.landingPage.logo)}}
4848
{{ printf "logo.%s: " $logoFileExtension }}{{ $.Files.Get $path | b64enc }}
4949
{{ end }}
5050
{{- end }}

‎charts/theia-cloud/templates/landing-page.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
{{- $logoFileName := printf "logo.%s" (tpl (.Values.app.logoFileExtension | toString) .) -}}
1+
{{- $logoFileName := printf "logo.%s" (tpl (.Values.landingPage.logoFileExtension | toString) .) -}}
22
apiVersion: apps/v1
33
kind: Deployment
44
metadata:

‎charts/theia-cloud/values.yaml

+16-16
Original file line numberDiff line numberDiff line change
@@ -13,24 +13,9 @@ app:
1313
# as a spam migitation. This id is public. Please choose an random generated string.
1414
id: asdfghjkl
1515

16-
# -- The name of the application that should be displayed on the landing pages
16+
# -- The name of the application that may be displayed e.g. on the landing pages
1717
name: Theia Blueprint
1818

19-
# -- The logo of the application that should be displayed on the landing pages
20-
logo: logos/theiablueprint.svg
21-
22-
# -- Set a base64 encoded svg image that should be displayed on the landing pages.
23-
# If this is given, the logo value above is ignored.
24-
# On Linux, you can directly generate the base64 string when applying the chart like this:
25-
# --set app.logoData=$(cat path/to/file.svg | base64 -w 0 -)
26-
# Another way is to directly add the base64 string to the values file.
27-
logoData:
28-
29-
# -- The file extension of the logo. Must be set to match the logo respectively the logoData.
30-
# This is required because browsers cannot show a binary image (e.g. png) with a svg ending
31-
# and vice-versa.
32-
logoFileExtension: 'svg'
33-
3419
# -- Values related to certificates/Cert-manager
3520
# @default -- (see details below)
3621
issuer:
@@ -149,6 +134,21 @@ landingPage:
149134
# Empty values are ignored and the default text is used.
150135
loadingText:
151136

137+
# -- The logo of the application that should be displayed on the landing pages
138+
logo: logos/theiablueprint.svg
139+
140+
# -- Set a base64 encoded svg image that should be displayed on the landing pages.
141+
# If this is given, the logo value above is ignored.
142+
# On Linux, you can directly generate the base64 string when applying the chart like this:
143+
# --set landingPage.logoData=$(cat path/to/file.svg | base64 -w 0 -)
144+
# Another way is to directly add the base64 string to the values file.
145+
logoData:
146+
147+
# -- The file extension of the logo. Must be set to match the logo respectively the logoData.
148+
# This is required because browsers cannot show a binary image (e.g. png) with a svg ending
149+
# and vice-versa.
150+
logoFileExtension: 'svg'
151+
152152
# -- Values related to Keycloak
153153
# @default -- (see details below)
154154
keycloak:

0 commit comments

Comments
 (0)