From 214258319c542225dc3ca931bd491d14daa12c71 Mon Sep 17 00:00:00 2001 From: Alexander Yastrebov Date: Fri, 24 Jan 2025 22:27:23 +0100 Subject: [PATCH] docs: clarify Ingress annotations (#3384) Clarify relation between `zalando.org/skipper-routes` and `zalando.org/skipper-filter` annotation. Follow up on #3323 Signed-off-by: Alexander Yastrebov --- docs/kubernetes/ingress-usage.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/kubernetes/ingress-usage.md b/docs/kubernetes/ingress-usage.md index 99d6f0dd8a..cb8bd58c7f 100644 --- a/docs/kubernetes/ingress-usage.md +++ b/docs/kubernetes/ingress-usage.md @@ -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 @@ -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) -> " ``` -> **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