[installer]: build the config

install/installer/cmd/README.md

@@ -0,0 +1,35 @@
+# Cmd
+
+Publicly available commands are part of our user contract. They use [Cobra](https://cobra.dev/) to build the Golang CLI commands.
+
+## Commands
+
+### config
+
+These are designed to manipulate configuration files and generate a configuration file that can be used to install Gitpod.
+
+#### init
+
+> This replaces `init`, which is now deprecated
+
+This should be run first. This will generate a new `gitpod.config.yaml` file with the default values configured.
+
+#### build-from-envvars
+
+This builds the config from environment variables.
+
+#### cluster
+
+Cluster commands are designed to deploy a Kubernetes resource to the cluster and generate the config value based upon the result. Typically (although not exclusively), these will be Jobs.
+
+##### shiftfs
+
+Detects whether ShiftFS is supported on the cluster for building images. If not, this will default to Fuse.
+
+#### files
+
+Files commands are designed to be run against the file structure. They may be run directly on the node, or by mounting the file system as a volume in a pod.
+
+##### containerd
+
+Detects the containerd settings for a cluster. This will return the location of the containerd socket and the path to the directory.

install/installer/cmd/config_build-from-envvars.go

@@ -0,0 +1,40 @@
+// 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 cmd
+
+import (
+	"github.com/gitpod-io/gitpod/installer/pkg/config"
+	"github.com/spf13/cobra"
+)
+
+// configBuildFromEnvvarsCmd represents the validate command
+var configBuildFromEnvvarsCmd = &cobra.Command{
+	Use:   "build-from-envvars",
+	Short: "Build configuration from environment variables",
+	RunE: func(cmd *cobra.Command, args []string) error {
+		if _, err := configFileExistsAndInit(); err != nil {
+			return err
+		}
+
+		_, version, cfg, err := loadConfig(configOpts.ConfigFile)
+		if err != nil {
+			return err
+		}
+
+		apiVersion, err := config.LoadConfigVersion(version)
+		if err != nil {
+			return err
+		}
+
+		if err := apiVersion.BuildFromEnvvars(cfg); err != nil {
+			return err
+		}
+
+		return saveConfigFile(cfg)
+	},
+}
+
+func init() {
+	configCmd.AddCommand(configBuildFromEnvvarsCmd)
+}

install/installer/cmd/render.go

@@ -245,7 +245,7 @@ func init() {
 	}
 
 	renderCmd.PersistentFlags().StringVarP(&renderOpts.ConfigFN, "config", "c", getEnvvar("GITPOD_INSTALLER_CONFIG", filepath.Join(dir, "gitpod.config.yaml")), "path to the config file, use - for stdin")
-	renderCmd.PersistentFlags().StringVarP(&renderOpts.Namespace, "namespace", "n", "default", "namespace to deploy to")
+	renderCmd.PersistentFlags().StringVarP(&renderOpts.Namespace, "namespace", "n", getEnvvar("NAMESPACE", "default"), "namespace to deploy to")
 	renderCmd.Flags().BoolVar(&renderOpts.ValidateConfigDisabled, "no-validation", false, "if set, the config will not be validated before running")
 	renderCmd.Flags().BoolVar(&renderOpts.UseExperimentalConfig, "use-experimental-config", false, "enable the use of experimental config that is prone to be changed")
 	renderCmd.Flags().StringVar(&renderOpts.FilesDir, "output-split-files", "", "path to output individual Kubernetes manifests to")

install/installer/cmd/validate_cluster.go

@@ -111,5 +111,5 @@ func init() {
 
 	validateClusterCmd.PersistentFlags().StringVar(&validateClusterOpts.Kube.Config, "kubeconfig", "", "path to the kubeconfig file")
 	validateClusterCmd.PersistentFlags().StringVarP(&validateClusterOpts.Config, "config", "c", getEnvvar("GITPOD_INSTALLER_CONFIG", filepath.Join(dir, "gitpod.config.yaml")), "path to the config file")
-	validateClusterCmd.PersistentFlags().StringVarP(&validateClusterOpts.Namespace, "namespace", "n", "default", "namespace to deploy to")
+	validateClusterCmd.PersistentFlags().StringVarP(&validateClusterOpts.Namespace, "namespace", "n", getEnvvar("NAMESPACE", "default"), "namespace to deploy to")
 }

install/installer/go.mod

@@ -122,6 +122,7 @@ require (
 	github.com/go-redis/redis/v7 v7.4.1 // indirect
 	github.com/go-redis/redis/v8 v8.11.5 // indirect
 	github.com/go-sql-driver/mysql v1.6.0 // indirect
+	github.com/go-test/deep v1.0.8
 	github.com/gobwas/glob v0.2.3 // indirect
 	github.com/goccy/go-yaml v1.9.5 // indirect
 	github.com/godbus/dbus/v5 v5.0.6 // indirect

install/installer/pkg/config/loader.go

@@ -51,6 +51,9 @@ type ConfigVersion interface {
 	// CheckDeprecated checks for deprecated config params.
 	// Returns key/value pair of deprecated params/values and any error messages (used for conflicting params)
 	CheckDeprecated(cfg interface{}) (map[string]interface{}, []string)
+
+	// BuildFromEnvvars builds the configuration file from assigned envvars
+	BuildFromEnvvars(cfg interface{}) error
 }
 
 // AddVersion adds a new version.

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

@@ -34,21 +34,28 @@ func (v version) Factory() interface{} {
 		},
 	}
 }
+
+const (
+	defaultRepositoryUrl  = "eu.gcr.io/gitpod-core-dev/build"
+	defaultOpenVSXURL     = "https://open-vsx.org"
+	defaultMetadataRegion = "local"
+)
+
 func (v version) Defaults(in interface{}) error {
 	cfg, ok := in.(*Config)
 	if !ok {
 		return config.ErrInvalidType
 	}
 
 	cfg.Kind = InstallationFull
-	cfg.Repository = "eu.gcr.io/gitpod-core-dev/build"
+	cfg.Repository = defaultRepositoryUrl
 	cfg.Observability = Observability{
 		LogLevel: LogLevelInfo,
 	}
 	cfg.Certificate.Kind = ObjectRefSecret
 	cfg.Certificate.Name = "https-certificates"
 	cfg.Database.InCluster = pointer.Bool(true)
-	cfg.Metadata.Region = "local"
+	cfg.Metadata.Region = defaultMetadataRegion
 	cfg.Metadata.InstallationShortname = InstallationShortNameOldDefault // TODO(gpl): we're tied to "default" here because that's what we put into static bridges in the past
 	cfg.ObjectStorage.InCluster = pointer.Bool(true)
 	cfg.ObjectStorage.Resources = &Resources{
@@ -69,7 +76,7 @@ func (v version) Defaults(in interface{}) error {
 	cfg.Workspace.PVC.Size = resource.MustParse("30Gi")
 	cfg.Workspace.PVC.StorageClass = ""
 	cfg.Workspace.PVC.SnapshotClass = ""
-	cfg.OpenVSX.URL = "https://open-vsx.org"
+	cfg.OpenVSX.URL = defaultOpenVSXURL
 	cfg.DisableDefinitelyGP = true
 
 	return nil