feat: multiport support #2434

buchdag · 2024-05-03T09:44:25Z

This PR adds the ability to proxy to multiple ports on a single container using a new VIRTUAL_HOST_MULTIPORTS variable that take a YAML (or JSON) representation of the desired hostname / path / port / dest setup and completely override the VIRTUAL_HOST, VIRTUAL_PORT, VIRTUAL_PATH and VIRTUAL_DEST variables.

See #1504 for the previous discussion on this feature.

Thanks to @pini-gh for the actual feature's code.

Close #560
Close #911
Close #939
Close #1042
Close #1066
Close #1112
Close #1382
Close #1463
Close #1504
Close #2050

Supersede #259, #1405 and #2130

nginx.tmpl

buchdag · 2024-05-04T14:13:37Z

Merging VIRTUAL_HOST and VIRTUAL_HOST_MULTIPORT seems to stop working when we start mixing VIRTUAL_HOST configs with and without VIRTUAL_PORT.

This work (no virtual path):

services:
  merged-singleport-1: # 172.18.0.2
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld

  merged-singleport-2: # 172.18.0.3
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld
      VIRTUAL_PORT: "81"

  merged-multiports: # 172.18.0.4
    image: nginx:alpine
    environment:
      VIRTUAL_HOST_MULTIPORTS: |-
        merged.nginx-proxy.tld:
          "/":
            port: 82

# merged.nginx-proxy.tld/
upstream merged.nginx-proxy.tld {
    # Container: nginx-proxy-merged-multiports-1
    # ...
    # Container: nginx-proxy-merged-singleport-1-1
    # ...
    # Container: nginx-proxy-merged-singleport-2-1
    # ...
    server 172.18.0.4:82;
    server 172.18.0.2:80;
    server 172.18.0.3:81;
}
server {
    server_name merged.nginx-proxy.tld;
    # ...
    location / {
        proxy_pass http://merged.nginx-proxy.tld;
        set $upstream_keepalive false;
    }
}

This work too (only virtual path):

services:
  merged-singleport-1: # 172.18.0.2
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld
      VIRTUAL_PATH: "/foo"

  merged-singleport-2: # 172.18.0.3
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld
      VIRTUAL_PATH: "/foo"
      VIRTUAL_PORT: "81"

  merged-multiports: # 172.18.0.4
    image: nginx:alpine
    environment:
      VIRTUAL_HOST_MULTIPORTS: |-
        merged.nginx-proxy.tld:
          "/foo":
            port: 82

# merged.nginx-proxy.tld/foo
upstream merged.nginx-proxy.tld-6dbd548cc03e44b8b44b6e68e56255ce4273ae49 {
    # Container: nginx-proxy-merged-multiports-1
    # ...
    # Container: nginx-proxy-merged-singleport-1-1
    # ...
    # Container: nginx-proxy-merged-singleport-2-1
    # ...
    server 172.18.0.4:82;
    server 172.18.0.2:80;
    server 172.18.0.3:81;
}
server {
    server_name merged.nginx-proxy.tld;
    # ...
    location /foo {
        proxy_pass http://merged.nginx-proxy.tld-6dbd548cc03e44b8b44b6e68e56255ce4273ae49;
        set $upstream_keepalive false;
    }
    location / {
        return 404;
    }
}

This work too (root path on multiport container only):

services:
  merged-singleport-2: # 172.18.0.3
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld
      VIRTUAL_PATH: "/foo"
      VIRTUAL_PORT: "81"

  merged-multiports: # 172.18.0.4
    image: nginx:alpine
    environment:
      VIRTUAL_HOST_MULTIPORTS: |-
        merged.nginx-proxy.tld:
          "/":
            port: 82
          "/foo":
            port: 83

# merged.nginx-proxy.tld/
upstream merged.nginx-proxy.tld {
    # Container: nginx-proxy-merged-multiports-1
    # ...
    server 172.18.0.4:82;
}
# merged.nginx-proxy.tld/foo
upstream merged.nginx-proxy.tld-6dbd548cc03e44b8b44b6e68e56255ce4273ae49 {
    # Container: nginx-proxy-merged-multiports-1
    # ...
    # Container: nginx-proxy-merged-singleport-2-1
    # ...
    server 172.18.0.4:83;
    server 172.18.0.3:81;
}
server {
    server_name merged.nginx-proxy.tld;
    # ...
    location / {
        proxy_pass http://merged.nginx-proxy.tld;
        set $upstream_keepalive false;
    }
    location /foo {
        proxy_pass http://merged.nginx-proxy.tld-6dbd548cc03e44b8b44b6e68e56255ce4273ae49;
        set $upstream_keepalive false;
    }
}

This doesn't (the first container's config is seemingly discarded):

