weave-gitops icon indicating copy to clipboard operation
weave-gitops copied to clipboard

Helm reference documentation update for admin username

Open nealf opened this issue 3 years ago • 0 comments

Describe the bug

The Helm Reference in the documentation says for adminUser.username:

Set username for local admin user, these will be stored in a secret in k8s. Requires adminUser.create and adminUser.createSecret.

but the "requires adminUser.createSecret" doesn't seem to be true. When I was referencing these docs and using an externally managed secret (so adminUser.createSecret: false), I assumed I only needed to set the username in the secret I created. But as I discovered, the username value is referenced directly in the ClusterRoleBinding template and needs to be set in the chart if using something other than the default username value even if not having the chart create the secret.

I think removing that it requires adminUser.createSecret in the Helm reference is probably sufficient to make that more clear, but I haven't checked all of the guided documentation to see if it needs to be cleared up elsewhere. If that's all it is, could probably be added into this other PR with a minor document change.

Environment

  • Weave-Gitops Version - 0.9.6
  • Flux Version - 0.35.0

To Reproduce

Just documentation

Thanks for the project!

nealf avatar Oct 11 '22 22:10 nealf