Skip to content

Add a note to README about how externalSecret should be configured.#885

Merged
jiechenz merged 2 commits intomainfrom
rh-secret-readme
Apr 13, 2026
Merged

Add a note to README about how externalSecret should be configured.#885
jiechenz merged 2 commits intomainfrom
rh-secret-readme

Conversation

@robholland
Copy link
Copy Markdown
Contributor

What was changed

Documented an example of using externalSecret.

Checklist

  1. Closes Please document how to use an existingSecret for DB connection parameters #799

@robholland robholland requested a review from a team as a code owner April 10, 2026 11:30
Comment thread README.md Outdated
Comment on lines +118 to +128
The secret should have the following structure:

```yaml
apiVersion: v1
kind: Secret
metadata:
name: temporal-db-secret
type: Opaque
data:
password: <base64-encoded-password>
```
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: This YAML block could be confusing as something the user needs to write. If we want to keep it, how about rephrase to "To verify the secret was created, run kubectl get secret temporal-db-secret -o yaml" so readers understand this is output, not a second step.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've re-worded, please see if it's better now.

@robholland robholland requested a review from jiechenz April 13, 2026 09:11
@jiechenz jiechenz merged commit 5a99926 into main Apr 13, 2026
4 checks passed
@jiechenz jiechenz deleted the rh-secret-readme branch April 13, 2026 17:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Please document how to use an existingSecret for DB connection parameters

2 participants