Skip to content

Commit 92efdb5

Browse files
authored
Merge pull request #13 from danehans/rr_lb_docs
Adds docs for load balance annoation
2 parents 10fcb51 + a8bcb83 commit 92efdb5

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

pkg/i2gw/implementations/kgateway/README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -62,7 +62,9 @@ The command should generate Gateway API and Kgateway resources.
6262

6363
### Backend Behavior
6464

65-
- `nginx.ingress.kubernetes.io/proxy-connect-timeout`
65+
- `nginx.ingress.kubernetes.io/proxy-connect-timeout`: Sets the timeout for establishing a connection with a proxied server. It should be noted that this timeout
66+
cannot usually exceed 75 seconds.
67+
- `nginx.ingress.kubernetes.io/load-balance`: Sets the algorithm to use for load balancing to a proxied server. The only supported value is `round_robin`.
6668
- `nginx.ingress.kubernetes.io/affinity`: Enables session affinity (only "cookie" type is supported). Maps to `BackendConfigPolicy.spec.loadBalancer.ringHash.hashPolicies`.
6769
- `nginx.ingress.kubernetes.io/session-cookie-name`: Specifies the name of the cookie used for session affinity. Maps to `BackendConfigPolicy.spec.loadBalancer.ringHash.hashPolicies[].cookie.name`.
6870
- `nginx.ingress.kubernetes.io/session-cookie-path`: Defines the path that will be set on the cookie. Maps to `BackendConfigPolicy.spec.loadBalancer.ringHash.hashPolicies[].cookie.path`.

pkg/i2gw/providers/ingressnginx/README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -83,7 +83,10 @@ The ingress-nginx provider currently supports translating the following annotati
8383

8484
### Backend (Upstream) Configuration
8585

86-
- `nginx.ingress.kubernetes.io/proxy-connect-timeout`: Controls the upstream connection timeout. For the Kgateway implementation, this maps to `BackendConfigPolicy.spec.connectTimeout`.
86+
- `nginx.ingress.kubernetes.io/proxy-connect-timeout`: Controls the upstream connection timeout. For the Kgateway implementation,
87+
this maps to `BackendConfigPolicy.spec.connectTimeout`.
88+
- `nginx.ingress.kubernetes.io/load-balance`: Sets the algorithm to use for load balancing. The only supported value is `round_robin`.
89+
For the Kgateway implementation, this maps to `BackendConfigPolicy.spec.loadBalancer`.
8790

8891
**Note:** For the Kgateway implementation, if multiple Ingress resources reference the same Service with different `proxy-connect-timeout` values, ingress2gateway will emit warnings because Kgateway cannot safely apply multiple conflicting `BackendConfigPolicy` resources to the same Service.
8992

0 commit comments

Comments
 (0)