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.

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 3 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
49 changes: 49 additions & 0 deletions content/nic/installation/ingress-nginx.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down