Skip to content

Commit 2314c0d

Browse files
docs: update breaking docs (#269)
1 parent 66e31d4 commit 2314c0d

File tree

2 files changed

+47
-3
lines changed

2 files changed

+47
-3
lines changed

charts/authelia/BREAKING.md

+46-2
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,48 @@ the option they want rather than having to wrestle the chart into obedience.
6363
As originally planned we've overhauled the secrets configuration. In part to adapt to the new changes and also to make
6464
the feature much easier to understand.
6565

66+
These changes are separated into two distinct elements:
67+
68+
1. The secrets are now local to where they're used in the configuration instead of in a single location.
69+
1. This has the advantage of if you're for example configuring PostgreSQL that you configure the username and
70+
password at the same time.
71+
2. The implementation specifics have been adjusted so the syntax for all secrets is generally the same.
72+
3. You're able to include varied secrets instead of the single secret like before.
73+
74+
The following section shows a before and after look at the secret generation method.
75+
76+
Before:
77+
78+
```yaml
79+
name:
80+
key: 'KEY_NAME'
81+
value: ""
82+
filename: 'FILE_NAME'
83+
```
84+
85+
After:
86+
87+
```yaml
88+
secret:
89+
## Disables this secret allowing you to handle it yourself in any way you see fit.
90+
disabled: false
91+
92+
## Sets the name of the secret to use. The ~ value indicates the internal secret. Value will be mounted into the
93+
## '/secrets/<secret_name>/<path>' location, where secret_name for ~ is 'internal'.
94+
secret_name: ~
95+
96+
## When using the internal secret this allows setting the value arbitrarily. Only required on the first `helm install`
97+
## or `helm upgrade`, after which it's only required to overwrite it.
98+
value: ''
99+
100+
## Key name within the secret which is the mounted location.
101+
path: 'FILE_NAME'
102+
```
103+
66104
The chart itself is now capable of both generating multiple secrets and utilizing a mix of existing secrets and
67-
generated ones. These settings are configured on a per configuration section basis.
105+
generated ones. These settings are configured on a per configuration section basis specifically in the configMap
106+
section. Above is an example of the way a secret is loaded into the Authelia config, and an example usage can be seen
107+
with `.configMap.storage.postgres.password`.
68108

69109
The HashiCorp Vault Injector options have been removed as they should be configurable via the relevant
70110
labels/annotations. If it's unclear how to achieve a specific chart output value that you need for this purpose please
@@ -94,7 +134,9 @@ The domain value has been removed and is now part of the session section. Each c
94134
generate relevant manifests such as ingresses. This is so we can properly facilitate the multi-cookie domain
95135
configurations. This also affects the default redirection URL which is no longer supported on 4.38.0 helm installations.
96136

97-
See below for representations of the YAML changes (before and after respectively).
137+
See below for representations of the YAML changes.
138+
139+
Before:
98140

99141
```yaml
100142
domain: 'example.com'
@@ -104,6 +146,8 @@ configMap:
104146
default_redirection_url: 'https://www.example.com'
105147
```
106148

149+
After:
150+
107151
```yaml
108152
configMap:
109153
session:

charts/authelia/Chart.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
apiVersion: v2
22
name: authelia
3-
version: 0.9.10
3+
version: 0.9.11
44
kubeVersion: ">= 1.13.0-0"
55
description: Authelia is a Single Sign-On Multi-Factor portal for web apps
66
type: application

0 commit comments

Comments
 (0)