Skip to content

Commit

Permalink
docs: update breaking docs (#269)
Browse files Browse the repository at this point in the history
  • Loading branch information
james-d-elliott authored Nov 27, 2024
1 parent 66e31d4 commit 2314c0d
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 3 deletions.
48 changes: 46 additions & 2 deletions charts/authelia/BREAKING.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,48 @@ the option they want rather than having to wrestle the chart into obedience.
As originally planned we've overhauled the secrets configuration. In part to adapt to the new changes and also to make
the feature much easier to understand.

These changes are separated into two distinct elements:

1. The secrets are now local to where they're used in the configuration instead of in a single location.
1. This has the advantage of if you're for example configuring PostgreSQL that you configure the username and
password at the same time.
2. The implementation specifics have been adjusted so the syntax for all secrets is generally the same.
3. You're able to include varied secrets instead of the single secret like before.

The following section shows a before and after look at the secret generation method.

Before:

```yaml
name:
key: 'KEY_NAME'
value: ""
filename: 'FILE_NAME'
```
After:
```yaml
secret:
## Disables this secret allowing you to handle it yourself in any way you see fit.
disabled: false

## Sets the name of the secret to use. The ~ value indicates the internal secret. Value will be mounted into the
## '/secrets/<secret_name>/<path>' location, where secret_name for ~ is 'internal'.
secret_name: ~

## When using the internal secret this allows setting the value arbitrarily. Only required on the first `helm install`
## or `helm upgrade`, after which it's only required to overwrite it.
value: ''

## Key name within the secret which is the mounted location.
path: 'FILE_NAME'
```
The chart itself is now capable of both generating multiple secrets and utilizing a mix of existing secrets and
generated ones. These settings are configured on a per configuration section basis.
generated ones. These settings are configured on a per configuration section basis specifically in the configMap
section. Above is an example of the way a secret is loaded into the Authelia config, and an example usage can be seen
with `.configMap.storage.postgres.password`.

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

See below for representations of the YAML changes (before and after respectively).
See below for representations of the YAML changes.

Before:

```yaml
domain: 'example.com'
Expand All @@ -104,6 +146,8 @@ configMap:
default_redirection_url: 'https://www.example.com'
```

After:

```yaml
configMap:
session:
Expand Down
2 changes: 1 addition & 1 deletion charts/authelia/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
apiVersion: v2
name: authelia
version: 0.9.10
version: 0.9.11
kubeVersion: ">= 1.13.0-0"
description: Authelia is a Single Sign-On Multi-Factor portal for web apps
type: application
Expand Down

0 comments on commit 2314c0d

Please sign in to comment.