Skip to content

Annotation conversion guidance for SSL and gRPC backend (upstream) services #886

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
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Annotation conversion guidance for SSL and gRPC backend (upstream) services #886

Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
cd63d4a
Changes have been made
jnewfield Jul 23, 2025
637527d
Merge branch 'main' into newfield-nic-migration-update
ADubhlaoich Jul 24, 2025
0cfaf0f
Merge branch 'main' into newfield-nic-migration-update
ADubhlaoich Jul 24, 2025
3804e02
Merge branch 'main' into newfield-nic-migration-update
ADubhlaoich Aug 11, 2025
d4bfd2e
Changes have been made
jnewfield Aug 14, 2025
493fcc3
Merge branch 'newfield-nic-migration-update' of https://github.com/jn…
jnewfield Aug 14, 2025
a982c0a
Changes have been made
jnewfield Aug 14, 2025
a5cf476
Changes have been made
jnewfield Aug 15, 2025
3c93e8d
Changes have been made
jnewfield Aug 15, 2025
846a88f
Merge branch 'main' into newfield-nic-migration-update
jnewfield Aug 19, 2025
67f764f
Merge branch 'main' into newfield-nic-migration-update
ADubhlaoich Sep 8, 2025
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
14 changes: 14 additions & 0 deletions content/nic/installation/ingress-nginx.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -488,6 +488,20 @@ nginx.com/sticky-cookie-services: "serviceName=example-svc cookie_name expires=t
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).
{{< /call-out >}}

The following table outlines annotation conversions for enabling TLS and gRPC protocols to backend (upstream) services.

{{< bootstrap-table "table table-bordered table-striped table-responsive" >}}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{< bootstrap-table "table table-bordered table-striped table-responsive" >}}
{{< table >}}

| Ingress-NGINX Controller | NGINX Ingress Controller |
| ------------------------ | ------------------------ |
| [_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" |
| [_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" |
| [_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" |

{{% /bootstrap-table %}}
Comment on lines +499 to +500
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
{{% /bootstrap-table %}}
{{< /table >}}

{{< call-out "important" >}}
GRPC services require Ingresses with TLS termination and HTTP/2 enabled (see [_http2 ConfigMap key_](/nic/configuration/global-configuration/configmap-resource.md#listeners)).
{{< /call-out >}}

### Global configuration with ConfigMaps

This table maps the Ingress-NGINX Controller ConfigMap keys to NGINX Ingress Controller's equivalent ConfigMap keys.
Expand Down
Loading