feat: migrate environment variables to plugin properties

Standardize how environment variables are migrated to properties during
install triggers and migrate all remaining DOKKU_* config vars to their
appropriate plugin properties.

Adds a reusable MigrateConfigToProperties() function in the common
package with Transform callback and ListProperty support, plus a
migrate-config-to-property subcommand for the prop binary so shell
plugins can use the same code path.

Migrated variables and their new property owners:
- DOKKU_APP_PROXY_TYPE/DOKKU_PROXY_TYPE → proxy type
- DOKKU_DISABLE_PROXY → proxy disabled
- DOKKU_PROXY_PORT → ports proxy-port
- DOKKU_PROXY_SSL_PORT → ports proxy-ssl-port
- DOKKU_APP_RESTORE → ps restore
- DOKKU_SKIP_DEPLOY → ps skip-deploy
- DOKKU_START_CMD → ps start-cmd
- DOKKU_DOCKERFILE_START_CMD → ps dockerfile-start-cmd
- DOKKU_DISABLE_APP_AUTOCREATION → apps disable-autocreation
- DOKKU_APP_SHELL → scheduler shell
- DOKKU_SKIP_CLEANUP → builder skip-cleanup
- DOKKU_CHECKS_DISABLED → checks disabled
- DOKKU_CHECKS_SKIPPED → checks skipped
- DOKKU_CHECKS_WAIT → checks wait
- DOKKU_CHECKS_TIMEOUT → checks timeout
- DOKKU_CHECKS_ATTEMPTS → checks attempts
- DOKKU_DEFAULT_CHECKS_WAIT → checks default-wait
- DOKKU_SKIP_ALL_CHECKS → checks disabled (legacy)
- DOKKU_SKIP_DEFAULT_CHECKS → checks skipped (legacy)

Also refactors existing bespoke migration loops in scheduler, ports, ps,
builder, and nginx-vhosts plugins to use the standardized utility.

Removes DOKKU_PARALLEL_ARGUMENTS from documentation (unused in core).
Deprecates fn-migrate-config-to-property bash function.

closes #1558

plugins/proxy/Makefile

@@ -1,5 +1,5 @@
 SUBCOMMANDS = subcommands/build-config subcommands/clear-config subcommands/disable subcommands/enable subcommands/ports subcommands/ports-add subcommands/ports-clear subcommands/ports-remove subcommands/ports-set subcommands/report subcommands/set
-TRIGGERS = triggers/proxy-is-enabled triggers/proxy-type triggers/report
+TRIGGERS = triggers/install triggers/proxy-is-enabled triggers/proxy-type triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-delete triggers/report
 BUILD = commands subcommands triggers
 PLUGIN_NAME = proxy
 

plugins/proxy/functions.go

