external-nginx
for the public network and internal-nginx for the internal network. A compatibility layer serves an Ingress that
uses one of these classes, and most Ingress resources need no changes. An Ingress with any other class is not
affected.
Does this affect you?
A server installation uses Ingress networking when its Settings > Networking tab shows a Networking mode. A
Helm chart installation uses it when the chart creates an Ingress.
If a chart depends on something that isn’t supported, override its values, use another chart version, or expose the
chart with a Route.
What to use instead
Networking modes are a dashboard setting, and ports replace them. In the installation’s Settings > Networking tab, list the ports your app listens on and choose which ones are public.
In YAML,
spec.networking and Routes replace the Ingress configuration:
Annotation support
Every annotation name on this page starts withnginx.ingress.kubernetes.io/.
Ryvn doesn’t admit an Ingress that sets a rejected annotation on one of its ingress classes.
An Ingress with an allowlist or a denylist can’t have a wildcard host such as
*.example.com. Ryvn rejects it, so
list each hostname.
Behavior differences
HTTPS redirects and trailing slashes
ingress-nginx removes a trailing slash when it redirects HTTP to HTTPS. The compatibility layer keeps the path as requested.
This affects only requests that end in
/. A request for /docs on an Ingress path /docs/ still redirects to
/docs/. If your app treats /docs and /docs/ as different routes, test both.
Timeouts
proxy-read-timeout and proxy-send-timeout both set one deadline for the whole request. If you set both, the larger
value wins.
On ingress-nginx, the read timeout is an idle timeout: the timer restarts each time your app sends data. On the
compatibility layer, it limits the total time of the request. A response that streams one chunk every 45 seconds runs
without end under a 60 second idle timeout, but stops after 60 seconds under a 60 second deadline.
This matters for long-lived HTTP connections: server-sent events, long polling, and large downloads. A large value
such as 86400 still works, but it counts from the start of the request.
proxy-connect-timeout defaults to 60 seconds, the same as ingress-nginx, and a value of 0 is ignored. If several
Ingress resources point at the same Service, set the same value on each. Conflicting values are dropped, and the
Service falls back to 60 seconds.
Timeout annotations don’t apply to a gRPC Ingress.
Buffering
The compatibility layer streams requests and responses to your app and doesn’t hold them in a buffer, so these annotations have no effect:nginx.ingress.kubernetes.io/proxy-bufferingnginx.ingress.kubernetes.io/proxy-buffer-sizenginx.ingress.kubernetes.io/proxy-buffers-numbernginx.ingress.kubernetes.io/proxy-busy-buffers-sizenginx.ingress.kubernetes.io/proxy-busy-buffersnginx.ingress.kubernetes.io/proxy-request-bufferingnginx.ingress.kubernetes.io/client-body-buffer-sizenginx.ingress.kubernetes.io/large-client-header-buffers
Not supported
Snippets
A snippet injects arbitrary NGINX configuration, which is a security risk and makes routing hard to predict. Ryvn rejects an Ingress that sets one of these annotations:nginx.ingress.kubernetes.io/configuration-snippetnginx.ingress.kubernetes.io/server-snippetnginx.ingress.kubernetes.io/auth-snippetnginx.ingress.kubernetes.io/stream-snippet
Basic and external auth
Ryvn rejects an Ingress that sets an auth annotation:- Basic auth:
nginx.ingress.kubernetes.io/auth-type,auth-secret,auth-secret-type,auth-realm - External auth:
nginx.ingress.kubernetes.io/auth-url,auth-signin,auth-signin-redirect-param,auth-response-headers,auth-request-redirect,auth-method,auth-proxy-set-headers - Global auth:
nginx.ingress.kubernetes.io/enable-global-auth,satisfy
Body size
nginx.ingress.kubernetes.io/proxy-body-size has no effect. The compatibility layer sets no limit on the request
body, so large requests reach your app. If you relied on the limit, for example to cap uploads, set it in your app:
- Express.js: the
limitoption onexpress.json()andexpress.urlencoded(). - Next.js Pages Router API routes:
config.api.bodyParser.sizeLimit. App Router Route Handlers have no equivalent, so cap the body as you read it. - Django:
DATA_UPLOAD_MAX_MEMORY_SIZEandFILE_UPLOAD_MAX_MEMORY_SIZE. - Flask:
app.config['MAX_CONTENT_LENGTH']. - Spring Boot:
spring.servlet.multipart.max-request-sizeandmax-file-size. - Go
net/http: wrap the request body withhttp.MaxBytesReader.
gRPC
nginx.ingress.kubernetes.io/grpc-backend is not supported. Use nginx.ingress.kubernetes.io/backend-protocol: GRPC.
A gRPC Ingress ignores the HTTP-only annotations, such as the timeout and redirect annotations.
Backend protocol
nginx.ingress.kubernetes.io/backend-protocol supports HTTP and GRPC. HTTPS and GRPCS, which use TLS to your
app, are not supported, and neither are AUTO_HTTP and FCGI. use-http2 is not needed, because HTTP/2 is used
where it applies.
Ingress spec fields
A few Ingress fields behave differently on the compatibility layer:backend.resourceis not supported. Usebackend.service.spec.defaultBackendcatches unmatched paths only for hosts inspec.rules. Requests for other hosts are rejected.pathType: ImplementationSpecificis a literalPrefixmatch.
Configure an Ingress
These are the steps for installations that still use Ingress networking.Server: networking modes
Server: networking modes
Every server that uses Ingress networking has a networking mode, which sets where it is reachable:
A public server gets a TLS certificate that Ryvn issues and renews, and can serve a custom domain.
Server: add a custom domain
Server: add a custom domain
- Open your installation in the Ryvn dashboard and go to Settings > Networking.
- Switch to Public networking mode. Wait about 10 seconds for the installation to connect to the public load balancer.
- Enter your domain name in the custom domain field and click Save. Convert Unicode domains to Punycode
first. For example,
ëxample.combecomesxn--xample-ova.com. - Copy the load balancer hostname or IP shown below the custom domain field. At your DNS provider, create a CNAME record for your domain with that value. Some providers name this record ALIAS or ANAME.
- Back in Ryvn, click Connect. Ryvn verifies domain ownership and creates a TLS certificate.
- Check that your domain is reachable over HTTPS.
Helm chart: ingress values and a custom domain
Helm chart: ingress values and a custom domain
Each environment has two cert-manager issuers for the ingress classes:
external-issuer for public domains and
internal-issuer for internal domains.-
Go to your installation’s Settings > Helm Values and set the chart’s
ingressvalues:For an internal domain, useclassName: internal-nginxandcert-manager.io/cluster-issuer: internal-issuer. - Click Save to deploy the changes.
- Get the load balancer hostname from your installation’s Resources tab. Find the Ingress resource and copy its address.
-
At your DNS provider, create a CNAME record for your domain with that value. For a root domain such as
example.com, use an ALIAS or ANAME record if your provider supports them. Otherwise use A records with the load balancer IPs.
Helm chart: use the environment's domain
Helm chart: use the environment's domain
Use template variables instead of a hardcoded This resolves to your environment’s public domain. If the environment has a
custom root domain, the templates use it with no changes.
ryvn.run domain:Troubleshooting a custom domain
Troubleshooting a custom domain
If a custom domain doesn’t reach your app, check that its DNS record resolves to the load balancer:To rule out a stale local cache, query a public resolver directly: