Skip to content

Add a notice about ingress annotations that affect cluster level options #2992

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
specialforest wants to merge 4 commits into
base: main
Choose a base branch
from
Open

Add a notice about ingress annotations that affect cluster level options #2992

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
87b6142
Add a notice about cluster level ingress annotations.
specialforest Jan 29, 2026
97ef648
Convert into NOTE block and use anchors for linking.
specialforest Jan 29, 2026
4fbd72c
Move the annotation to the first column.
specialforest Jan 29, 2026
f9dcbcb
Use a heading since cannot use inline HTML.
specialforest Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions samples/KubernetesIngress.Sample/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,18 +93,23 @@ The table below lists the available annotations.
|yarp.ingress.kubernetes.io/output-cache-policy|string|
|yarp.ingress.kubernetes.io/backend-protocol|string|
|yarp.ingress.kubernetes.io/cors-policy|string|
|yarp.ingress.kubernetes.io/health-check|[ActivateHealthCheckConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.activehealthcheckconfig)|
|yarp.ingress.kubernetes.io/http-client|[HttpClientConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.httpclientconfig)|
|yarp.ingress.kubernetes.io/http-request|[ForwarderRequestConfig](https://learn.microsoft.com/en-us/dotnet/api/yarp.reverseproxy.forwarder.forwarderrequestconfig)|
|yarp.ingress.kubernetes.io/load-balancing|string|
|yarp.ingress.kubernetes.io/health-check [\*](#cluster-level-annotations)|[ActivateHealthCheckConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.activehealthcheckconfig)|
|yarp.ingress.kubernetes.io/http-client [\*](#cluster-level-annotations)|[HttpClientConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.httpclientconfig)|
|yarp.ingress.kubernetes.io/http-request [\*](#cluster-level-annotations)|[ForwarderRequestConfig](https://learn.microsoft.com/en-us/dotnet/api/yarp.reverseproxy.forwarder.forwarderrequestconfig)|
|yarp.ingress.kubernetes.io/load-balancing [\*](#cluster-level-annotations)|string|
|yarp.ingress.kubernetes.io/route-metadata|Dictionary<string, string>|
|yarp.ingress.kubernetes.io/session-affinity|[SessionAffinityConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.sessionaffinityconfig)|
|yarp.ingress.kubernetes.io/session-affinity [\*](#cluster-level-annotations)|[SessionAffinityConfig](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.sessionaffinityconfig)|
|yarp.ingress.kubernetes.io/transforms|List<Dictionary<string, string>>|
|yarp.ingress.kubernetes.io/route-headers|List<[RouteHeader](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.routeheader)>|
|yarp.ingress.kubernetes.io/route-queryparameters|List<[RouteQueryParameter](https://learn.microsoft.com/dotnet/api/yarp.reverseproxy.configuration.routequeryparameter)>|
|yarp.ingress.kubernetes.io/route-order|int|
|yarp.ingress.kubernetes.io/route-methods|List<string>|

#### Cluster-level annotations

> [!NOTE]
> 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.

#### Authorization Policy

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.
Expand Down
Loading