GitHub Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Toggle Dark/Light/Auto mode Back to homepage
  1. Uitsmijter Documentation
  2. /
  3. General
  4. /
  5. Requirements

Requirements

Kubernetes

This application is mainly meant to run on Kubernetes (K8s) and protect resources that run on Kubernetes clusters. Uitsmijter is tested on Kubernetes version 1.22.0 and above.

Must have preinstalled resources

  • 🔗 Traefik in version >= 2.9 Currently the Interceptor Mode is only available for Traefik at the moment. If you are using other ingress controllers, please feel free to contact us. We are constantly working on new features and integrations.

    Attention: You have to enable allowExternalNameServices in Traefik! See 🔗 this Traefik documentation to set up Traefik correctly.

    Settings in Traefik deployment

    - --providers.kubernetesingress.allowExternalNameServices=true

  • 🔗 Helm in version > 3.0 We provide a setup routine in Helm Charts that installs Uitsmijter onto Kubernetes with all necessary resources. Read more about the installation process in the quick start tutorial.

  • 🔗 Cert-Manager Valid certificates are a must-have for a secure login. We recommend to use cert-manager to get valid 🔗 Let’s Encrypt certificates for your cluster ingresses.

  • 🔗 config-syncer The authorization server signs the JWT with a secret that every client must know. Rather than storing various secrets in different namespaces that are hard to keep in sync we recommend to use config-syncer to distribute the one secret to every namespace that is allowed to consume the secret.

  • 🔗 Prometheus Uitsmijter does not have its own management portal because it is not necessary and would brand the product. For the sake of simplicity and fully respect of your workflow everything can be configured as declarative code in 🔗 custom resources and 🔗 configmaps. To see what is Uitsmijter doing, it provides a wide set of metrics data in the 🔗 OpenMetrics format. We recommend to use Prometheus to collect the metrics.

  • 🔗 Grafana Because of the absence of an administrative portal that would dictate you how to take a look on the metrics, Uitsmijter offers a wide range of OpenMetrics data. To show them in meaningfully graphs a Grafana Dashboard is provided. You may want to use the dashboard as a starting point and bring in your own business metrics.

Docker

It is possible to run Uitsmijter in a docker environment for production. Unfortunately this operational mode is not documented yet.

Must have preinstalled resources

If you are using docker or some other kind of orchestration please feel free to contact us. We are open to share some information and can help to implement Uitsmijter in a different setup than Kubernetes.

Further readings