Make usage report bucket name configurable

The name of the object storage bucket to which usage reports are
uploaded needs to be configurable for Gitpod SaaS. GCloud bucket names
are globally unique, so the bucket name must vary between staging and
production.

Author: Andrew Farries

components/content-service-api/go/config/config.go

@@ -114,7 +114,13 @@ type PProf struct {
 	Addr string `json:"address"`
 }
 
+// UsageReportConfig configures the upload of workspace instance usage reports
+type UsageReportConfig struct {
+	BucketName string `json:"bucketName"`
+}
+
 type ServiceConfig struct {
-	Service baseserver.ServerConfiguration `json:"service"`
-	Storage StorageConfig                  `json:"storage"`
+	Service      baseserver.ServerConfiguration `json:"service"`
+	Storage      StorageConfig                  `json:"storage"`
+	UsageReports UsageReportConfig              `json:"usageReport"`
 }

install/installer/pkg/components/content-service/configmap.go

@@ -11,18 +11,30 @@ import (
 
 	"github.com/gitpod-io/gitpod/content-service/api/config"
 	"github.com/gitpod-io/gitpod/installer/pkg/common"
+	"github.com/gitpod-io/gitpod/installer/pkg/config/v1/experimental"
 
 	corev1 "k8s.io/api/core/v1"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/runtime"
 )
 
 func configmap(ctx *common.RenderContext) ([]runtime.Object, error) {
+	usageReportBucketName := "gitpod-usage-reports"
+	_ = ctx.WithExperimental(func(cfg *experimental.Config) error {
+		if cfg.Workspace != nil && cfg.Workspace.ContentService.UsageReportBucketName != "" {
+			usageReportBucketName = cfg.Workspace.ContentService.UsageReportBucketName
+		}
+		return nil
+	})
+
 	cscfg := config.ServiceConfig{
 		Service: baseserver.ServerConfiguration{
 			Address: fmt.Sprintf(":%d", RPCPort),
 		},
 		Storage: common.StorageConfig(ctx),
+		UsageReports: config.UsageReportConfig{
+			BucketName: usageReportBucketName,
+		},
 	}
 
 	fc, err := common.ToJSONString(cscfg)

install/installer/pkg/components/content-service/configmap_test.go

@@ -0,0 +1,62 @@
+// Copyright (c) 2022 Gitpod GmbH. All rights reserved.
+// Licensed under the MIT License. See License-MIT.txt in the project root for license information.
+
+package content_service
+
+import (
+	"encoding/json"
+	"testing"
+
+	csconfig "github.com/gitpod-io/gitpod/content-service/api/config"
+	"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"
+	"github.com/gitpod-io/gitpod/installer/pkg/config/versions"
+	"github.com/stretchr/testify/require"
+	corev1 "k8s.io/api/core/v1"
+	"k8s.io/utils/pointer"
+)
+
+func TestConfigMap_CanConfigureUsageReportBucketName(t *testing.T) {
+	ctx := newRenderContext(t)
+	objs, err := configmap(ctx)
+	require.NoError(t, err)
+	require.Len(t, objs, 1, "must only render one configmap")
+
+	expectedUsageReportConfig := csconfig.UsageReportConfig{BucketName: "some-bucket-name"}
+	expectedJSON, err := common.ToJSONString(expectedUsageReportConfig)
+	require.NoError(t, err)
+
+	cm, ok := objs[0].(*corev1.ConfigMap)
+	require.True(t, ok)
+
+	var fullConfig csconfig.ServiceConfig
+	err = json.Unmarshal([]byte(cm.Data["config.json"]), &fullConfig)
+	require.NoError(t, err)
+
+	actualUsageReportConfig := fullConfig.UsageReports
+	actualJSON, err := common.ToJSONString(actualUsageReportConfig)
+	require.NoError(t, err)
+
+	require.JSONEq(t, string(expectedJSON), string(actualJSON))
+}
+
+func newRenderContext(t *testing.T) *common.RenderContext {
+	t.Helper()
+
+	ctx, err := common.NewRenderContext(config.Config{
+		Domain:        "test.domain.everything.awesome.is",
+		ObjectStorage: config.ObjectStorage{InCluster: pointer.Bool(true)},
+		Experimental: &experimental.Config{
+			Workspace: &experimental.WorkspaceConfig{
+				ContentService: struct {
+					UsageReportBucketName string "json:\"usageReportBucketName\""
+				}{UsageReportBucketName: "some-bucket-name"},
+			},
+		},
+	}, versions.Manifest{}, "test-namespace")
+
+	require.NoError(t, err)
+
+	return ctx
+}

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

@@ -103,6 +103,10 @@ type WorkspaceConfig struct {
 		GitpodInstallationWorkspaceHostSuffix      string `json:"gitpodInstallationWorkspaceHostSuffix"`
 		GitpodInstallationWorkspaceHostSuffixRegex string `json:"gitpodInstallationWorkspaceHostSuffixRegex"`
 	} `json:"wsProxy"`
+
+	ContentService struct {
+		UsageReportBucketName string `json:"usageReportBucketName"`
+	} `json:"contentService"`
 }
 
 type PersistentVolumeClaim struct {