Add documentation

This commit is contained in:
Philipp Kolberg 2023-10-28 22:30:01 +02:00
parent ca025690e0
commit 996dfd649c
No known key found for this signature in database
GPG key ID: 4C58CB0448FF9061
2 changed files with 8 additions and 2 deletions

View file

@ -43,10 +43,14 @@ kubernetes_replicas: 1
kubernetes_namespace: authentik
# Any additional annotations to add to the ingress object, for example cert-manager
kubernetes_ingress_annotations: {}
# Name of the secret that is used for TLS connections
# Name of the secret that is used for TLS connections, leave empty to disable TLS
kubernetes_ingress_secret_name: authentik-outpost-tls
# Service kind created, can be set to LoadBalancer for LDAP outposts for example
kubernetes_service_type: ClusterIP
# Service IP family policy, can be SingleStack, PreferDualStack or RequireDualStack
kubernetes_service_ip_family_policy: SingleStack
# Service IP families, can be any combination of 'IPv4' and 'IPv6'
kubernetes_service_ip_families: []
# Disable any components of the kubernetes integration, can be any of
# - 'secret'
# - 'deployment'

View file

@ -22,9 +22,11 @@ The following outpost settings are used:
- `kubernetes_replicas`: Replica count for the deployment of the outpost
- `kubernetes_namespace`: Namespace to deploy in, defaults to the same namespace authentik is deployed in (if available)
- `kubernetes_ingress_annotations`: Any additional annotations to add to the ingress object, for example cert-manager
- `kubernetes_ingress_secret_name`: Name of the secret that is used for TLS connections
- `kubernetes_ingress_secret_name`: Name of the secret that is used for TLS connections, can be empty to disable TLS config
- `kubernetes_ingress_class_name`: Optionally set the ingress class used for the generated ingress, requires authentik 2022.11.0
- `kubernetes_service_type`: Service kind created, can be set to LoadBalancer for LDAP outposts for example
- `kubernetes_service_ip_family_policy`: IP family policy that is applied to the service
- `kubernetes_service_ip_families`: Specify which IP families the service will use
- `kubernetes_disabled_components`: Disable any components of the kubernetes integration, can be any of
- 'secret'
- 'deployment'