github/dokku
0
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

refactor: move the proxy port map from config to property

Browse Source 
Also remove all direct references to DOKKU_PROXY_PORT_MAP from outside of ports.
This commit is contained in:
Jose Diaz-Gonzalez
2023-07-09 18:35:42 -04:00
parent 977b4567f8
commit f842869c3d
10 changed files with 157 additions and 31 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/appendices/0.31.0-migration-guide.md
View File

@@ -7,6 +7,7 @@
- The `traefik` integration now mounts config to `/data` instead of the path `/acme.json`, fixing permissions issues under certain architectures. To take advantage of the new functionality, the traefik container should be stopped (via `dokku traefik:stop`) and then started (via `dokku traefik:start`).
- Users no longer need to clear the `source-image` git property when transitioning from image-based deploys (`git:from-image` and `git:load-image`) to other deployment methods (git push, `git:from-archive`, `git:sync`).
- For deploys via the `git:from-image` and `git:load-image` commands, the `CHECKS` file is now extracted from the configured `WORKDIR` property of the image. For all other deploys - git push, `git:from-archive`, `git:sync` - will have the `CHECKS` extracted directly from the source code. The filename in both cases is `CHECKS` and cannot be modified.
- The environment variable `DOKKU_PROXY_PORT_MAP` has been migrated to the properties system. Direct changes to the value will be ignored, and users should interact with port maps via the `ports` plugin.
## Deprecations

1
docs/configuration/environment-variables.md
View File

@@ -116,7 +116,6 @@ The following config variables have special meanings and can be set in a variety
| `DOKKU_PARALLEL_ARGUMENTS`. | none | `dokku config:set` | Allows passing custom arguments to parallel for `ps:*all` commands |
| `DOKKU_PROXY_PORT` | automatically assigned | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` <br /> `dokku config:set` | |
| `DOKKU_PROXY_SSL_PORT` | automatically assigned | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` <br /> `dokku config:set` | |
| `DOKKU_PROXY_PORT_MAP` | automatically assigned | `dokku ports:add` <br /> `dokku ports:remove`, `dokku ports:clear` | |
| `DOKKU_SKIP_ALL_CHECKS` | none | `dokku config:set` | |
| `DOKKU_SKIP_CLEANUP` | | `/etc/environment` <br /> `~dokku/.dokkurc` <br /> `~dokku/.dokkurc/*` | When a deploy is triggered, if this is set to a non-empty value, then old docker containers and images will not be removed. |
| `DOKKU_SKIP_DEFAULT_CHECKS` | | `dokku config:set` | |

4
docs/networking/port-management.md
View File

@@ -84,8 +84,6 @@ dokku ports:add node-js-app http:8080:5000
```
```
-----> Setting config vars
DOKKU_PROXY_PORT_MAP: http:80:5000 http:8080:5000
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating http nginx.conf
Reloading nginx
@@ -120,8 +118,6 @@ dokku ports:set node-js-app http:8080:5000
```
```
-----> Setting config vars
DOKKU_PROXY_PORT_MAP: http:80:5000 http:8080:5000
-----> Configuring node-js-app.dokku.me...(using built-in template)
-----> Creating http nginx.conf
Reloading nginx

4
docs/networking/proxies/nginx.md
View File

@@ -376,8 +376,8 @@ Unsetting this value is the same as enabling custom nginx config usage.
{{ .PROXY_PORT }} Non-SSL nginx listener port (same as `DOKKU_PROXY_PORT` config var)
{{ .PROXY_SSL_PORT }} SSL nginx listener port (same as `DOKKU_PROXY_SSL_PORT` config var)
{{ .NOSSL_SERVER_NAME }} List of non-SSL VHOSTS
{{ .PROXY_PORT_MAP }} List of port mappings (same as `DOKKU_PROXY_PORT_MAP` config var)
{{ .PROXY_UPSTREAM_PORTS }} List of configured upstream ports (derived from `DOKKU_PROXY_PORT_MAP` config var)
{{ .PROXY_PORT_MAP }} List of port mappings (same as the `port-map` ports property)
{{ .PROXY_UPSTREAM_PORTS }} List of configured upstream ports (derived from the `port-map` ports property)
{{ .RAW_TCP_PORTS }} List of exposed tcp ports as defined by Dockerfile `EXPOSE` directive (**Dockerfile apps only**)
{{ .SSL_INUSE }} Boolean set when an app is SSL-enabled
{{ .SSL_SERVER_NAME }} List of SSL VHOSTS

2
plugins/ports/Makefile
View File

