Move logo related values from app to landing page

* also add missing documentation

Author: jfaltermeier

CHANGELOG.md

@@ -24,6 +24,7 @@ In preparation for a first major release we will introduce some breaking changes
 - [theia-cloud] removed `hosts.service` (now `hosts.configuration.service` + `hosts.configuration.baseHost`) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
 - [theia-cloud] removed `hosts.landing` (now `hosts.configuration.landing` + `hosts.configuration.baseHost`) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
 - [theia-cloud] removed `hosts.instance` (now `hosts.configuration.instance` + `hosts.configuration.baseHost`) [#59](https://github.com/eclipsesource/theia-cloud-helm/pull/59)
+- [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)
 
 ## [0.10.0] - 2024-04-02
 

charts/theia-cloud-base/README.md

@@ -1,6 +1,6 @@
 # theia-cloud-base
 
-![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)
+![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)
 
 Theia-cloud base chart
 
@@ -10,11 +10,13 @@ Theia-cloud base chart
 |-----|------|---------|-------------|
 | certmanager.namespace | string | `"cert-manager"` | the namespace where the cert-manager is installed |
 | issuer.email | string | `"[email protected]"` | email used to issue let's encrypt certificates |
+| issuerca.enable | bool | `true` | whether to install the CA certificate signer |
 | issuerca.name | string | `"theia-cloud-ca-certificate-signer"` | name for the issuer preparing a self signed CA certificate |
+| issuerprod.enable | bool | `true` | whether to install the let's encrypt production cluster issuer |
 | issuerprod.name | string | `"letsencrypt-prod"` | name for the let's encrypt production cluster issuer |
 | issuerstaging.name | string | `"theia-cloud-selfsigned-issuer"` | name for the self signed cluster issuer |
 | operatorrole.name | string | `"operator-api-access"` | name for the operator's cluster role |
 | servicerole.name | string | `"service-api-access"` | name for the services' cluster role |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
+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

@@ -1,9 +1,11 @@
 issuerca:
+  # -- whether to install the CA certificate signer
   enable: true
   # -- name for the issuer preparing a self signed CA certificate
   name: theia-cloud-ca-certificate-signer
 
 issuerprod:
+  # -- whether to install the let's encrypt production cluster issuer
   enable: true
   # -- name for the let's encrypt production cluster issuer
   name: letsencrypt-prod

charts/theia-cloud-crds/README.md

@@ -13,4 +13,4 @@ A Helm chart for the custom resource definitions (CRDs) of Theia Cloud
 | conversion.image | string | `"theiacloud/theia-cloud-conversion-webhook:0.11.0-next"` | The image of the webhook container |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
+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

@@ -15,7 +15,7 @@ type: application
 # This is the chart version. This version number should be incremented each time you make changes
 # to the chart and its templates, including the app version.
 # Versions are expected to follow Semantic Versioning (https://semver.org/)
-version: 0.11.0-next.4
+version: 0.11.0-next.5
 
 # This is the version number of the application being deployed. This version number should be
 # incremented each time you make changes to the application. Versions are not expected to

charts/theia-cloud/README.md

@@ -10,10 +10,7 @@ A Helm chart for Theia Cloud
 |-----|------|---------|-------------|
 | app | object | (see details below) | General information about the deployed app |
 | 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. |
-| app.logo | string | `"logos/theiablueprint.svg"` | The logo of the application that should be displayed on the landing pages |
-| 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. |
-| 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. |
-| app.name | string | `"Theia Blueprint"` | The name of the application that should be displayed on the landing pages |
+| app.name | string | `"Theia Blueprint"` | The name of the application that may be displayed e.g. on the landing pages |
 | demoApplication | object | (see details below) | Information about the demo application to be installed |
 | 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. |
 | demoApplication.install | bool | `true` | Should the demo application be installed |
@@ -62,6 +59,9 @@ A Helm chart for Theia Cloud
 | 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. |
 | 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. |
 | 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. |
+| landingPage.logo | string | `"logos/theiablueprint.svg"` | The logo of the application that should be displayed on the landing pages |
+| 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. |
+| 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. |
 | monitor | object | (see details below) | Values to influence the monitor initialization on the operator |
 | monitor.activityTracker | object | (see details below) | Values to influence the activityTracker module |
 | monitor.activityTracker.enable | bool | `true` | Should the activityTracker module be enabled |
@@ -98,4 +98,4 @@ A Helm chart for Theia Cloud
 | servicerole.name | string | `"service-api-access"` |  |
 
 ----------------------------------------------
-Autogenerated from chart metadata using [helm-docs v1.13.1](https://github.com/norwoodj/helm-docs/releases/v1.13.1)
+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

@@ -1,4 +1,4 @@
-{{- $logoFileExtension :=  tpl (.Values.app.logoFileExtension | toString) . -}}
+{{- $logoFileExtension :=  tpl (.Values.landingPage.logoFileExtension | toString) . -}}
 apiVersion: v1
 kind: ConfigMap
 metadata:
@@ -41,10 +41,10 @@ data:
       {{- end }}
     };
 binaryData:
-  {{- if .Values.app.logoData }}
-  {{ printf "logo.%s: " $logoFileExtension }}{{ .Values.app.logoData }}
+  {{- if .Values.landingPage.logoData }}
+  {{ printf "logo.%s: " $logoFileExtension }}{{ .Values.landingPage.logoData }}
   {{- else }}
-  {{- range $path, $bytes := .Files.Glob (printf "%s" .Values.app.logo)}}
+  {{- range $path, $bytes := .Files.Glob (printf "%s" .Values.landingPage.logo)}}
   {{ printf "logo.%s: " $logoFileExtension }}{{ $.Files.Get $path | b64enc }}
   {{ end }}
   {{- end }}

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

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

charts/theia-cloud/values.yaml

@@ -13,24 +13,9 @@ app:
   # as a spam migitation. This id is public. Please choose an random generated string.
   id: asdfghjkl
 
-  # -- The name of the application that should be displayed on the landing pages
+  # -- The name of the application that may be displayed e.g. on the landing pages
   name: Theia Blueprint
 
-  # -- The logo of the application that should be displayed on the landing pages
-  logo: logos/theiablueprint.svg
-
-  # -- Set a base64 encoded svg image that should be displayed on the landing pages.
-  # If this is given, the logo value above is ignored.
-  # On Linux, you can directly generate the base64 string when applying the chart like this:
-  # --set app.logoData=$(cat path/to/file.svg | base64 -w 0 -)
-  # Another way is to directly add the base64 string to the values file.
-  logoData:
-
-  # -- 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.
-  logoFileExtension: 'svg'
-
 # -- Values related to certificates/Cert-manager
 # @default -- (see details below)
 issuer:
@@ -149,6 +134,21 @@ landingPage:
   # Empty values are ignored and the default text is used.
   loadingText:
 
+  # -- The logo of the application that should be displayed on the landing pages
+  logo: logos/theiablueprint.svg
+
+  # -- Set a base64 encoded svg image that should be displayed on the landing pages.
+  # If this is given, the logo value above is ignored.
+  # On Linux, you can directly generate the base64 string when applying the chart like this:
+  # --set landingPage.logoData=$(cat path/to/file.svg | base64 -w 0 -)
+  # Another way is to directly add the base64 string to the values file.
+  logoData:
+
+  # -- 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.
+  logoFileExtension: 'svg'
+
 # -- Values related to Keycloak
 # @default -- (see details below)
 keycloak: