Ingress routes (legacy)

warning

Ingress routes are a legacy experimental feature that is no longer recommended. Please use the standard nginx-based ingress configuration instead.

info

This page only concerns installation on an existing cluster using Helm.

Overview

We redesigned how we access the cluster using Ingress to get rid of our all-in-one nginx container. This option works for a limited number of Ingress Controller: ingress-nginx, traefik, contour, aws_alb, openshift, istio. Activation is optional and disabled by default.

Activation

To activate Ingress routes, update the values.yaml:

experimental:
  # -- Use new Ingress routes instead of legacy nginx
  ingressRoutes: true

If you notice any unwanted behavior, please let us know and switch back to ingressRoutes: false.

Ingress-NGINX Configuration

If you are using Ingress-NGINX as your ingress controller, by default, it blocks custom directive injection via annotations.

To allow GitGuardian to configure Ingress-NGINX using the nginx.ingress.kubernetes.io/configuration-snippet annotation, you must explicitly enable snippets in your deployment configuration.

Here is an example of the necessary configuration to add to the Ingress-NGINX Helm chart values:

controller:
  allowSnippetAnnotations: true
  config:
    # configuration-snippet annotation is considered "Critical"
    annotations-risk-level: "Critical"