services:
  merged-singleport-1: # 172.18.0.2
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld

  merged-singleport-2: # 172.18.0.3
    image: nginx:alpine
    environment:
      VIRTUAL_HOST: merged.nginx-proxy.tld
      VIRTUAL_PATH: "/foo"
      VIRTUAL_PORT: "81"

  merged-multiports: # 172.18.0.4
    image: nginx:alpine
    environment:
      VIRTUAL_HOST_MULTIPORTS: |-
        merged.nginx-proxy.tld:
          "/":
            port: 82
          "/foo":
            port: 84

# merged.nginx-proxy.tld/
upstream merged.nginx-proxy.tld {
    # Container: nginx-proxy-merged-multiports-1
    # ...
    # /!\ nginx-proxy-singleport-1-1 should be here /!\
    server 172.18.0.4:82;
}
# merged.nginx-proxy.tld/foo
upstream merged.nginx-proxy.tld-6dbd548cc03e44b8b44b6e68e56255ce4273ae49 {
    # Container: nginx-proxy-merged-multiports-1
    # ...
    # Container: nginx-proxy-merged-singleport-2-1
    # ...
    server 172.18.0.4:83;
    server 172.18.0.3:81;
}
server {
    server_name merged.nginx-proxy.tld;
    # ...
    location / {
        proxy_pass http://merged.nginx-proxy.tld;
        set $upstream_keepalive false;
    }
    location /foo {
        proxy_pass http://merged.nginx-proxy.tld-6dbd548cc03e44b8b44b6e68e56255ce4273ae49;
        set $upstream_keepalive false;
    }
}

pini-gh · 2024-05-05T08:26:26Z

This doesn't (the first container's config is seemingly discarded):

It is the case on the branch main as well.

Because this block:

    {{- $tmp_paths := groupBy $containers "Env.VIRTUAL_PATH" }}
    {{- $has_virtual_paths := gt (len $tmp_paths) 0}}
    {{- if not $has_virtual_paths }}
        {{- $tmp_paths = dict "/" $containers }}
    {{- end }}

silently discards containers with no VIRTUAL_PATH variable when at least one exists with.

pini-gh · 2024-05-05T09:44:53Z

this block:

    {{- $tmp_paths := groupBy $containers "Env.VIRTUAL_PATH" }}
    {{- $has_virtual_paths := gt (len $tmp_paths) 0}}
    {{- if not $has_virtual_paths }}
        {{- $tmp_paths = dict "/" $containers }}
    {{- end }}

silently discards containers with no VIRTUAL_PATH variable when at least one exists with.

Could be replaced with:

    {{- $tmp_paths := dict }}
    {{- range $path, $path_containers := groupBy $containers "Env.VIRTUAL_PATH" }}
        {{ $_ := set $tmp_paths $path $path_containers }}
    {{- end }}
    {{- $has_virtual_paths := gt (len $tmp_paths) 0}}
    {{- $_ := unset $tmp_paths "/" }}
    {{- $slash_containers := $containers }}
    {{- range $path, $path_containers := $tmp_paths }}
        {{ range $container := $path_containers }}
            {{ $slash_containers = without $slash_containers $container }}
        {{- end }}
    {{- end }}
    {{- if (gt (len $slash_containers) 0) }}
        {{- $_ := set $tmp_paths "/" $slash_containers }}
    {{- end }}

I couldn't find a simpler way because docker-gen map type is not compatible with sprig dict.

buchdag · 2024-05-05T10:37:27Z

I've tried that earlier an ran into the same dockergen map / sprig dict incompatibility.

I think a cleaner approach might be to add a groupByWithDefault function to docker-gen that would work like this :

{{- $tmp_paths := groupByWithDefault $containers "Env.VIRTUAL_PATH" "/" }}

I have it ready on a local branch and tested it with a modified template, seems to work like a charm.

While I'm at it, maybe groupByMultiWithDefault / groupByLabelWithDefault would be useful to clean the template too ?

pini-gh · 2024-05-05T10:43:45Z

While I'm at it, maybe groupByMultiWithDefault / groupByLabelWithDefault would be useful to clean the template too ?

Sure.