@@ -1,11 +1,11 @@
 package proxy
 
 import (
-	"github.com/dokku/dokku/plugins/config"
+	"github.com/dokku/dokku/plugins/common"
 )
 
 func getAppProxyType(appName string) string {
-	return config.GetWithDefault(appName, "DOKKU_APP_PROXY_TYPE", "")
+	return common.PropertyGet("proxy", appName, "type")
 }
 
 func getComputedProxyType(appName string) string {
@@ -18,5 +18,5 @@ func getComputedProxyType(appName string) string {
 }
 
 func getGlobalProxyType() string {
-	return config.GetWithDefault("--global", "DOKKU_PROXY_TYPE", "nginx")
+	return common.PropertyGetDefault("proxy", "--global", "type", "nginx")
 }

plugins/proxy/proxy.go

@@ -2,13 +2,25 @@ package proxy
 
 import (
 	"github.com/dokku/dokku/plugins/common"
-	"github.com/dokku/dokku/plugins/config"
 )
 
 // RunInSerial is the default value for whether to run a command in parallel or not
 // and defaults to -1 (false)
 const RunInSerial = 0
 
+var (
+	// DefaultProperties is a map of all valid proxy properties with corresponding default property values
+	DefaultProperties = map[string]string{
+		"disabled": "false",
+		"type":     "",
+	}
+
+	// GlobalProperties is a map of all valid global proxy properties
+	GlobalProperties = map[string]bool{
+		"type": true,
+	}
+)
+
 // BuildConfig rebuilds the proxy config for the specified app
 func BuildConfig(appName string) error {
 	_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
@@ -37,11 +49,7 @@ func Disable(appName string) error {
 	}
 
 	common.LogInfo1("Disabling proxy for app")
-	entries := map[string]string{
-		"DOKKU_DISABLE_PROXY": "1",
-	}
-
-	if err := config.SetMany(appName, entries, false, false); err != nil {
+	if err := common.PropertyWrite("proxy", appName, "disabled", "true"); err != nil {
 		return err
 	}
 
@@ -61,10 +69,10 @@ func Enable(appName string) error {
 	}
 
 	common.LogInfo1("Enabling proxy for app")
-	keys := []string{"DOKKU_DISABLE_PROXY"}
-	if err := config.UnsetMany(appName, keys, false); err != nil {
+	if err := common.PropertyDelete("proxy", appName, "disabled"); err != nil {
 		return err
 	}
+
 	_, err := common.CallPlugnTrigger(common.PlugnTriggerInput{
 		Trigger:     "proxy-enable",
 		Args:        []string{appName},
@@ -75,10 +83,5 @@ func Enable(appName string) error {
 
 // IsAppProxyEnabled returns true if proxy is enabled; otherwise return false
 func IsAppProxyEnabled(appName string) bool {
-	proxyEnabled := true
-	disableProxy := config.GetWithDefault(appName, "DOKKU_DISABLE_PROXY", "")
-	if disableProxy != "" {
-		proxyEnabled = false
-	}
-	return proxyEnabled
+	return common.PropertyGetDefault("proxy", appName, "disabled", "false") != "true"
 }

plugins/proxy/src/triggers/triggers.go

@@ -18,12 +18,25 @@ func main() {
 
 	var err error
 	switch trigger {
+	case "install":
+		err = proxy.TriggerInstall()
 	case "proxy-is-enabled":
 		appName := flag.Arg(0)
 		err = proxy.TriggerProxyIsEnabled(appName)
 	case "proxy-type":
 		appName := flag.Arg(0)
 		err = proxy.TriggerProxyType(appName)
+	case "post-app-clone-setup":
+		oldAppName := flag.Arg(0)
+		newAppName := flag.Arg(1)
+		err = proxy.TriggerPostAppCloneSetup(oldAppName, newAppName)
+	case "post-app-rename-setup":
+		oldAppName := flag.Arg(0)
+		newAppName := flag.Arg(1)
+		err = proxy.TriggerPostAppRenameSetup(oldAppName, newAppName)
+	case "post-delete":
+		appName := flag.Arg(0)
+		err = proxy.TriggerPostDelete(appName)
 	case "report":
 		appName := flag.Arg(0)
 		err = proxy.ReportSingleApp(appName, "", "")

plugins/proxy/subcommands.go

@@ -5,7 +5,6 @@ import (
 	"strings"
 
 	"github.com/dokku/dokku/plugins/common"
-	"github.com/dokku/dokku/plugins/config"
 )
 
 // CommandBuildConfig rebuilds config for a given app
@@ -99,12 +98,6 @@ func CommandSet(appName string, proxyType string) error {
 		return errors.New("Consider using ports:set command or specifying a valid proxy")
 	}
 
-	key := "DOKKU_APP_PROXY_TYPE"
-	if appName == "--global" {
-		key = "DOKKU_PROXY_TYPE"
-	}
-	entries := map[string]string{
-		key: proxyType,
-	}
-	return config.SetMany(appName, entries, false, false)
+	common.CommandPropertySet("proxy", appName, "type", proxyType, DefaultProperties, GlobalProperties)
+	return nil
 }

plugins/proxy/triggers.go

@@ -2,8 +2,39 @@ package proxy
 
 import (
 	"fmt"
+
+	"github.com/dokku/dokku/plugins/common"
 )
 
+// TriggerInstall runs the install step for the proxy plugin
+func TriggerInstall() error {
+	if err := common.PropertySetup("proxy"); err != nil {
+		return fmt.Errorf("Unable to install the proxy plugin: %s", err.Error())
+	}
+
+	if err := common.MigrateConfigToProperties("proxy", []common.MigrateConfigEntry{
+		{
+			ConfigVar:       "DOKKU_APP_PROXY_TYPE",
+			GlobalConfigVar: "DOKKU_PROXY_TYPE",
+			Property:        "type",
+		},
+		{
+			ConfigVar: "DOKKU_DISABLE_PROXY",
+			Property:  "disabled",
+			Transform: func(value string) string {
+				if value != "" {
+					return "true"
+				}
+				return value
+			},
+		},
+	}); err != nil {
+		return err
+	}
+
+	return nil
+}
+
 // TriggerProxyIsEnabled prints true or false depending on whether the proxy is enabled
 func TriggerProxyIsEnabled(appName string) error {
 	if IsAppProxyEnabled(appName) {
@@ -22,3 +53,22 @@ func TriggerProxyType(appName string) error {
 
 	return nil
 }
+
+// TriggerPostAppCloneSetup creates new proxy files
+func TriggerPostAppCloneSetup(oldAppName string, newAppName string) error {
+	return common.PropertyClone("proxy", oldAppName, newAppName)
+}
+
+// TriggerPostAppRenameSetup renames proxy files
+func TriggerPostAppRenameSetup(oldAppName string, newAppName string) error {
+	if err := common.PropertyClone("proxy", oldAppName, newAppName); err != nil {
+		return err
+	}
+
+	return common.PropertyDestroy("proxy", oldAppName)
+}
+
+// TriggerPostDelete destroys the proxy property for a given app container
+func TriggerPostDelete(appName string) error {
+	return common.PropertyDestroy("proxy", appName)
+}