[telemetry] Add new GITPOD_INSTALLATION_PLATFORM telemetry variable

Fixes #10766

This PR adds a new `GITPOD_INSTALLATION_PLATFORM` env variable, that
is then transmitted by the `gitpod-telemetry` job as the `platform`
property into our telemetry store. The value of this env variable
is then overrided by each install method.

This env can have the following values:
- `installer` by default as when the installation is done directly
  through the installer, We don't have enough information
   about the environment.
-  [One of the `distribution` values](https://docs.replicated.com/reference/template-functions-static-context#distribution)
   when done through `kots`. This would have the distribution in which
   Gitpod is being installed, and is dependent on `kots`.
- `local-preview` when the installation is done through the new
   preview install method.

As the changes show in the PR, each installation method overrides
the value.

Signed-off-by: Tarun Pothulapati <[email protected]>

Author: Pothulapati

components/installation-telemetry/cmd/send.go

@@ -56,6 +56,11 @@ var sendCmd = &cobra.Command{
 			Set("totalWorkspaces", data.TotalWorkspaces).
 			Set("totalInstances", data.TotalInstances)
 
+		platform := os.Getenv("GITPOD_INSTALLATION_PLATFORM")
+		if platform != "" {
+			properties.Set("platform", platform)
+		}
+
 		if data.InstallationAdmin.Settings.SendCustomerID {
 			properties.Set("customerID", data.CustomerID)
 		}

gitpod-ws.code-workspace

@@ -25,7 +25,8 @@
         { "path": "dev/gpctl" },
         { "path": "dev/loadgen" },
         { "path": "dev/poolkeeper" },
-        { "path": "install/installer" }
+        { "path": "install/installer" },
+        { "path": "install/preview" }
     ],
     "settings": {
         "typescript.tsdk": "gitpod/node_modules/typescript/lib",

install/installer/pkg/components/gitpod/cronjob.go

@@ -63,6 +63,10 @@ func cronjob(ctx *common.RenderContext) ([]runtime.Object, error) {
 												Name:  "GITPOD_INSTALLATION_VERSION",
 												Value: ctx.VersionManifest.Version,
 											},
+											{
+												Name:  "GITPOD_INSTALLATION_PLATFORM",
+												Value: "installer",
+											},
 											{
 												Name:  "SERVER_URL",
 												Value: fmt.Sprintf("http://%s.%s.svc.cluster.local:%d", common.ServerComponent, ctx.Namespace, common.ServerInstallationAdminPort),

install/kots/manifests/gitpod-installer-job.yaml

@@ -291,6 +291,11 @@ spec:
                 'del(select(.kind == "StatefulSet" and .metadata.name == "openvsx-proxy").status)' \
                 "${GITPOD_OBJECTS}/templates/gitpod.yaml"
 
+              echo "Gitpod: Update GITPOD_INSTALLATION_PLATFORM telemetry value"
+              yq eval-all --inplace \
+                '(select(.kind == "CronJob" and .metadata.name == "gitpod-telemetry") | .spec.jobTemplate.spec.spec.containers[].env[] | (select(.name=="GITPOD_INSTALLATION_PLATFORM") |.value |= sub("installer"; "repl{{ Distribution }}"))'
+                "${GITPOD_OBJECTS}/templates/gitpod.yaml"
+
               if [ '{{repl ConfigOptionEquals "reg_incluster" "1" }}' = "true" ];
               then
                 echo "Gitpod: Add the local registry secret to the in-cluster registry secret"

install/preview/entrypoint.sh

@@ -129,6 +129,9 @@ yq eval-all -i ". as \$item ireduce ({}; . *+ \$item)" /var/lib/rancher/k3s/serv
 # update Statefulset's to use k3s's `local-path` storage class
 for f in /var/lib/rancher/k3s/server/manifests/gitpod/*StatefulSet*.yaml; do yq e -i '.spec.volumeClaimTemplates[0].spec.storageClassName="local-path"' "$f"; done
 
+# set the GITPOD_INSTALLATION_PLATFORM
+yq eval-all -i '.spec.jobTemplate.spec.spec.containers[].env[] | (select(.name=="GITPOD_INSTALLATION_PLATFORM") |.value |= sub("installer"; "local-preview"))' /var/lib/rancher/k3s/server/manifests/gitpod/*_CronJob_gitpod-telemetry.yaml
+
 # removing init container from ws-daemon (systemd and Ubuntu)
 yq eval-all -i 'del(.spec.template.spec.initContainers[0])' /var/lib/rancher/k3s/server/manifests/gitpod/*_DaemonSet_ws-daemon.yaml