Ingress reference ¶

This is the reference documentation for ingresses in Nais.

Ingress is the only way to expose your application to the outside world, this is not the recommended way to communicate between applications running in the same environment. For that, you should use service discovery.

Domains ¶

See the environments reference for a list of available domains and their intended use.

Path-based routing ¶

Ingresses may include paths. This allows for routing traffic to only specific parts of your application, or as part of a shared domain between multiple applications like this:

spec:
  ingresses:
    - https://myapplication.example.com/path1
    - https://myapplication.example.com/path2

In the example above, only path1 and path2 are routed to the application including any sub-paths. All other paths may return a 404 error. Please keep in mind that no path stripping is done as part of the routing and the full path is passed to the application.

Ingress redirects ¶

ingress redirects is a way to perform redirects in Nais.

Ingress redirects are used to redirect traffic from one domain to another. This can be useful when you want to change the domain of an application or when you want to redirect traffic from an old domain to a new one.

Ingress customization ¶

Ingresses are automatically created for your application when you specify them in your application manifest. The ingress is created with a set of default values that should work for most applications.

You can tweak the ingress configuration by specifying certain Kubernetes annotations in your application manifest. Any annotation from the HAProxy ingress annotation reference which starts with haproxy.org/ is supported.

Custom timeouts ¶

In some scenarios it is required to have different values for various timeouts. HAProxy provides several timeout-* annotations that can be set per-ingress, for example:

All timeout values require a time unit suffix (e.g. 60s, 5m, 1h).

See the HAProxy ingress annotation reference for the full list of available timeout annotations and their default values.

WebSockets Support ¶

Support for websockets is provided by the HAProxy ingress controller out of the box. No special configuration required. The only requirement to avoid the close of connections is the increase of the values of timeout-server and timeout-client. The default value of these settings is 50s.

A more adequate value to support websockets is a value higher than one hour (1h).

apiVersion: nais.io/v1alpha1
kind: Application
metadata:
  name: myapplication
  namespace: myteam
  annotations:
    haproxy.org/timeout-server: "2h"
    haproxy.org/timeout-client: "2h"
spec:
  ...

Metrics ¶

All requests to your application via ingress will result in metrics being emitted to Prometheus. The metrics are prefixed with haproxy_ and are available per-backend and per-frontend.

Relevant backend metrics include:

See the HAProxy metrics reference for the full list of available metrics.

Uptime probes ¶

All ingresses will automatically have uptime probes enabled on them. This probe will be directed at the application's readiness endpoint using an HTTP GET request. A probe is considered successful if the HTTP status code is 2xx or 3xx. The probe is considered failed if the HTTP status code is 4xx or 5xx.

You can query the uptime probe status using the following PromQL query:

probe_success{app="my-app"} == 1

Example PromQL Queries ¶

Number of HTTP responses from the myapp backend, grouped by status code class:

sum by (code) (haproxy_backend_http_responses_total{proxy=~"myteam_svc_myapp.*"})

Rate of 5xx errors from the myapp backend:

sum(rate(haproxy_backend_http_responses_total{proxy=~"myteam_svc_myapp.*", code="5xx"}[3m]))

Percentage of 5xx errors to the myapp application as a ratio of total requests:

100 * (
  sum(rate(haproxy_backend_http_responses_total{proxy=~"myteam_svc_myapp.*", code="5xx"}[3m]))
  /
  sum(rate(haproxy_backend_http_requests_total{proxy=~"myteam_svc_myapp.*"}[3m]))
)

Ingress access logs ¶

Ingress access logs are enabled by default for all applications and accessible from Grafana Log Explorer by selecting the nais-ingress service.

From there you can use the Filter tab to search for logs from your application by using the ingress_namespace, ingress_name and url_domain labels.

Disable your access logs ¶

In some cases (such as legacy applications that are using personally identifiable information as URL parameters) you might want to disable access logs for a given application. This can be done by using HAProxy's set-log-level action via a backend-config-snippet annotation in your nais yaml:

apiVersion: nais.io/v1alpha1
kind: Application
metadata:
  name: myapplication
  namespace: myteam
  annotations:
    haproxy.org/backend-config-snippet: |
      http-request set-log-level silent
spec:
  ...

To keep personal identifiable information out of access logs use POST data instead or switch to user identifiers that are unique to your application or domain.

Some debugging tips ¶

If the HTTP status code from the response matches what your application returns, the issue is in your application, not the ingress controller. Look in the logs for the corresponding application.

Here are some suggestions depending on what HTTP status code you might receive from the ingress controller:

Full ingress example ¶

apiVersion: nais.io/v1alpha1
kind: Application
metadata:
  name: myapplication
  namespace: myteam
  annotations:
    haproxy.org/timeout-server: "300s"
spec:
  service:
    protocol: http
  ingresses:
    - https://myapplication.ssb.no
    - https://myapplication.intern.ssb.no

apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: myapplication-abcd1234
  namespace: myteam
  annotations:
    haproxy.org/timeout-server: "300s"   # copied from application annotations
spec:
  ingressClassName: external-haproxy
  rules:
    - host: myapplication.ssb.no
      http:
        paths:
          - path: /
            pathType: Prefix
            backend:
              service:
                name: myapplication
                port:
                  number: 80
---
apiVersion: networking.k8s.io/v1
kind: Ingress
metadata:
  name: myapplication-efgh5678
  namespace: myteam
  annotations:
    haproxy.org/timeout-server: "300s"   # copied from application annotations
spec:
  ingressClassName: internal-haproxy
  rules:
    - host: myapplication.intern.ssb.no
      http:
        paths:
          - path: /
            pathType: Prefix
            backend:
              service:
                name: myapplication
                port:
                  number: 80