Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[ISSUE] values.yaml inline documentation for all existingSecret settings is wrong #2628

Open
daniel-ewing opened this issue Dec 2, 2024 · 2 comments
Assignees
Labels
kind/issue Unidentified issue, it could be a bug, misconfig, or anything in between

Comments

@daniel-ewing
Copy link

daniel-ewing commented Dec 2, 2024

Describe the issue:

See for example line 286 which states:

## @param global.identity.auth.operate.existingSecret can be used to reference an existing secret. If not set, a random secret is generated.

This is incorrect.

Actual behavior:

Any global.identity.auth.<component>.existingSecret is a string literal whose value is the actual plaintext secret value encoded in the auto-generated kubernetes secret.

To 'reference an existing secret', the correct syntax is global.identity.auth.<component>.existingSecret.name

Expected behavior:

The documentation should provide the correct information regarding the use of secrets.

@daniel-ewing daniel-ewing added the kind/issue Unidentified issue, it could be a bug, misconfig, or anything in between label Dec 2, 2024
@jonathanlukas
Copy link
Contributor

Info: This is documented here: https://github.com/camunda/camunda-platform-helm/tree/main/charts/camunda-platform-8.6#identity-auth-existing-secrets

The comment should be adjusted.

@hamza-m-masood
Copy link
Contributor

Hello!
We already have an issue to fix these kind of errors: #1898
It is a bigger topic. We will prioritize this when we can.

As a quick fix we can update the documentation and close out this issue. Thank you @jonathanlukas

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/issue Unidentified issue, it could be a bug, misconfig, or anything in between
Projects
None yet
Development

No branches or pull requests

4 participants