New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Segment labels: Docker #3055

Merged

traefiker merged 13 commits into traefik:master from ldez:refactor/service-labels

Mar 23, 2018

Contributor

ldez commented Mar 20, 2018 •

edited

Loading

What does this PR do?

"Service labels" become "segment labels".

Full rewrite of the template management in Docker.

fix some bugs

Motivation

Homogenization of the providers [part4]:ave a common way to manage segment labels.

Related to #2785

More

Added/updated tests
Added/updated documentation

Additional Notes

It's the first step, next: Marathon and Rancher.

ldez added kind/enhancement status/2-needs-review area/provider/docker labels

ldez added this to the 1.6 milestone

ldez requested a review from a team as a code owner

March 20, 2018 13:21

ldez changed the title ~~Road labels: Docker~~ Segment labels: Docker

ldez requested a review from a team as a code owner

March 22, 2018 08:46

ldez force-pushed the refactor/service-labels branch from 575fae0 to 379fcef Compare

March 22, 2018 15:14

mmatur approved these changes

View reviewed changes

Member

mmatur left a comment

LGTM
Great job @ldez 👏

emilevauge requested changes

View reviewed changes

Member

emilevauge left a comment

Awesome job @ldez
Mostly comments on the doc :)

docs/configuration/backends/docker.md Outdated

    
              # For advanced users :)

              #

              # Optional

              # - "1": previous template (must be use only with a old custom template, see "filename")

Member

emilevauge Mar 22, 2018

previous template version (must be used only with a older custom templates, see "filename")

docs/configuration/backends/docker.md Outdated

    
              #

              # Optional

              # - "1": previous template (must be use only with a old custom template, see "filename")

              # - "2": current template (must be use to force template version when "filename" is used)

Member

emilevauge Mar 22, 2018

current template version (must be used to force template version when "filename" is used)

docs/configuration/backends/docker.md Outdated

    
            @@ -237,70 +255,71 @@ Labels can be used on containers to override default behaviour.
          
              | `traefik.frontend.headers.referrerPolicy=VALUE`          | Adds referrer policy  header.                                                                                                                                                                       |

              | `traefik.frontend.headers.isDevelopment=false`           | This will cause the `AllowedHosts`, `SSLRedirect`, and `STSSeconds`/`STSIncludeSubdomains` options to be ignored during development.<br>When deploying to production, be sure to set this to false. |

              ### On Service

              ### On container with multiple ports (segment label)

Member

emilevauge Mar 22, 2018

On containers with multiple ports (segment labels)

docs/configuration/backends/docker.md Outdated

    
              Services labels can be used for overriding default behaviour

              Segment labels are a way to define more than one (default) port on the same container so you can create different routes to it.

Member

emilevauge Mar 22, 2018

Segment labels are used to define routes to a container exposing multiple ports. A segment is a group of labels that apply to a port exposed by a container. You can define as many segments as ports exposed in a container.

docs/configuration/backends/docker.md Outdated

    
              Services labels can be used for overriding default behaviour

              Segment labels are a way to define more than one (default) port on the same container so you can create different routes to it.

              Segment labels are overriding the default behavior.

Member

emilevauge Mar 22, 2018 •

edited

Loading

Segment labels ~~are~~ override~~ing~~ the default behavior.

docs/configuration/backends/marathon.md Outdated

    
              For applications that expose multiple ports, specific labels can be used to extract one frontend/backend configuration pair per port. Each such pair is called a _service_. The (freely choosable) name of the service is an integral part of the service label name.

              For applications that expose multiple ports, specific labels can be used to extract one frontend/backend configuration pair per port.

              Each such pair is called a _segment_.

              The (freely choosable) name of the segment is an integral part of the segment label name.

Member

emilevauge Mar 22, 2018

The segment labels explanation should be consistent between Docker, Marathon and Rancher documentation.

Contributor Author

ldez Mar 23, 2018

For now behavior, between Docker and Marathon on segment labels are not consistent (ex: Docker use container labels as default and not Marathon).

I will update the documentation when I will rewrite the Marathon provider.

