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
This commit is contained in:
@@ -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"
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user