@@ -1,5 +1,5 @@
SUBCOMMANDS = subcommands/list subcommands/add subcommands/clear subcommands/remove subcommands/set subcommands/report
TRIGGERS = triggers/ports-clear triggers/ports-configure triggers/ports-dockerfile-raw-tcp-ports triggers/ports-get triggers/ports-get-available triggers/post-certs-remove triggers/post-certs-update triggers/report
TRIGGERS = triggers/install triggers/ports-clear triggers/ports-configure triggers/ports-dockerfile-raw-tcp-ports triggers/ports-get triggers/ports-get-available triggers/post-app-clone-setup triggers/post-app-rename-setup triggers/post-certs-remove triggers/post-certs-update triggers/post-delete triggers/report
BUILD = commands subcommands triggers
PLUGIN_NAME = ports

25
plugins/ports/functions.go
View File

@@ -23,10 +23,7 @@ func addPortMaps(appName string, portMaps []PortMap) error {
}
func clearPorts(appName string) error {
return common.EnvWrap(func() error {
keys := []string{"DOKKU_PROXY_PORT_MAP"}
return config.UnsetMany(appName, keys, false)
}, map[string]string{"DOKKU_QUIET_OUTPUT": "1"})
return common.PropertyDelete("ports", appName, "port-map")
}
func doesCertExist(appName string) bool {
@@ -118,8 +115,12 @@ func getGlobalProxySSLPort() int {
}
func getPortMaps(appName string) []PortMap {
value := config.GetWithDefault(appName, "DOKKU_PROXY_PORT_MAP", "")
portMaps, _ := parsePortMapString(value)
value, err := common.PropertyListGet("ports", appName, "port-map")
if err != nil {
return []PortMap{}
}
portMaps, _ := parsePortMapString(strings.Join(value, " "))
return portMaps
}
@@ -363,8 +364,7 @@ func removePortMaps(appName string, portMaps []PortMap) error {
}
if len(toSet) == 0 {
keys := []string{"DOKKU_PROXY_PORT_MAP"}
return config.UnsetMany(appName, keys, false)
return common.PropertyDelete("ports", appName, "port-map")
}
return setPortMaps(appName, toSet)
@@ -380,13 +380,8 @@ func setPortMaps(appName string, portMaps []PortMap) error {
value = append(value, portMap.String())
}
return common.EnvWrap(func() error {
sort.Strings(value)
entries := map[string]string{
"DOKKU_PROXY_PORT_MAP": strings.Join(value, " "),
}
return config.SetMany(appName, entries, false)
}, map[string]string{"DOKKU_QUIET_OUTPUT": "1"})
sort.Strings(value)
return common.PropertyListWrite("ports", appName, "port-map", value)
}
func setProxyPort(appName string, port int) error {

13
plugins/ports/src/triggers/triggers.go
View File

@@ -18,6 +18,8 @@ func main() {
var err error
switch trigger {
case "install":
err = ports.TriggerInstall()
case "ports-clear":
appName := flag.Arg(0)
err = ports.TriggerPortsClear(appName)
@@ -32,12 +34,23 @@ func main() {
err = ports.TriggerPortsGet(appName)
case "ports-get-available":
err = ports.TriggerPortsGetAvailable()
case "post-app-clone-setup":
oldAppName := flag.Arg(0)
newAppName := flag.Arg(1)
err = ports.TriggerPostAppCloneSetup(oldAppName, newAppName)
case "post-app-rename-setup":
oldAppName := flag.Arg(0)
newAppName := flag.Arg(1)
err = ports.TriggerPostAppRenameSetup(oldAppName, newAppName)
case "post-certs-remove":
appName := flag.Arg(0)
err = ports.TriggerPostCertsRemove(appName)
case "post-certs-update":
appName := flag.Arg(0)
err = ports.TriggerPostCertsUpdate(appName)
case "post-delete":
appName := flag.Arg(0)
err = ports.TriggerPostDelete(appName)
case "report":
appName := flag.Arg(0)
err = ports.ReportSingleApp(appName, "", "")

69
plugins/ports/triggers.go
View File

@@ -7,6 +7,43 @@ import (
"github.com/dokku/dokku/plugins/config"
)
// TriggerInstall migrates the ports config to properties
func TriggerInstall() error {
if err := common.PropertySetup("ports"); err != nil {
return fmt.Errorf("Unable to install the ports plugin: %s", err.Error())
}
apps, err := common.UnfilteredDokkuApps()
if err != nil {
return nil
}
for _, appName := range apps {
if common.PropertyExists("ports", appName, "port-map") {
continue
}
common.LogInfo1(fmt.Sprintf("Migrating DOKKU_PROXY_PORT_MAP to port-map property for %s", appName))
portMapString := config.GetWithDefault(appName, "DOKKU_PROXY_PORT_MAP", "")
portMaps, _ := parsePortMapString(portMapString)
propertyValue := []string{}
for _, portMap := range portMaps {
propertyValue = append(propertyValue, portMap.String())
}
if err := common.PropertyListWrite("ports", appName, "port-map", propertyValue); err != nil {
return err
}
if err := config.UnsetMany(appName, []string{"DOKKU_PROXY_PORT_MAP"}, false); err != nil {
return err
}
}
return nil
}
// TriggerPortsClear removes all ports for the specified app
func TriggerPortsClear(appName string) error {
return clearPorts(appName)
@@ -64,6 +101,29 @@ func TriggerPortsGetAvailable() error {
return nil
}
// TriggerPostAppCloneSetup creates new ports files
func TriggerPostAppCloneSetup(oldAppName string, newAppName string) error {
err := common.PropertyClone("ports", oldAppName, newAppName)
if err != nil {
return err
}
return nil
}
// TriggerPostAppRenameSetup renames ports files
func TriggerPostAppRenameSetup(oldAppName string, newAppName string) error {
if err := common.PropertyClone("ports", oldAppName, newAppName); err != nil {
return err
}
if err := common.PropertyDestroy("ports", oldAppName); err != nil {
return err
}
return nil
}
// TriggerPostCertsRemove unsets port config vars after SSL cert is added
func TriggerPostCertsRemove(appName string) error {
keys := []string{"DOKKU_PROXY_SSL_PORT"}
@@ -129,3 +189,12 @@ func TriggerPostCertsUpdate(appName string) error {
return nil
}
// TriggerPostDelete is the ports post-delete plugin trigger
func TriggerPostDelete(appName string) error {
if err := common.PropertyDestroy("ports", appName); err != nil {
common.LogWarn(err.Error())
}
return nil
}

19
tests/unit/apps_2.bats
View File

@@ -108,8 +108,23 @@ teardown() {
}
@test "(apps) apps:clone ssl-app" {
run /bin/bash -c "dokku config:set --no-restart $TEST_APP DOKKU_PROXY_PORT_MAP=https:443:5000 DOKKU_PROXY_SSL_PORT=443"
deploy_app
skip "this test always failed and requires changes in dokku to support detected vs specified functionality"
run /bin/bash -c "dokku apps:create $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ports:set $TEST_APP https:443:5000"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku config:set --no-restart $TEST_APP DOKKU_PROXY_SSL_PORT=443"
echo "output: $output"
echo "status: $status"
assert_success
run deploy_app
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku apps:clone $TEST_APP app-without-ssl"
echo "output: $output"
echo "status: $status"

50
tests/unit/nginx-vhosts_3.bats
View File

@@ -17,23 +17,61 @@ teardown() {
}
@test "(nginx-vhosts) grpc endpoint" {
deploy_app gogrpc
dokku ports:add "$TEST_APP" "grpc:80:50051"
run deploy_app gogrpc
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ports:add $TEST_APP grpc:80:50051"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku nginx:show-config $TEST_APP"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker run --rm ${TEST_APP}-docker-image /go/bin/greeter_client -address ${TEST_APP}.dokku.me:80 -name grpc"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "Greeting: Hello grpc"
}
@test "(nginx-vhosts) grpc endpoint on a port other than 80" {
deploy_app gogrpc
dokku ports:add "$TEST_APP" "grpc:8080:50051"
run deploy_app gogrpc
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ports:add $TEST_APP grpc:8080:50051"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker run --rm ${TEST_APP}-docker-image /go/bin/greeter_client -address ${TEST_APP}.dokku.me:8080 -name grpc8080"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "Greeting: Hello grpc8080"
}
@test "(nginx-vhosts) grpcs endpoint" {
setup_test_tls
deploy_app gogrpc
dokku ports:add "$TEST_APP" "grpcs:443:50051"
run deploy_app gogrpc
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "dokku ports:add $TEST_APP grpcs:443:50051"
echo "output: $output"
echo "status: $status"
assert_success
run /bin/bash -c "docker run --rm ${TEST_APP}-docker-image /go/bin/greeter_client -address ${TEST_APP}.dokku.me:443 -name grpcs -tls"
echo "output: $output"
echo "status: $status"
assert_success
assert_output "Greeting: Hello grpcs"
}