Docs/external secret config#203
Open
arekborucki wants to merge 3 commits into
Open
Conversation
Adds a top-level "External Secret" section to the configuration guide covering: - The spec.externalSecret field and namespace constraint - Complete list of required Secret keys with format hints - Observe vs Manage policy semantics and when to pick each - The ExternalSecretValid status condition and how to debug ExternalSecretNotFound / ExternalSecretInvalid reasons The feature has been available since ClickHouse#168 but had zero coverage in the docs site, forcing users to read api/v1alpha1/common.go and the reconciler source to understand it.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Adds a top-level "External Secret" section to the configuration guide covering:
spec.externalSecretfield and namespace constraintObservevsManagepolicy semantics and when to pick eachExternalSecretValidstatus condition and how to debugExternalSecretNotFound/ExternalSecretInvalidreasonsWhy
The External Secret feature has been available since #168 but the documentation site had zero mention of it (
grep -c externalSecret docs/returned 0). Users have to readapi/v1alpha1/common.goand thereconciler in
internal/controller/clickhouse/sync.goto understand theObservevsManagepolicy distinction, the required Secret keys (including the conditionalnamed-collections-keyfor ClickHouse>= 25.12), and how to interpret theExternalSecretValidstatus condition.What
Adds a new top-level
## External Secretsection indocs/guides/configuration.mdx, placed between TLS configuration and ClickHouse settings. Four subsections:ClickHouseClusterexample usingexternalSecretinternal/controller/clickhouse/constants.goObservevsManagepolicy comparison with guidance on when to pick eachExternalSecretValidstatus condition withExternalSecretNotFound/ExternalSecretInvalidreasonsNo code or chart changes. documentation only