Add some implementation notes about k8s. Fixes #2882
2.6 KiB
layout | title | parent | nav_order |
---|---|---|---|
default | Deployment - Kubernetes | Deployment | 3 |
Deployment on Kubernetes
UNDER CONSTRUCTION
The following areas are actively being worked on for Kubernetes:
- Detailed Documentaiton
- Helm Chart (v3)
- Kustomize Deployment
- Manifest Examples
Users are welcome to reach out directly by using any of our various contact options.
Important Notes
The following section has special notes regarding utilizing Authelia with Kubernetes.
- Authelia (and all of your other applications) may receive an invalid remote IP if the service handling traffic to
the Kubernetes Ingress of your choice doesn't have the
externalTrafficPolicy
setting configured tolocal
as per the Kubernetes preserving the client source ip documentation. - Authelia's configuration management system conflicts with the
enableServiceLinks
option when it's set totrue
which is the default. This shoudld be changed tofalse
.
NGINX Ingress Controller
If you use NGINX Ingress Controller you can protect an ingress with the following annotations. The assumptions are that your public domain where authelia is running would be https://auth.mypublicdomain.com and there would be a service called authelia with port 80 in the default namespace.
annotations:
nginx.ingress.kubernetes.io/auth-response-headers: Remote-User,Remote-Name,Remote-Groups,Remote-Email
nginx.ingress.kubernetes.io/auth-signin: https://auth.mypublicdomain.com
nginx.ingress.kubernetes.io/auth-snippet: |
proxy_set_header X-Forwarded-Method $request_method;
nginx.ingress.kubernetes.io/auth-url: http://authelia.default.svc.cluster.local/api/verify
nginx.ingress.kubernetes.io/configuration-snippet: |
proxy_set_header X-Forwarded-Method $request_method;
FAQ
RAM usage
If using file-based authentication, the argon2id provider will by default use 1GB of RAM for password generation. This means you should allow for at least this amount in your deployment/daemonset spec and have this much available on your node, alternatively you can tweak the providers settings. Otherwise, your Authelia may OOM during login. See here for more info.