use a config option instead

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

Author: Pothulapati

components/installation-telemetry/cmd/send.go

@@ -45,6 +45,11 @@ var sendCmd = &cobra.Command{
 			return fmt.Errorf("GITPOD_INSTALLATION_VERSION envvar not set")
 		}
 
+		platform := os.Getenv("GITPOD_INSTALLATION_PLATFORM")
+		if platform == "" {
+			return fmt.Errorf("GITPOD_INSTALLATION_PLATFORM envvar not set")
+		}
+
 		client, err := analytics.NewWithConfig(segmentIOToken, analytics.Config{})
 		defer func() {
 			err = client.Close()
@@ -54,12 +59,8 @@ var sendCmd = &cobra.Command{
 			Set("version", versionId).
 			Set("totalUsers", data.TotalUsers).
 			Set("totalWorkspaces", data.TotalWorkspaces).
-			Set("totalInstances", data.TotalInstances)
-
-		platform := os.Getenv("GITPOD_INSTALLATION_PLATFORM")
-		if platform != "" {
-			properties.Set("platform", platform)
-		}
+			Set("totalInstances", data.TotalInstances).
+			Set("platform", platform)
 
 		if data.InstallationAdmin.Settings.SendCustomerID {
 			properties.Set("customerID", data.CustomerID)

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

@@ -9,6 +9,7 @@ import (
 
 	"github.com/gitpod-io/gitpod/installer/pkg/common"
 	"github.com/gitpod-io/gitpod/installer/pkg/config/v1"
+	"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
 	batchv1 "k8s.io/api/batch/v1"
 	v1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
@@ -21,6 +22,14 @@ func cronjob(ctx *common.RenderContext) ([]runtime.Object, error) {
 		return []runtime.Object{}, nil
 	}
 
+	platformTelemetryData := "unknown"
+	_ = ctx.WithExperimental(func(cfg *experimental.Config) error {
+		if cfg.Telemetry != nil && cfg.Telemetry.Data.Platform != "" {
+			platformTelemetryData = cfg.Telemetry.Data.Platform
+		}
+		return nil
+	})
+
 	installationTelemetryComponent := fmt.Sprintf("%s-telemetry", Component)
 
 	objectMeta := metav1.ObjectMeta{
@@ -65,7 +74,7 @@ func cronjob(ctx *common.RenderContext) ([]runtime.Object, error) {
 											},
 											{
 												Name:  "GITPOD_INSTALLATION_PLATFORM",
-												Value: "installer",
+												Value: platformTelemetryData,
 											},
 											{
 												Name:  "SERVER_URL",

install/installer/pkg/config/v1/experimental/experimental.go

@@ -21,6 +21,13 @@ type Config struct {
 	WebApp    *WebAppConfig    `json:"webapp,omitempty"`
 	IDE       *IDEConfig       `json:"ide,omitempty"`
 	Common    *CommonConfig    `json:"common,omitempty"`
+	Telemetry *TelemetryConfig `json:"telemetry,omitempty"`
+}
+
+type TelemetryConfig struct {
+	Data struct {
+		Platform string `json:"platform"`
+	} `json:"data"`
 }
 
 type CommonConfig struct {

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

@@ -273,6 +273,9 @@ spec:
                 fi
               fi
 
+              echo "Gitpod: Update platform telemetry value"
+              yq eval-all --inplace '.experimental.telemetry.data.platform = "{{repl Distribution }}"' "${CONFIG_FILE}"
+
               echo "Gitpod: Patch Gitpod config"
               base64 -d "${CONFIG_PATCH_FILE}" > /tmp/patch.yaml
               config_patch=$(cat /tmp/patch.yaml)
@@ -303,11 +306,6 @@ 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.template.spec.containers[0].env[] | select(.name=="GITPOD_INSTALLATION_PLATFORM")).value |= "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

@@ -100,9 +100,10 @@ yq e -i '.customCACert.kind = "secret"' config.yaml
 yq e -i '.observability.logLevel = "debug"' config.yaml
 yq e -i '.workspace.runtime.containerdSocket = "/run/k3s/containerd/containerd.sock"' config.yaml
 yq e -i '.workspace.runtime.containerdRuntimeDir = "/var/lib/rancher/k3s/agent/containerd/io.containerd.runtime.v2.task/k8s.io/"' config.yaml
+yq e -i '.experimental.telemetry.data.platform = "local-preview"' config.yaml
 
 echo "extracting images to download ahead..."
-/gitpod-installer render --config config.yaml | grep 'image:' | sed 's/ *//g' | sed 's/image://g' | sed 's/\"//g' | sed 's/^-//g' | sort | uniq > /gitpod-images.txt
+/gitpod-installer render --use-experimental-config --config config.yaml | grep 'image:' | sed 's/ *//g' | sed 's/image://g' | sed 's/\"//g' | sed 's/^-//g' | sort | uniq > /gitpod-images.txt
 echo "downloading images..."
 while read -r image "$(cat /gitpod-images.txt)"; do
    # shellcheck disable=SC2154
@@ -124,8 +125,6 @@ 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.template.spec.containers[0].env[] | select(.name=="GITPOD_INSTALLATION_PLATFORM")).value |= "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