Skip to content

Commit 996e80b

Browse files
committed
readme
Signed-off-by: omar <omar.hammami@solo.io>
1 parent 245e197 commit 996e80b

2 files changed

Lines changed: 13 additions & 0 deletions

File tree

pkg/i2gw/implementations/kgateway/README.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@ The command should generate Gateway API and Kgateway resources.
5959
- `nginx.ingress.kubernetes.io/limit-burst-multiplier`
6060
- `nginx.ingress.kubernetes.io/proxy-send-timeout`
6161
- `nginx.ingress.kubernetes.io/proxy-read-timeout`
62+
- `nginx.ingress.kubernetes.io/ssl-redirect`: When set to `"true"`, adds a `RequestRedirect` filter to HTTPRoute rules that redirects HTTP to HTTPS with a 301 status code.
63+
- `nginx.ingress.kubernetes.io/force-ssl-redirect`: When set to `"true"`, adds a `RequestRedirect` filter to HTTPRoute rules that redirects HTTP to HTTPS with a 301 status code. Treated identically to `ssl-redirect`.
6264

6365
### Backend Behavior
6466

@@ -110,6 +112,7 @@ Examples:
110112
- Body size annotations control `spec.buffer.maxRequestSize`
111113
- Rate limit annotations control `spec.rateLimit.local.tokenBucket`
112114
- Timeout annotations control `spec.timeouts.request` or `streamIdle`
115+
- SSL redirect annotations add `RequestRedirect` filters to HTTPRoute rules
113116

114117
## BackendConfigPolicy Projection
115118

pkg/i2gw/providers/ingressnginx/README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,16 @@ The ingress-nginx provider currently supports translating the following annotati
126126

127127
---
128128

129+
### SSL Redirect
130+
131+
- `nginx.ingress.kubernetes.io/ssl-redirect`: When set to `"true"`, enables SSL redirect for HTTP requests. For the Kgateway implementation, this maps to a `RequestRedirect` filter on HTTPRoute rules that redirects HTTP to HTTPS with a 301 status code.
132+
133+
- `nginx.ingress.kubernetes.io/force-ssl-redirect`: When set to `"true"`, enables SSL redirect for HTTP requests. This annotation is treated exactly the same as `ssl-redirect`. For the Kgateway implementation, this maps to a `RequestRedirect` filter on HTTPRoute rules that redirects HTTP to HTTPS with a 301 status code.
134+
135+
**Note:** Both annotations are supported and treated identically. If either annotation is set to `"true"` (case-insensitive), SSL redirect will be enabled. The redirect filter is added at the rule level in the HTTPRoute, redirecting all HTTP traffic to HTTPS.
136+
137+
---
138+
129139
## Provider Limitations
130140

131141
- Currently, kgateway is the only supported implementation-specific emitter.

0 commit comments

Comments
 (0)