Rephrase the traefik.backend definition in documentation
#4317
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Damien DUPORTAL <[email protected]>
Signed-off-by: Damien DUPORTAL <[email protected]>
dduportal
added
kind/enhancement
Signed-off-by: Damien DUPORTAL <[email protected]>
|
@ldez : I've taken your feedback and explanations in account. The code from
|
amitsaha
reviewed
Dec 19, 2018
| | `traefik.tags=foo,bar,myTag` | Adds Traefik tags to the Docker container/service to be used in [constraints](/configuration/commons/#constraints). | | ||
| | `traefik.protocol=https` | Overrides the default `http` protocol | | ||
| | `traefik.weight=10` | Assigns this weight to the container | | ||
| | `traefik.backend=foo` | Overrides the container name by `foo` in the generated name of the backend. | |
There was a problem hiding this comment.
This is accurate for backends which are not segments. However, when we use segments, as explained in #4284, the backend name is being set as backend-<container-name>-backendsite1 where traefik.backend=backendsite1 has been specified by
the user.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Signed-off-by: Damien DUPORTAL [email protected]
What does this PR do?
This PR rephrases the definition of the label
traefik.backendin the documentation.Motivation
As underlined in #4284 and #4024, the actual definition of the label
traefik.backendleads to confusion: the provided value is expected to be the full backend name.
But it is an internal naming, which depends on dynamic name generation,
and the provided value is used as a suffix, to discriminate backends from each others.
So here is this PR, trying to rephrase to make it more close to reality, and to avoid false expectations when using the API.
More
Additional Notes
Here is a nice gopher image, because gophers are cute: