Beta Testers Unite: Information About the Repo

[james-d-elliott]

This thread is mainly intended as a place for me to move the TODO list, but also for people to suggest things for when the chart is "officially" released. It is also fine if you want to open individual issues and this is more encouraged so we can link commit history to individual issues.

It's also a place you're free to just ask questions.

Basic Overview

The chart is currently in beta and is subject to breaking changes in any chart release until the 1.0.0 release as per semver rules. Once we hit 1.0.0 breaking changes are intended to be limited to major version bumps (1.x.x -> 2.x.x.x). Feature bumps will be restricted to the minor version number (1.0.x -> 1.1.x), and everything else is a patch release which just fixes bugs.

Currently the main thing I'm in thought over is the config map, specifically the providers. There are essentially two ways I can configure them. I can make it so if they're defined they are enabled, or I can make individual switches. For example I can add a key to mysql called "enabled" which is a boolean, which is false by default. The advantage of the enabled option for these purposes is that all options are configured in values, the disadvantage is the chart will require a considerable amount of additional curly braces. I am currently leaning towards using the enabled switch, but if anyone has arguments against it then please let me know.

To Do List

• Values
  • Standard Values
  • Local Values
  • Production Values authelia: add prod values #9
• Setup CI
  • Chart Linting (chart-testing)
  • Chart Releaser
  • yamllint config
  • Merge restrictions (version bump requirement)
  • Unit Testing (terratest?)
  • Integration Testing (kind)
• Chart Values Validation
  • Enabled/Defined Providers authelia: check correct combination of providers #10
  • Statefulness (probably needs tweaking)
• Documentation
  • Chart Documentation
  • Automatically Generate Website Layout with versioned docs (jekyll)

[crutonjohn]

i believe that the "enabled/disabled" or "true/false" pattern is the one i've seen mostly everywhere.

are you running this in your cluster yet, @james-d-elliott ?

[james-d-elliott]

i believe that the "enabled/disabled" or "true/false" pattern is the one i've seen mostly everywhere.

are you running this in your cluster yet, @james-d-elliott ?

Yes I'm using it in my cluster as a DaemonSet with Postgres, Redis Sentinel, and LDAP. There have been no major issues.

The enabled/disabled method is what I went with, as I use argocd and you have to manually specify values that are commented out instead of overriding them.