Refactor APPID to SERVICE_AUTH_TOKEN (#95)

- Deprecate app.id parameter in favor of service.authToken
- Update operator to use --serviceAuthToken flag instead of --appId
- Add SERVICE_AUTH_TOKEN to service configuration
- Update landing page config to use serviceAuthToken property
- Maintain backward compatibility by defaulting to app.id value

Co-authored-by: Johannes Faltermeier <[email protected]>

Author: xai

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: 1.2.0-next.1
+version: 1.2.0-next.2
 
 # 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

@@ -1,6 +1,6 @@
 # theia-cloud
 
-![Version: 1.2.0-next.1](https://img.shields.io/badge/Version-1.2.0--next.1-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.2.0-next](https://img.shields.io/badge/AppVersion-1.2.0--next-informational?style=flat-square)
+![Version: 1.2.0-next.2](https://img.shields.io/badge/Version-1.2.0--next.2-informational?style=flat-square) ![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat-square) ![AppVersion: 1.2.0-next](https://img.shields.io/badge/AppVersion-1.2.0--next-informational?style=flat-square)
 
 A Helm chart for Theia Cloud
 
@@ -12,7 +12,7 @@ A Helm chart for Theia Cloud
 | Key | Type | Default | Description |
 |-----|------|---------|-------------|
 | 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.id | Deprecated | `"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. Use service.authToken instead. |
 | 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. |
@@ -99,6 +99,7 @@ A Helm chart for Theia Cloud
 | 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. |
 | 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. |
 | service | object | (see details below) | Values of the Theia Cloud REST service |
+| service.authToken | string | `"asdfghjkl"` | The service authentication token used in the communication between website and REST-API for spam mitigation. This token is public. Please choose a random generated string. |
 | service.image | string | `"theiacloud/theia-cloud-service:1.2.0-next"` | The image to use |
 | 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. |
 | service.imagePullSecret | string | `nil` | Optional: the image pull secret |

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

@@ -8,7 +8,7 @@ metadata:
 data:
   config.js: |
     window.theiaCloudConfig = {
-      appId: "{{ tpl (.Values.app.id | toString) . }}",
+      serviceAuthToken: "{{ tpl ((.Values.service.authToken | default .Values.app.id) | toString) . }}",
       appName: "{{ tpl (.Values.app.name | toString) . }}",
       useEphemeralStorage: {{ tpl (.Values.landingPage.ephemeralStorage | toString) . }},
       useKeycloak: {{ tpl (.Values.keycloak.enable | toString) . }},
@@ -24,7 +24,7 @@ data:
       additionalApps: [
         {{- range $key, $val := .Values.landingPage.additionalApps }}
         {
-          appId: {{ $key | quote}},
+          serviceAuthToken: {{ $key | quote}},
           appName: {{ $val.label | quote }},
         },
         {{- end }}

charts/theia-cloud/templates/operator.yaml

@@ -51,8 +51,8 @@ spec:
           {{- end }}
           - "--sessionsPerUser"
           - "{{ tpl (.Values.operator.sessionsPerUser | toString) . }}"
-          - "--appId"
-          - {{ tpl (.Values.app.id | toString) . }}
+          - "--serviceAuthToken"
+          - {{ tpl ((.Values.service.authToken | default .Values.app.id) | toString) . }}
           {{- if .Values.hosts.usePaths }}
           - "--instancesHost"
           - "{{ tpl (.Values.hosts.configuration.baseHost | toString) . }}"

charts/theia-cloud/templates/service-configmap.yaml

@@ -4,6 +4,7 @@ metadata:
   name: service-config
   namespace: {{ .Release.Namespace }}
 data:
+  SERVICE_AUTH_TOKEN: {{ tpl ((.Values.service.authToken | default .Values.app.id) | toString) . }}
   APPID: {{ tpl (.Values.app.id | toString) . }}
   SERVICE_PORT: {{ tpl (.Values.service.port | toString) . | quote }}
   KEYCLOAK_ENABLE: {{ tpl (.Values.keycloak.enable | toString) . | quote }}

charts/theia-cloud/values.yaml

@@ -9,8 +9,9 @@ imagePullPolicy: Always
 # -- General information about the deployed app
 # @default -- (see details below)
 app:
-  # -- The app id which is used in the communication between website and REST-API
+  # -- (Deprecated) 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.
+  # Use service.authToken instead.
   id: asdfghjkl
 
   # -- The name of the application that may be displayed e.g. on the landing pages
@@ -294,6 +295,10 @@ operator:
 # -- Values of the Theia Cloud REST service
 # @default -- (see details below)
 service:
+  # -- The service authentication token used in the communication between website and REST-API
+  # for spam mitigation. This token is public. Please choose a random generated string.
+  authToken: asdfghjkl
+
   # -- The image to use
   image: theiacloud/theia-cloud-service:1.2.0-next