feat: allow users to bind to all interfaces when a proxy is enabled

- use a plugin trigger to see whether we should bind to all interfaces
- create a generic way of setting properties for a plugin
- migrate proxy-enabled to the new network property "bind-all-interfaces"
- add network:set subcommand

plugins/common/common.go

@@ -325,11 +325,11 @@ func VerifyAppName(appName string) (err error) {
 	dokkuRoot := MustGetEnv("DOKKU_ROOT")
 	appRoot := strings.Join([]string{dokkuRoot, appName}, "/")
 	if !DirectoryExists(appRoot) {
-		return fmt.Errorf("App %s does not exist: %v\n", appName, err)
+		return fmt.Errorf("app %s does not exist: %v", appName, err)
 	}
 	r, _ := regexp.Compile("^[a-z].*")
 	if !r.MatchString(appName) {
-		return fmt.Errorf("App name (%s) must begin with lowercase alphanumeric character\n", appName)
+		return fmt.Errorf("app name (%s) must begin with lowercase alphanumeric character", appName)
 	}
 	return err
 }

plugins/common/functions

@@ -538,11 +538,10 @@ dokku_deploy_cmd() {
   local cmd="deploy"
   source "$PLUGIN_AVAILABLE_PATH/checks/functions"
   source "$PLUGIN_AVAILABLE_PATH/config/functions"
-  source "$PLUGIN_AVAILABLE_PATH/proxy/functions"
 
   [[ -z $1 ]] && dokku_log_fail "Please specify an app to run the command on"
   local APP="$1" IMAGE_TAG="$2"
-  local DOKKU_HEROKUISH IMAGE
+  local DOKKU_DOCKER_STOP_TIMEOUT DOKKU_HEROKUISH DOKKU_NETWORK_BIND_ALL IMAGE
   DOKKU_HEROKUISH=false
   IMAGE=$(get_deploying_app_image_name "$APP" "$IMAGE_TAG")
   verify_app_name "$APP"
@@ -552,8 +551,8 @@ dokku_deploy_cmd() {
   local DOKKU_SCALE_FILE="$DOKKU_ROOT/$APP/DOKKU_SCALE"
   local oldids=$(get_app_container_ids "$APP")
 
-  local DOKKU_IS_APP_PROXY_ENABLED="$(is_app_proxy_enabled "$APP")"
-  local DOKKU_DOCKER_STOP_TIMEOUT="$(config_get "$APP" DOKKU_DOCKER_STOP_TIMEOUT || true)"
+  DOKKU_NETWORK_BIND_ALL="$(plugn trigger network-get-property "$APP" bind-all-interfaces)"
+  DOKKU_DOCKER_STOP_TIMEOUT="$(config_get "$APP" DOKKU_DOCKER_STOP_TIMEOUT || true)"
   [[ $DOKKU_DOCKER_STOP_TIMEOUT ]] && DOCKER_STOP_TIME_ARG="--time=${DOKKU_DOCKER_STOP_TIMEOUT}"
 
   local line; local PROC_TYPE; local PROC_COUNT; local CONTAINER_INDEX
@@ -605,7 +604,7 @@ dokku_deploy_cmd() {
           DOKKU_DOCKER_PORT_ARGS+=" -p $p "
         done
 
-        if [[ "$DOKKU_IS_APP_PROXY_ENABLED" == "true" ]]; then
+        if [[ "$DOKKU_NETWORK_BIND_ALL" == "false" ]]; then
           # shellcheck disable=SC2086
           cid=$(docker run $DOKKU_GLOBAL_RUN_ARGS -d -e PORT=$DOKKU_PORT $DOCKER_ARGS $IMAGE $START_CMD)
         else

plugins/common/log.go

@@ -36,10 +36,14 @@ func LogInfo2Quiet(text string) {
 	}
 }
 
+// LogVerbose is the verbose log formatter
+// prints indented text to stdout
 func LogVerbose(text string) {
 	fmt.Fprintln(os.Stdout, fmt.Sprintf("       %s", text))
 }
 
+// LogVerboseQuiet is the verbose log formatter
+// prints indented text to stdout (with quiet option)
 func LogVerboseQuiet(text string) {
 	if os.Getenv("DOKKU_QUIET_OUTPUT") != "" {
 		LogVerbose(text)

plugins/common/properties.go

@@ -0,0 +1,181 @@
+package common
+
+import (
+	"fmt"
+	"io/ioutil"
+	"os"
+	"os/user"
+	"reflect"
+	"strconv"
+	"strings"
+)
+
+// CommandPropertySet is a generic function that will set a property for a given plugin/app combination
+func CommandPropertySet(pluginName string, appName string, property string, value string, validProperties map[string]bool) {
+	err := VerifyAppName(appName)
+	if err != nil {
+		LogFail(err.Error())
+	}
+
+	if property == "" {
+		LogFail("No property specified")
+	}
+
+	if !isValidProperty(validProperties, property) {
+		properties := reflect.ValueOf(validProperties).MapKeys()
+		validPropertyList := make([]string, len(properties))
+		for i := 0; i < len(properties); i++ {
+			validPropertyList[i] = properties[i].String()
+		}
+
+		LogFail(fmt.Sprintf("Invalid property specified, valid properties include: %s", strings.Join(validPropertyList, ", ")))
+	}
+
+	if value != "" {
+		LogInfo2Quiet(fmt.Sprintf("Setting %s to %s", property, value))
+		PropertyWrite(pluginName, appName, property, value)
+	} else {
+		LogInfo2Quiet(fmt.Sprintf("Unsetting %s", property))
+		PropertyDelete(pluginName, appName, property)
+	}
+}
+
+// PropertyDelete deletes a property from the plugin properties for an app
+func PropertyDelete(pluginName string, appName string, property string) {
+	pluginAppConfigRoot := getPluginAppPropertyPath(pluginName, appName)
+	propertyPath := strings.Join([]string{pluginAppConfigRoot, property}, "/")
+	err := os.Remove(propertyPath)
+	if err != nil {
+		LogFail(fmt.Sprintf("Unable to remove %s property %s.%s", pluginName, appName, property))
+	}
+}
+
+// PropertyDestroy destroys the plugin properties for an app
+func PropertyDestroy(pluginName string, appName string) {
+	if appName == "_all_" {
+		pluginConfigPath := getPluginConfigPath(pluginName)
+		os.RemoveAll(pluginConfigPath)
+	} else {
+		pluginAppConfigRoot := getPluginAppPropertyPath(pluginName, appName)
+		os.RemoveAll(pluginAppConfigRoot)
+	}
+}
+
+// PropertyExists returns whether a property exists or not
+func PropertyExists(pluginName string, appName string, property string) bool {
+	pluginAppConfigRoot := getPluginAppPropertyPath(pluginName, appName)
+	propertyPath := strings.Join([]string{pluginAppConfigRoot, property}, "/")
+	_, err := os.Stat(propertyPath)
+	return !os.IsNotExist(err)
+}
+
+// PropertyGet returns the value for a given property
+func PropertyGet(pluginName string, appName string, property string) string {
+	return PropertyGetDefault(pluginName, appName, property, "")
+}
+
+// PropertyGetDefault returns the value for a given property with a specified default value
+func PropertyGetDefault(pluginName string, appName string, property string, defaultValue string) string {
+	if !PropertyExists(pluginName, appName, property) {
+		return ""
+	}
+
+	pluginAppConfigRoot := getPluginAppPropertyPath(pluginName, appName)
+	propertyPath := strings.Join([]string{pluginAppConfigRoot, property}, "/")
+
+	b, err := ioutil.ReadFile(propertyPath)
+	if err != nil {
+		LogWarn(fmt.Sprintf("Unable to read %s property %s.%s", pluginName, appName, property))
+		return ""
+	}
+
+	return string(b)
+}
+
+// PropertyWrite writes a value for a given application property
+func PropertyWrite(pluginName string, appName string, property string, value string) {
+	err := makePropertyPath(pluginName, appName)
+	if err != nil {
+		LogFail(fmt.Sprintf("Unable to create %s config directory for %s: %s", pluginName, appName, err.Error()))
+	}
+
+	pluginAppConfigRoot := getPluginAppPropertyPath(pluginName, appName)
+	propertyPath := strings.Join([]string{pluginAppConfigRoot, property}, "/")
+	file, err := os.Create(propertyPath)
+	if err != nil {
+		LogFail(fmt.Sprintf("Unable to write %s config value %s.%s: %s", pluginName, appName, property, err.Error))
+	}
+	defer file.Close()
+
+	fmt.Fprintf(file, value)
+	file.Chmod(0600)
+	setPermissions(propertyPath, 0600)
+}
+
+// PropertySetup creates the plugin config root
+func PropertySetup(pluginName string) error {
+	pluginConfigRoot := getPluginConfigPath(pluginName)
+	err := os.MkdirAll(pluginConfigRoot, 0755)
+	if err != nil {
+		return err
+	}
+	return setPermissions(pluginConfigRoot, 0755)
+}
+
+// isValidProperty returns whether a property is a valid property or not
+func isValidProperty(validProperties map[string]bool, property string) bool {
+	return validProperties[property]
+}
+
+// getPluginAppPropertyPath returns the plugin property path for a given plugin/app combination
+func getPluginAppPropertyPath(pluginName string, appName string) string {
+	return strings.Join([]string{getPluginConfigPath(pluginName), appName}, "/")
+}
+
+// getPluginConfigPath returns the plugin property path for a given plugin
+func getPluginConfigPath(pluginName string) string {
+	return strings.Join([]string{MustGetEnv("DOKKU_LIB_ROOT"), "config", pluginName}, "/")
+}
+
+// makePropertyPath ensures that a property path exists
+func makePropertyPath(pluginName string, appName string) error {
+	pluginAppConfigRoot := getPluginAppPropertyPath(pluginName, appName)
+	err := os.MkdirAll(pluginAppConfigRoot, 0755)
+	if err != nil {
+		return err
+	}
+	return setPermissions(pluginAppConfigRoot, 0755)
+}
+
+// setPermissions sets the proper owner and filemode for a given file
+func setPermissions(path string, fileMode os.FileMode) error {
+	err := os.Chmod(path, fileMode)
+	if err != nil {
+		return err
+	}
+
+	group, err := user.LookupGroup("dokku")
+	if err != nil {
+		return err
+	}
+	user, err := user.Lookup("dokku")
+	if err != nil {
+		return err
+	}
+
+	uid, err := strconv.Atoi(user.Uid)
+	if err != nil {
+		return err
+	}
+
+	gid, err := strconv.Atoi(group.Gid)
+	if err != nil {
+		return err
+	}
+
+	err = os.Chown(path, uid, gid)
+	if err != nil {
+		return err
+	}
+	return nil
+}

plugins/config/config.go

@@ -22,7 +22,7 @@ func GetWithDefault(appName string, key string, defaultValue string) string {
 			continue
 		}
 		value = strings.TrimPrefix(line, prefix)
-		if strings.HasPrefix(line, "'") && strings.HasSuffix(line, "'") {
+		if strings.HasPrefix(value, "'") && strings.HasSuffix(value, "'") {
 			value = strings.TrimPrefix(strings.TrimSuffix(value, "'"), "'")
 		}
 	}

plugins/network/.gitignore

@@ -1,3 +1,6 @@
 /commands
 /subcommands/*
 /network-*
+/install
+/post-create
+/post-delete

plugins/network/Makefile

@@ -8,17 +8,23 @@ build-in-docker: clean
 		bash -c "make build" || exit $$?
 
 build: commands subcommands triggers
-subcommands: subcommands/rebuild subcommands/rebuildall
-triggers: network-build-config network-compute-ports network-config-exists network-get-ipaddr network-get-listeners network-get-port network-write-ipaddr network-write-port
+subcommands: subcommands/rebuild subcommands/rebuildall subcommands/set
+triggers: install network-build-config network-compute-ports network-config-exists network-get-ipaddr network-get-listeners network-get-port network-get-property network-write-ipaddr network-write-port post-create post-delete
 commands: **/**/commands.go
 	go build -a -o commands src/commands/commands.go
 
 subcommands/rebuild: **/**/**/rebuild.go
-	go build -a -o subcommands/rebuild src/subcommands/rebuild/rebuild.go
+	go build -a -o subcommands/rebuild   src/subcommands/rebuild/rebuild.go
 
 subcommands/rebuildall: **/**/**/rebuildall.go
 	go build -a -o subcommands/rebuildall src/subcommands/rebuildall/rebuildall.go
 
+subcommands/set: **/**/**/set.go
+	go build -a -o subcommands/set   src/subcommands/set/set.go
+
+install: **/**/**/install.go
+	go build -a -o install  src/triggers/install/install.go
+
 network-build-config: **/**/**/network-build-config.go
 	go build -a -o network-build-config  src/triggers/network-build-config/network-build-config.go
 
@@ -37,14 +43,23 @@ network-get-listeners: **/**/**/network-get-listeners.go
 network-get-port: **/**/**/network-get-port.go
 	go build -a -o network-get-port      src/triggers/network-get-port/network-get-port.go
 
+network-get-property: **/**/**/network-get-property.go
+	go build -a -o network-get-property  src/triggers/network-get-property/network-get-property.go
+
 network-write-ipaddr: **/**/**/network-write-ipaddr.go
 	go build -a -o network-write-ipaddr  src/triggers/network-write-ipaddr/network-write-ipaddr.go
 
 network-write-port: **/**/**/network-write-port.go
 	go build -a -o network-write-port    src/triggers/network-write-port/network-write-port.go
 
+post-create: **/**/**/post-create.go
+	go build -a -o post-create           src/triggers/post-create/post-create.go
+
+post-delete: **/**/**/post-delete.go
+	go build -a -o post-delete           src/triggers/post-delete/post-delete.go
+
 clean:
-	rm -rf commands subcommands network-*
+	rm -rf commands subcommands network-* install post-create post-delete
 
 src-clean:
 	rm -rf .gitignore src vendor Makefile

plugins/network/network.go

@@ -12,6 +12,16 @@ import (
 	sh "github.com/codeskyblue/go-sh"
 )
 
+// ValidProperties is a map of all valid network properties
+var ValidProperties = map[string]bool{
+	"bind-all-interfaces": true,
+}
+
+// DefaultPropertyValues is a map of all valid network properties with corresponding default property values
+var DefaultPropertyValues = map[string]string{
+	"bind-all-interfaces": "false",
+}
+
 // BuildConfig builds network config files
 func BuildConfig(appName string) {
 	err := common.VerifyAppName(appName)
@@ -147,6 +157,14 @@ func GetContainerPort(appName string, procType string, isHerokuishContainer bool
 	return port
 }
 
+// GetDefaultValue returns the default value for a given property
+func GetDefaultValue(property string) string {
+	if ValidProperties[property] {
+		return DefaultPropertyValues[property]
+	}
+	return ""
+}
+
 // HasNetworkConfig returns whether the network configuration for a given app exists
 func HasNetworkConfig(appName string) bool {
 	appRoot := strings.Join([]string{common.MustGetEnv("DOKKU_ROOT"), appName}, "/")

plugins/network/src/commands/commands.go

@@ -20,6 +20,7 @@ Additional commands:`
 	helpContent = `
     network:rebuild <app>, Rebuilds network settings for an app
     network:rebuildall, Rebuild network settings for all apps
+    network:set <app> <property> (<value>), Set or clear a network property for an app
 `
 )
 

plugins/network/src/subcommands/set/set.go

@@ -0,0 +1,22 @@
+package main
+
+import (
+	"flag"
+
+	common "github.com/dokku/dokku/plugins/common"
+	network "github.com/dokku/dokku/plugins/network"
+)
+
+// set or clear a network property for an app
+func main() {
+	flag.Parse()
+	appName := flag.Arg(1)
+	property := flag.Arg(2)
+	value := flag.Arg(3)
+
+	if property == "bind-all-interfaces" && value == "" {
+		value = "false"
+	}
+
+	common.CommandPropertySet("network", appName, property, value, network.ValidProperties)
+}

plugins/network/src/triggers/install/install.go

@@ -0,0 +1,33 @@
+package main
+
+import (
+	"fmt"
+
+	common "github.com/dokku/dokku/plugins/common"
+	proxy "github.com/dokku/dokku/plugins/proxy"
+)
+
+// runs the install step for the network plugin
+func main() {
+	err := common.PropertySetup("network")
+	if err != nil {
+		common.LogFail(fmt.Sprintf("Unable to install the network plugin: %s", err.Error()))
+	}
+
+	apps, err := common.DokkuApps()
+	if err != nil {
+		return
+	}
+	for _, appName := range apps {
+		if common.PropertyExists("network", appName, "bind-all-interfaces") {
+			continue
+		}
+		if proxy.IsAppProxyEnabled(appName) {
+			common.LogVerboseQuiet("Setting %s network property 'bind-all-interfaces' to false")
+			common.PropertyWrite("network", appName, "bind-all-interfaces", "false")
+		} else {
+			common.LogVerboseQuiet("Setting %s network property 'bind-all-interfaces' to true")
+			common.PropertyWrite("network", appName, "bind-all-interfaces", "true")
+		}
+	}
+}

plugins/network/src/triggers/network-get-property/network-get-property.go

@@ -0,0 +1,18 @@
+package main
+
+import (
+	"flag"
+
+	common "github.com/dokku/dokku/plugins/common"
+	network "github.com/dokku/dokku/plugins/network"
+)
+
+// write the port to stdout for a given app container
+func main() {
+	flag.Parse()
+	appName := flag.Arg(0)
+	property := flag.Arg(1)
+
+	defaultValue := network.GetDefaultValue(property)
+	common.PropertyGetDefault("network", appName, property, defaultValue)
+}

plugins/network/src/triggers/post-create/post-create.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"flag"
+
+	common "github.com/dokku/dokku/plugins/common"
+)
+
+// set bind-all-interfaces to false by default
+func main() {
+	flag.Parse()
+	appName := flag.Arg(0)
+
+	common.PropertyWrite("network", appName, "bind-all-interfaces", "false")
+}

plugins/network/src/triggers/post-delete/post-delete.go

@@ -0,0 +1,15 @@
+package main
+
+import (
+	"flag"
+
+	common "github.com/dokku/dokku/plugins/common"
+)
+
+// write the port to stdout for a given app container
+func main() {
+	flag.Parse()
+	appName := flag.Arg(0)
+
+	common.PropertyDestroy("network", appName)
+}