Improve ErrorPages examples #10209
Merged
Improve ErrorPages examples #10209
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
ldez
requested changes
Nov 3, 2023
nmengin
added
area/documentation
status/2-needs-review
and removed
status/0-needs-triage
labels
geraldcroes
approved these changes
Nov 10, 2023
rtribotte
requested changes
Nov 10, 2023
Completely agreed, thanks |
arendhummeling
force-pushed
the
docs/errorpages-example
branch
from
9727b39
to
2083ecd
Compare
arendhummeling
force-pushed
the
docs/errorpages-example
branch
2 times, most recently
from
09bb75d
to
3629e22
Compare
While trying to implement the `errors` middleware, I ran into issues
understanding the documentation. Using the Dynamic File Provider,
I did not realise that writing the following wouldn't work:
```yaml
http:
middlewares:
error-pages:
errors:
status:
- "502,504"
service: error-pages
query: "/{status}.html"
services:
error-pages:
loadBalancer:
- url: {{ env "ERROR_PAGES_INTERNAL_URL" }}
```
The following line started appearing in my logs:
> ERR error="strconv.Atoi: parsing \"502,504\": invalid syntax"
After some digging through the code, I found that the comma splitting
did not occur in the same place as the dash splitting. This lead me
to conclude it is likely provider specific syntax.
Therefore it makes sense to me to provide more comprehensive provider
specific examples. I have tried to achieve this with this PR.
This would be my first contribution to Traefik, so if there's anything
I need to take care of before this PR can be reviewed or merge, please
let me know and I will take care of it ASAP, thanks!
Co-authored-by: Ludovic Fernandez <ldez@users.noreply.github.com>
arendhummeling
force-pushed
the
docs/errorpages-example
branch
from
3629e22
to
f8e0398
Compare
|
@ldez sorry for the ping, would you be able to give this a re-review? |
ldez
approved these changes
Nov 17, 2023
rtribotte
changed the title
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.
What does this PR do?
This PR attempts to describe a more comprehensive set of provider specific examples for the errors middleware configuration.
Motivation
While trying to implement the
errorsmiddleware, I ran into issues understanding the documentation. Using the Dynamic File Provider, I did not realise that writing the following wouldn't work:The following line started appearing in my logs:
After some digging through the code, I found that the comma splitting did not occur in the same place as the dash splitting. This lead me to conclude it is likely provider specific syntax. I'm hoping to avoid other people following in my confusion with these changes.
More
Additional Notes
This would be my first contribution to Traefik, so if there's anything I need to take care of before this PR can be reviewed or merge, please let me know and I will take care of it ASAP, thanks!
Should this PR be good to go, would it be helpful if I opened another PR to the 3.0 branch to update the documentation for v3 as well? Seeing as this specific page is virtually identical for v2 and v3.