Skip to content

Commit 089cf3a

Browse files
jnewfieldJTorreGADubhlaoich
authored
feat: Add annotation conversion guidance for SSL and gRPC backend (upstream) services (#886)
Co-authored-by: Jon Torre <[email protected]> Co-authored-by: Alan Dooley <[email protected]>
1 parent a2f9f16 commit 089cf3a

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

content/nic/installation/ingress-nginx.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -489,6 +489,19 @@ nginx.com/sticky-cookie-services: "serviceName=example-svc cookie_name expires=t
489489
NGINX Ingress Controller has additional annotations for features using NGINX Plus that have no Ingress-NGINX Controller equivalent, such as active health checks and authentication using JSON Web Tokens (JWTs).
490490
{{< /call-out >}}
491491

492+
The following table outlines annotation conversions for enabling TLS and gRPC protocols to backend (upstream) services.
493+
494+
{{< table >}}
495+
| Ingress-NGINX Controller | NGINX Ingress Controller |
496+
| ------------------------ | ------------------------ |
497+
| [_nginx.ingress.kubernetes.io/backend-protocol_](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#backend-protocol): "HTTPS" | [_nginx.org/ssl-services_]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations.md#backend-services-upstreams" >}}): "ssl_service_name" |
498+
| [_nginx.ingress.kubernetes.io/backend-protocol_](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#backend-protocol): "GRPC" | [_nginx.org/grpc-services_]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations.md#backend-services-upstreams" >}}): "grpc_service_name" |
499+
| [_nginx.ingress.kubernetes.io/backend-protocol_](https://kubernetes.github.io/ingress-nginx/user-guide/nginx-configuration/annotations/#backend-protocol): "GRPCS" | [_nginx.org/ssl-services_]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations.md#backend-services-upstreams" >}}): "grpc_service_name"<br />[_nginx.org/grpc-services_]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations.md#backend-services-upstreams" >}}): "grpc_service_name" |
500+
{{< /table >}}
501+
{{< call-out "important" >}}
502+
GRPC services require Ingresses with TLS termination and HTTP/2 enabled (see [_http2 ConfigMap key_]({{< ref "/nic/configuration/global-configuration/configmap-resource.md#listeners" >}})).
503+
{{< /call-out >}}
504+
492505
### Global configuration with ConfigMaps
493506

494507
This table maps the Ingress-NGINX Controller ConfigMap keys to NGINX Ingress Controller's equivalent ConfigMap keys.

0 commit comments

Comments
 (0)