(See #1504) Using variable VIRTUAL_HOST_MULTIPORTS as a dictionnary: key: hostname value: dictionnary: key: path value: struct port dest When the dictionnary associated with a hostname is empty, default values apply: path = "/" port = default port dest = "" For each path entry, port and dest are optionnal and are assigned default values when missing. Example: VIRTUAL_HOST_MULTIPORTS: | host1.example.org: "/": port: 8000 "/somewhere": port: 9000 dest: "/elsewhere" host2.example.org: host3.example.org: "/inner/path":

For containers grouped by identical VIRTUAL_HOST, those with no VIRTUAL_PATH variable were silently discarded when at least one container with VIRTUAL_PATH existed.

buchdag · 2024-05-05T19:15:42Z

I think we're pretty much done in term of documentation and tests here, marking the PR as ready for review.

docs/README.md

pini-gh · 2024-05-06T12:23:01Z

LGTM. Please go ahead 👍

docs/README.md

SchoNie

Very nice work @pini-gh & @buchdag 👍

docs/README.md

Co-authored-by: Niek <100143256+SchoNie@users.noreply.github.com>

buchdag added type/feat PR for a new feature scope/multiport Issue or PR related to multi port proxying labels May 3, 2024

buchdag self-assigned this May 3, 2024

buchdag mentioned this pull request May 3, 2024

Allow per-hostname ports #1504

Closed

buchdag commented May 3, 2024

View reviewed changes

nginx.tmpl Show resolved Hide resolved

buchdag force-pushed the multiport-support branch 2 times, most recently from 89c69ec to ef4a4a9 Compare May 3, 2024 20:33

pini-gh and others added 11 commits May 5, 2024 16:15

refactor: cleanup template

fc98f4c

fix: default values if port and dest are missing

62d9c08

test: re-organize test files

6221218

test: multiports base test

216eae9

refactor: rename VIRTUAL_HOST_YAML -> VIRTUAL_HOST_MULTIPORTS

47e2838

docs: documentation for multiports support

8359aa2

refactor: get rid of get_path_info template

0baff18

feat: print warning on unparsable VIRTUAL_HOST_MULTIPORTS

53e9a03

test: json syntax for multiports variable

d80ca7e

docs: use examples closer to real life scenarios

8b91f09

buchdag force-pushed the multiport-support branch from c36e5f8 to e42a9ef Compare May 5, 2024 14:31

fix: do not discard containers without VIRTUAL_PATH

be7c4c8

For containers grouped by identical VIRTUAL_HOST, those with no VIRTUAL_PATH variable were silently discarded when at least one container with VIRTUAL_PATH existed.

buchdag force-pushed the multiport-support branch from e42a9ef to be7c4c8 Compare May 5, 2024 14:36

This comment was marked as resolved.

Sign in to view

test: multiport merge with legacy variable

1bf7eff

buchdag marked this pull request as ready for review May 5, 2024 19:15

buchdag requested a review from pini-gh May 5, 2024 19:16

pini-gh reviewed May 6, 2024

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

buchdag commented May 6, 2024

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

docs: typo

99645f1

SchoNie reviewed May 6, 2024

View reviewed changes

docs/README.md Outdated Show resolved Hide resolved

pini-gh approved these changes May 6, 2024

View reviewed changes

docs: typo

be319e6

Co-authored-by: Niek <100143256+SchoNie@users.noreply.github.com>

pini-gh approved these changes May 8, 2024

View reviewed changes

buchdag merged commit db07d90 into main May 9, 2024

buchdag deleted the multiport-support branch May 9, 2024 10:29

This was referenced May 9, 2024

VIRTUAL_HOST syntax to support multiple destinations #259

Closed

Support exposing multiple ports per virtual host #1405

Closed

New backward compatible multiport syntax for VIRTUAL_PORT variable #2130

Closed

This was referenced May 16, 2024

Expose multiple ports nginx-proxy/docker-gen#173

Closed

Feature request : Ability to serve other ports than 80 or 443 nginx-proxy/docker-gen#221

Closed

This was referenced Dec 8, 2024

Simple question #657

Closed

[FEATURE] Allow multiple ports per virtual host #1157

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: multiport support #2434

feat: multiport support #2434

Uh oh!

buchdag commented May 3, 2024

Uh oh!

Uh oh!

buchdag commented May 4, 2024

Uh oh!

pini-gh commented May 5, 2024 •

edited

Loading

Uh oh!

pini-gh commented May 5, 2024 •

edited

Loading

Uh oh!

buchdag commented May 5, 2024 •

edited

Loading

Uh oh!

pini-gh commented May 5, 2024

Uh oh!

This comment was marked as resolved.

buchdag commented May 5, 2024 •

edited

Loading

Uh oh!

Uh oh!

pini-gh commented May 6, 2024

Uh oh!

Uh oh!

SchoNie left a comment

Uh oh!

Uh oh!

Uh oh!

feat: multiport support #2434

feat: multiport support #2434

Uh oh!

Conversation

buchdag commented May 3, 2024

Uh oh!

Uh oh!

buchdag commented May 4, 2024

Uh oh!

pini-gh commented May 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pini-gh commented May 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

buchdag commented May 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pini-gh commented May 5, 2024

Uh oh!

This comment was marked as resolved.

buchdag commented May 5, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

pini-gh commented May 6, 2024

Uh oh!

Uh oh!

SchoNie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

pini-gh commented May 5, 2024 •

edited

Loading

pini-gh commented May 5, 2024 •

edited

Loading

buchdag commented May 5, 2024 •

edited

Loading

buchdag commented May 5, 2024 •

edited

Loading