docs(configuration): add migration note about k8s (#2266)

This adds some additional information about configuration on k8s for version 4.30+.
pull/2265/head^2
James Elliott 2021-08-07 09:55:17 +10:00 committed by GitHub
parent da03405646
commit b5d0e667cc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 2 deletions

View File

@ -42,8 +42,9 @@ environment variables must be prefixed with `AUTHELIA_`.
_**Please Note:** It is not possible to configure_ the _access control rules section or OpenID Connect identity provider _**Please Note:** It is not possible to configure_ the _access control rules section or OpenID Connect identity provider
section using environment variables at this time._ section using environment variables at this time._
_**Please Note:** There are compatability issues with Kubernetes and this particular configuration option. You must ensure you _**Please Note:** There are compatability issues with Kubernetes and this particular configuration option. You must
have the `enableServiceLinks: false` setting in your pod spec._ ensure you have the `enableServiceLinks: false` setting in your pod spec. You can read more about this in the
[migration documentation](./migration.md#kubernetes-4300)._
Underscores replace indented configuration sections or subkeys. For example the following environment variables replace Underscores replace indented configuration sections or subkeys. For example the following environment variables replace
the configuration snippet that follows it: the configuration snippet that follows it:

View File

@ -42,6 +42,24 @@ The following changes occurred in 4.30.0:
|log_file_path|log.file_path | |log_file_path|log.file_path |
|log_format |log.format | |log_format |log.format |
#### Kubernetes 4.30.0
_**Please Note:** if you're using Authelia with Kubernetes and are not using the provided [helm chart](https://charts.authelia.com)
you will be required to set the following option in your PodSpec. Keeping in mind this example is for a Pod, not for
a Deployment, StatefulSet, or DaemonSet; you will need to adapt the `enableServiceLinks` option to fit into the relevant
location depending on your needs._
```yaml
---
apiVersion: v1
kind: Pod
metadata:
name: authelia
spec:
enableServiceLinks: false
...
```
### 4.25.0 ### 4.25.0
The following changes occurred in 4.25.0: The following changes occurred in 4.25.0: