[installer]: promote telemetry from experimental to main config

gitpod-io · Jan 19, 2023 · ed59f5f · ed59f5f
1 parent f484884
commit ed59f5f
Show file tree

Hide file tree

Showing 6 changed files with 41 additions and 12 deletions.
diff --git a/install/installer/cmd/testdata/render/telemetry/config.yaml b/install/installer/cmd/testdata/render/telemetry/config.yaml
@@ -4,7 +4,6 @@
 
 apiVersion: v1
 domain: gitpod.example.com
-experimental:
-  telemetry:
-    data:
-      platform: k3s
+telemetry:
+  data:
+    platform: k3s
diff --git a/install/installer/cmd/testdata/render/telemetry/output.golden b/install/installer/cmd/testdata/render/telemetry/output.golden
diff --git a/install/installer/pkg/components/gitpod/cronjob.go b/install/installer/pkg/components/gitpod/cronjob.go
@@ -15,7 +15,6 @@ import (
 
 	"github.com/gitpod-io/gitpod/installer/pkg/common"
 	config "github.com/gitpod-io/gitpod/installer/pkg/config/v1"
-	"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
 )
 
 func cronjob(ctx *common.RenderContext) ([]runtime.Object, error) {
@@ -24,12 +23,9 @@ func cronjob(ctx *common.RenderContext) ([]runtime.Object, error) {
 	}
 
 	platformTelemetryData := "unknown"
-	_ = ctx.WithExperimental(func(cfg *experimental.Config) error {
-		if cfg.Telemetry != nil && cfg.Telemetry.Data.Platform != "" {
-			platformTelemetryData = cfg.Telemetry.Data.Platform
-		}
-		return nil
-	})
+	if ctx.Config.Telemetry != nil && ctx.Config.Telemetry.Data != nil && ctx.Config.Telemetry.Data.Platform != "" {
+		platformTelemetryData = ctx.Config.Telemetry.Data.Platform
+	}
 
 	installationTelemetryComponent := fmt.Sprintf("%s-telemetry", Component)
 

diff --git a/install/installer/pkg/config/v1/config.go b/install/installer/pkg/config/v1/config.go
@@ -156,6 +156,8 @@ type Config struct {
 
 	Components *Components `json:"components,omitempty"`
 
+	Telemetry *TelemetryConfig `json:"telemetry,omitempty"`
+
 	Experimental *experimental.Config `json:"experimental,omitempty"`
 }
 
@@ -434,3 +436,11 @@ type ProxyComponent struct {
 type ComponentTypeService struct {
 	ServiceType *corev1.ServiceType `json:"serviceType,omitempty" validate:"omitempty,service_config_type"`
 }
+
+type TelemetryConfig struct {
+	Data *TelemetryData `json:"data,omitempty"`
+}
+
+type TelemetryData struct {
+	Platform string `json:"platform"`
+}
diff --git a/install/installer/pkg/config/v1/deprecations.go b/install/installer/pkg/config/v1/deprecations.go
@@ -73,6 +73,26 @@ var deprecatedFields = map[string]deprecatedField{
 			return nil
 		},
 	},
+	"experimental.telemetry.data.platform": {
+		Selector: func(cfg *Config) (bool, any) {
+			val := cfg.Experimental.Telemetry.Data.Platform
+			return val != "", val
+		},
+		MapValue: func(cfg *Config) error {
+			if cfg.Telemetry != nil && cfg.Telemetry.Data != nil && cfg.Telemetry.Data.Platform != "" {
+				return errors.New("cannot set telemetry platform in both telemetry and experimental")
+			}
+			if cfg.Telemetry == nil {
+				cfg.Telemetry = &TelemetryConfig{}
+			}
+			if cfg.Telemetry.Data == nil {
+				cfg.Telemetry.Data = &TelemetryData{}
+			}
+
+			cfg.Telemetry.Data.Platform = cfg.Experimental.Telemetry.Data.Platform
+			return nil
+		},
+	},
 	"objectStorage.maximumBackupCount": {
 		Selector: func(cfg *Config) (bool, any) {
 			val := cfg.ObjectStorage.MaximumBackupCount

diff --git a/install/installer/pkg/config/v1/experimental/experimental.go b/install/installer/pkg/config/v1/experimental/experimental.go
@@ -27,10 +27,11 @@ type Config struct {
 	WebApp     *WebAppConfig      `json:"webapp,omitempty"`
 	IDE        *IDEConfig         `json:"ide,omitempty"`
 	Common     *CommonConfig      `json:"common,omitempty"`
-	Telemetry  *TelemetryConfig   `json:"telemetry,omitempty"`
+	Telemetry  *TelemetryConfig   `json:"telemetry,omitempty"` // @deprecated
 	AgentSmith *agentSmith.Config `json:"agentSmith,omitempty"`
 }
 
+// @deprecated
 type TelemetryConfig struct {
 	Data struct {
 		Platform string `json:"platform"`