From cd63d4a5f1d20f1fbf48278cfe1022bbcab50cdb Mon Sep 17 00:00:00 2001 From: Jacob Newfield Date: Wed, 23 Jul 2025 21:41:54 +0000 Subject: [PATCH 1/5] Changes have been made --- content/nic/installation/ingress-nginx.md | 49 +++++++++++++++++++++++ 1 file changed, 49 insertions(+) diff --git a/content/nic/installation/ingress-nginx.md b/content/nic/installation/ingress-nginx.md index faa3d3b04..1d8a56ef4 100644 --- a/content/nic/installation/ingress-nginx.md +++ b/content/nic/installation/ingress-nginx.md @@ -494,6 +494,55 @@ 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). {{< /note >}} +--- + +The following snippets outline Ingress-NGINX Controller annotations that correspond to annotations for NGINX Ingress Controller with respect to enabling TLS and gRPC on backend (upstream) services. + +**Ingress-NGINX Controller** +```yaml +nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" +``` + +**NGINX Ingress Controller** +```yaml +nginx.org/ssl-services: "ssl_service_name" +``` + +--- + +**Ingress-NGINX Controller** +```yaml +nginx.ingress.kubernetes.io/backend-protocol: "GRPC" +``` + +**NGINX Ingress Controller** +```yaml +nginx.org/grpc-services: "grpc_service_name" +``` + +{{< note >}} +Requires HTTP/2 (see http2 ConfigMap key) and only works for Ingresses with TLS termination enabled. +{{< /note >}} + +--- + +**Ingress-NGINX Controller** +```yaml +nginx.ingress.kubernetes.io/backend-protocol: "GRPCS" +``` + +**NGINX Ingress Controller** +```yaml +nginx.org/ssl-services: "grpc_service_name" +nginx.org/grpc-services: "grpc_service_name" +``` + +{{< note >}} +Requires HTTP/2 (see http2 ConfigMap key) and only works for Ingresses with TLS termination enabled. +{{< /note >}} + +--- + ### Global configuration with ConfigMaps This table maps the Ingress-NGINX Controller ConfigMap keys to NGINX Ingress Controller's equivalent ConfigMap keys. From d4bfd2e9096e83425b8e9f60b2dff87e2d3569bf Mon Sep 17 00:00:00 2001 From: Jacob Newfield Date: Thu, 14 Aug 2025 23:32:54 +0000 Subject: [PATCH 2/5] Changes have been made --- content/nic/installation/ingress-nginx.md | 58 +++++------------------ 1 file changed, 12 insertions(+), 46 deletions(-) diff --git a/content/nic/installation/ingress-nginx.md b/content/nic/installation/ingress-nginx.md index 1d8a56ef4..917a7d2a4 100644 --- a/content/nic/installation/ingress-nginx.md +++ b/content/nic/installation/ingress-nginx.md @@ -494,54 +494,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). {{< /note >}} ---- - -The following snippets outline Ingress-NGINX Controller annotations that correspond to annotations for NGINX Ingress Controller with respect to enabling TLS and gRPC on backend (upstream) services. - -**Ingress-NGINX Controller** -```yaml -nginx.ingress.kubernetes.io/backend-protocol: "HTTPS" -``` - -**NGINX Ingress Controller** -```yaml -nginx.org/ssl-services: "ssl_service_name" -``` - ---- - -**Ingress-NGINX Controller** -```yaml -nginx.ingress.kubernetes.io/backend-protocol: "GRPC" -``` - -**NGINX Ingress Controller** -```yaml -nginx.org/grpc-services: "grpc_service_name" -``` +The following table outlines annotation conversions for enabling TLS and gRPC to backend (upstream) services. -{{< note >}} -Requires HTTP/2 (see http2 ConfigMap key) and only works for Ingresses with TLS termination enabled. -{{< /note >}} - ---- - -**Ingress-NGINX Controller** -```yaml -nginx.ingress.kubernetes.io/backend-protocol: "GRPCS" -``` - -**NGINX Ingress Controller** -```yaml -nginx.org/ssl-services: "grpc_service_name" -nginx.org/grpc-services: "grpc_service_name" -``` - -{{< note >}} -Requires HTTP/2 (see http2 ConfigMap key) and only works for Ingresses with TLS termination enabled. -{{< /note >}} +{{< bootstrap-table "table table-bordered table-striped table-responsive" >}} +| 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" +[_nginx.org/grpc-services_]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations.md#backend-services-upstreams" >}}): "grpc_service_name" | ---- +{{% /bootstrap-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 From a982c0a1de29e11bbbe4049e1437d9d47a5d670e Mon Sep 17 00:00:00 2001 From: Jacob Newfield Date: Thu, 14 Aug 2025 23:57:18 +0000 Subject: [PATCH 3/5] Changes have been made --- content/nic/installation/ingress-nginx.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/nic/installation/ingress-nginx.md b/content/nic/installation/ingress-nginx.md index 8bbb92c56..e2b25ce3c 100644 --- a/content/nic/installation/ingress-nginx.md +++ b/content/nic/installation/ingress-nginx.md @@ -499,8 +499,7 @@ The following table outlines annotation conversions for enabling TLS and gRPC to | ------------------------ | ------------------------ | | [_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" -[_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"
[_nginx.org/grpc-services_]({{< ref "/nic/configuration/ingress-resources/advanced-configuration-with-annotations.md#backend-services-upstreams" >}}): "grpc_service_name" | {{% /bootstrap-table %}} {{< call-out "important" >}} @@ -515,6 +514,7 @@ This table maps the Ingress-NGINX Controller ConfigMap keys to NGINX Ingress Con Some of the key names are identical, and each Ingress Controller has ConfigMap keys that the other does not (Which are indicated). {{< /call-out >}} --> + {{< bootstrap-table "table table-bordered table-striped table-responsive" >}} | Ingress-NGINX Controller | NGINX Ingress Controller | | ------------------------ | ------------------------ | From a5cf4767fcb223766239226341ed0e4461713ae5 Mon Sep 17 00:00:00 2001 From: Jacob Newfield Date: Fri, 15 Aug 2025 00:05:52 +0000 Subject: [PATCH 4/5] Changes have been made --- content/nic/installation/ingress-nginx.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/nic/installation/ingress-nginx.md b/content/nic/installation/ingress-nginx.md index e2b25ce3c..a02faeb7c 100644 --- a/content/nic/installation/ingress-nginx.md +++ b/content/nic/installation/ingress-nginx.md @@ -492,7 +492,7 @@ 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 to backend (upstream) services. +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" >}} | Ingress-NGINX Controller | NGINX Ingress Controller | From 3c93e8dde3588802a4834b58223ea43a0f512cfe Mon Sep 17 00:00:00 2001 From: Jacob Newfield Date: Fri, 15 Aug 2025 15:24:22 +0000 Subject: [PATCH 5/5] Changes have been made --- content/nic/installation/ingress-nginx.md | 1 - 1 file changed, 1 deletion(-) diff --git a/content/nic/installation/ingress-nginx.md b/content/nic/installation/ingress-nginx.md index a02faeb7c..d20b4150d 100644 --- a/content/nic/installation/ingress-nginx.md +++ b/content/nic/installation/ingress-nginx.md @@ -514,7 +514,6 @@ This table maps the Ingress-NGINX Controller ConfigMap keys to NGINX Ingress Con Some of the key names are identical, and each Ingress Controller has ConfigMap keys that the other does not (Which are indicated). {{< /call-out >}} --> - {{< bootstrap-table "table table-bordered table-striped table-responsive" >}} | Ingress-NGINX Controller | NGINX Ingress Controller | | ------------------------ | ------------------------ |