feat: server configuration

Author: saitho

Documentation/introduction/cli-configuration.md

@@ -7,6 +7,11 @@ This file is used to configure which StackHead modules to use.
 You may define additional module configurations within the `modules_config` key.
 See example below for setting the setting _server_names_hash_bucket_size_ for the Nginx proxy module.
 
+{% hint style="warning" %}
+The `modules`, `modules_config` and `terraform` settings may be overwritten via server configuration.
+The server configuration is located in `/stackhead/config.yml` (if it exists).
+{% endhint %}
+
 ## Full annotated configuration
 
 ```yaml

commands/prepare_context.go

@@ -1,20 +1,71 @@
 package commands
 
 import (
+	"github.com/knadh/koanf/maps"
+	xfs "github.com/saitho/golang-extended-fs/v2"
+	logger "github.com/sirupsen/logrus"
+	"github.com/spf13/cast"
 	"github.com/spf13/viper"
+	"gopkg.in/yaml.v3"
+
+	"github.com/getstackhead/stackhead/config"
+	"github.com/getstackhead/stackhead/project"
+	"github.com/getstackhead/stackhead/system"
 
 	container_docker "github.com/getstackhead/stackhead/modules/container/docker"
 	dns_cloudflare "github.com/getstackhead/stackhead/modules/dns/cloudflare"
 	plugin_portainer "github.com/getstackhead/stackhead/modules/plugin/portainer"
 	proxy_caddy "github.com/getstackhead/stackhead/modules/proxy/caddy"
 	proxy_nginx "github.com/getstackhead/stackhead/modules/proxy/nginx"
-	"github.com/getstackhead/stackhead/project"
-	"github.com/getstackhead/stackhead/system"
 )
 
+func EnforceSimpleValueOption(name string, value map[string]interface{}) {
+	stringMap := viper.GetStringMap(name)
+	for mapKey, mapValue := range value {
+		stringMap[mapKey] = mapValue
+		logger.Warnf("Enforcing setting \"%s.%s=%v\" via remote server configuration", name, mapKey, mapValue)
+	}
+	viper.Set(name, stringMap)
+}
+
+func EnforceNestedValueOption(name string, value map[string]interface{}) {
+	modulesConfigMap := viper.GetStringMap(name)
+	for moduleName, moduleConfig := range cast.ToStringMap(value) {
+		remoteSettings := cast.ToStringMap(moduleConfig)
+		logMessage := "Enforcing module settings for \"" + moduleName + "\" via remote server configuration"
+		// todo: uncomment when we can sanitize secrets in CLI output
+		//for k, v := range remoteSettings {
+		//	logMessage += fmt.Sprintf("\n"+k+"=%v", v)
+		//}
+		logger.Warn(logMessage)
+		newMap := cast.ToStringMap(modulesConfigMap[moduleName])
+		maps.Merge(remoteSettings, newMap)
+		modulesConfigMap[moduleName] = newMap
+	}
+	viper.Set(name, modulesConfigMap)
+}
+
 func PrepareContext(host string, action string, projectDefinition *project.Project) {
 	system.InitializeContext(host, action, projectDefinition)
 
+	// Check remote config on server
+	hasFile, _ := xfs.HasFile("ssh://" + config.GetServerConfigFilePath())
+	if hasFile {
+		fileContent, err := xfs.ReadFile("ssh://" + config.GetServerConfigFilePath())
+		if err != nil {
+			panic("Found remote config file but was unable to read it: " + err.Error())
+		}
+		var c map[string]interface{}
+		if err = yaml.Unmarshal([]byte(fileContent), &c); err != nil {
+			panic("Found remote config file but was unable to parse it: " + err.Error())
+		}
+
+		// Enforce remote configurations on viper
+		EnforceSimpleValueOption("modules", cast.ToStringMap(c["modules"]))
+		EnforceNestedValueOption("modules_config", cast.ToStringMap(c["modules_config"]))
+		EnforceSimpleValueOption("terraform", cast.ToStringMap(c["terraform"]))
+	}
+
 	// set proxy
 	switch viper.GetStringMapString("modules")["proxy"] {
 	case "nginx":

config/paths.go

@@ -11,6 +11,10 @@ var RootDirectory = "/stackhead"
 var RootTerraformDirectory = RootDirectory + "/terraform"
 var ProjectsRootDirectory = RootDirectory + "/projects"
 
+func GetServerConfigFilePath() string {
+	return path.Join(RootDirectory, "config.yml")
+}
+
 func GetLocalStackHeadConfigDir() string {
 	configDirs := configdir.New("getstackhead", "stackhead")
 	folders := configDirs.QueryFolders(configdir.Global)

go.mod

@@ -18,10 +18,12 @@ require (
 	github.com/google/go-cmp v0.5.8
 	github.com/gookit/event v1.0.6
 	github.com/hairyhenderson/gomplate/v3 v3.11.2
+	github.com/knadh/koanf v1.4.4
 	github.com/phayes/freeport v0.0.0-20220201140144-74d24b5ae9f5
 	github.com/saitho/golang-extended-fs/v2 v2.0.2
 	github.com/shibukawa/configdir v0.0.0-20170330084843-e180dbdc8da0
 	github.com/sirupsen/logrus v1.8.1
+	github.com/spf13/cast v1.3.1
 	golang.org/x/crypto v0.0.0-20220525230936-793ad666bf5e
 	golang.org/x/exp v0.0.0-20220722155223-a9213eeb770e
 	gopkg.in/yaml.v3 v3.0.1
@@ -134,7 +136,6 @@ require (
 	github.com/sergi/go-diff v1.2.0 // indirect
 	github.com/shopspring/decimal v1.2.0 // indirect
 	github.com/spf13/afero v1.8.2 // indirect
-	github.com/spf13/cast v1.3.1 // indirect
 	github.com/spf13/jwalterweatherman v1.1.0 // indirect
 	github.com/spf13/pflag v1.0.5 // indirect
 	github.com/subosito/gotenv v1.2.0 // indirect