Skip to content

Commit

Permalink
docs: clarify Ingress annotations (#3384)
Browse files Browse the repository at this point in the history
Clarify relation between `zalando.org/skipper-routes` and `zalando.org/skipper-filter` annotation.

Follow up on #3323

Signed-off-by: Alexander Yastrebov <alexander.yastrebov@zalando.de>
  • Loading branch information
AlexanderYastrebov authored Jan 24, 2025
1 parent c2dbda6 commit 2142583
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions docs/kubernetes/ingress-usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -239,8 +239,8 @@ spec:
Please consider using [RouteGroups](routegroups.md), instead of custom
routes!

Custom routes is a way of extending the default routes configured for
an ingress resource.
Custom routes extend default routes configured for an ingress resource and
are specified via `zalando.org/skipper-routes` annotation.

Sometimes you just want to return a header, redirect or even static
html content. You can return from Skipper without doing a proxy call
Expand Down Expand Up @@ -270,7 +270,10 @@ You will get an error in Skipper logs, similar to:
[APP]time="2019-01-02T13:30:16Z" level=error msg="Failed to add route having 2 path routes: Path(\"/foo/bar\") -> inlineContent(\"custom route\") -> status(200) -> <shunt>"
```

> **Note:** Predicates coming from `zalando.org/skipper-predicate` won't be appended to routes generated from `zalando.org/skipper-routes`
> **Warning:**
> Predicates from `zalando.org/skipper-predicate` and filters from `zalando.org/skipper-filter` annotations
> won't be appended to routes from `zalando.org/skipper-routes` annotation.


### Redirects

Expand Down

0 comments on commit 2142583

Please sign in to comment.