provider/label/label.go Outdated

    
              	ServicesPropertiesRegexp = regexp.MustCompile(`^traefik\.(?P<service_name>.+?)\.(?P<property_name>port|portIndex|weight|protocol|backend|frontend\.(.+))$`)

              	// SegmentPropertiesRegexp used to extract the name of the segment and the name of the property for this segment

              	// All properties are under the format traefik.<segment_name>.frontend.*= except the port/portIndex/weight/protocol/backend directly after traefik.<segment_name>.

              	SegmentPropertiesRegexp = regexp.MustCompile(`^traefik\.(?P<service_name>.+?)\.(?P<property_name>port|portIndex|weight|protocol|backend|frontend\.(.+))$`)

Member

emilevauge Mar 22, 2018

s/service_name/segment_name

provider/label/label.go Outdated

    
              	// PortRegexp used to extract the port label of the service

              	// PortRegexp used to extract the port label of the segment

              	PortRegexp = regexp.MustCompile(`^traefik\.(?P<service_name>.+?)\.port$`)

Member

emilevauge Mar 22, 2018 •

edited

Loading

s/service_name/segment_name

provider/label/label.go Outdated

    
              			var propertyName string

              			for i, name := range SegmentPropertiesRegexp.SubexpNames() {

              				if i != 0 {

              					if name == "service_name" {

Member

emilevauge Mar 22, 2018

s/service_name/segment_name

traefiker added the contributor/waiting-for-corrections label

ldez added the size/L label

ldez mentioned this pull request

Ability to use "X-Forwarded-For" as a source of IP for white list. #3070

Merged

11 tasks

ldez removed the contributor/waiting-for-corrections label

emilevauge reviewed

View reviewed changes

Member

emilevauge left a comment

Almost LGTM, I would just add few comments in the code to make it easier to read later

provider/label/label.go Outdated

    
              		var propertyName string

              		for i, name := range ServicesPropertiesRegexp.SubexpNames() {

              		for i, name := range SegmentPropertiesRegexp.SubexpNames() {

Member

emilevauge Mar 23, 2018

I would add a comment here to explain why if i != 0 {

provider/label/label.go Outdated

    
              			var segmentName string

              			var propertyName string

              			for i, name := range SegmentPropertiesRegexp.SubexpNames() {

              				if i != 0 {

Member

emilevauge Mar 23, 2018

I would add a comment here to explain why if i != 0 {

provider/label/label.go Outdated

    
              }

              func (s SegmentProperties) mergeDefault() {

              	if defaultLabels, okDefault := s[""]; okDefault {

Member

emilevauge Mar 23, 2018

A comment here would be welcome

ldez force-pushed the refactor/service-labels branch from 10a7bfa to a58ec45 Compare

March 23, 2018 11:40

juliens approved these changes

View reviewed changes

Member

juliens left a comment

LGTM

emilevauge approved these changes

View reviewed changes

Member

emilevauge left a comment

Great job @ldez
Thanks a lot !
LGTM

emilevauge added status/3-needs-merge and removed status/2-needs-review labels

traefiker added the status/4-merge-in-progress label

ldez and others added 9 commits

March 23, 2018 12:14


          refactor: road labels.

6e400dc


          refactor: minor fixes.

19e5bab


          refactor: fix autogen

da70308


          refactor: code review.

648b876


          refactor: road -> segment.

5105e9a


          doc: segment labels everywhere!

0eb99d3


          feat: add generic method 'getLabelValue'

c5ef22e


          refactor: review.


          doc: explain version.

6fba044

ldez added 4 commits

March 23, 2018 12:14


          review: doc.

174706e


          review: segment_name.

c4c3478


          review: comments.

cebe0f5


          refactor: extract segment to a dedicated file.

8a14d42

traefiker force-pushed the refactor/service-labels branch from 47432c3 to 8a14d42 Compare

March 23, 2018 12:14

traefiker removed the status/4-merge-in-progress label

traefiker merged commit 4802484 into traefik:master

traefiker removed the status/3-needs-merge label

ldez deleted the refactor/service-labels branch

March 23, 2018 12:40

ldez mentioned this pull request

Homogenization of the providers #2785

Closed

8 tasks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

area/provider/docker kind/enhancement size/L