Skip to content

Commit b7451f7

Browse files
Add a notice about ingress annotations that affect cluster level options (#2992)
* Add a notice about cluster level ingress annotations. * Convert into NOTE block and use anchors for linking. * Move the annotation to the first column. * Use a heading since cannot use inline HTML.
1 parent 97c92e3 commit b7451f7

1 file changed

Lines changed: 10 additions & 5 deletions

File tree

samples/KubernetesIngress.Sample/README.md

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -93,18 +93,23 @@ The table below lists the available annotations.
9393
|yarp.ingress.kubernetes.io/output-cache-policy|string|
9494
|yarp.ingress.kubernetes.io/backend-protocol|string|
9595
|yarp.ingress.kubernetes.io/cors-policy|string|
96-
|yarp.ingress.kubernetes.io/health-check|[ActivateHealthCheckConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.activehealthcheckconfig)|
97-
|yarp.ingress.kubernetes.io/http-client|[HttpClientConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.httpclientconfig)|
98-
|yarp.ingress.kubernetes.io/http-request|[ForwarderRequestConfig](https://learn.microsoft.com/en-us/dotnet/api/yarp.reverseproxy.forwarder.forwarderrequestconfig)|
99-
|yarp.ingress.kubernetes.io/load-balancing|string|
96+
|yarp.ingress.kubernetes.io/health-check [\*](#cluster-level-annotations)|[ActivateHealthCheckConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.activehealthcheckconfig)|
97+
|yarp.ingress.kubernetes.io/http-client [\*](#cluster-level-annotations)|[HttpClientConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.httpclientconfig)|
98+
|yarp.ingress.kubernetes.io/http-request [\*](#cluster-level-annotations)|[ForwarderRequestConfig](https://learn.microsoft.com/en-us/dotnet/api/yarp.reverseproxy.forwarder.forwarderrequestconfig)|
99+
|yarp.ingress.kubernetes.io/load-balancing [\*](#cluster-level-annotations)|string|
100100
|yarp.ingress.kubernetes.io/route-metadata|Dictionary<string, string>|
101-
|yarp.ingress.kubernetes.io/session-affinity|[SessionAffinityConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.sessionaffinityconfig)|
101+
|yarp.ingress.kubernetes.io/session-affinity [\*](#cluster-level-annotations)|[SessionAffinityConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.sessionaffinityconfig)|
102102
|yarp.ingress.kubernetes.io/transforms|List<Dictionary<string, string>>|
103103
|yarp.ingress.kubernetes.io/route-headers|List<[RouteHeader](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.routeheader)>|
104104
|yarp.ingress.kubernetes.io/route-queryparameters|List<[RouteQueryParameter](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.routequeryparameter)>|
105105
|yarp.ingress.kubernetes.io/route-order|int|
106106
|yarp.ingress.kubernetes.io/route-methods|List<string>|
107107
108+
#### Cluster-level annotations
109+
110+
> [!NOTE]
111+
> Annotations marked with **\*** configure the YARP cluster, not the route. A cluster is identified by backend service name, namespace, and port. Multiple ingress rules targeting the same backend share the cluster, so conflicting values result in non-deterministic behavior. Ensure consistent values across all ingress rules for the same backend.
112+
108113
#### Authorization Policy
109114
110115
See https://learn.microsoft.com/aspnet/core/fundamentals/servers/yarp/authn-authz for a list of available policies, or how to add your own custom policies.

0 commit comments

Comments
 (0)