Repository navigation
docs: correct operator parameter names, defaults and secret template - #3234
Open
sarankumar1325 wants to merge 2 commits into
Open
sarankumar1325 wants to merge 2 commits into
sarankumar1325 wants to merge 2 commits into
Conversation
The reference documented a {namespace} placeholder that is not
substituted, used CamelCase and typo keys the parser ignores, and listed
the ready_wait_interval default as 5s instead of 4s.
Fixes zalando#3226
Signed-off-by: sarankumar1325 <120080287+sarankumar1325@users.noreply.github.com>
sarankumar1325
requested review from
FxKu,
Jan-M,
hughcapet,
idanovinda,
jopadi and
mikkeloscar
as code owners
November 11, 2026 03:35
FxKu
approved these changes
Nov 11, 2026
This branch has not been deployed
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
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.
Problem description
The operator parameter reference (
docs/reference/operator_parameters.md) disagrees with what the operator actually reads inpkg/util/config/config.goandconfig.NewFromMap:secret_name_templateis documented as{username}.{cluster}.credentials.{namespace}.{tprkind}.{tprgroup}, and{namespace}is listed as a default placeholder. The operator does not substitute{namespace}(or{tprkind}/{tprgroup}as documented). Using{namespace}produces a secret name that is never found.MaxUnavailability,IgnoreUserSecretPath,Novolumepath) or as the typoconnection_pooler_default_meomry_request.NewFromMaplower-cases keys and only fills struct fields that match, so those documented names are ignored.PgHba/TTL/LoopWait/RetryTimeout/MaximumLagOnFailover. The map keys the operator applies are snake_case:pg_hba,ttl,loop_wait,retry_timeout,maximum_lag_on_failover.ready_wait_intervalis documented as5s; the default inconfig.NewFromMapis4s.team_api_role_configurationis described but has no example of thename:valuelist the parser expects.This is a documentation-only fix.
Linked issues
Fixes #3226.
Related but not overlapping: #3225 (infrastructure roles docs).
Checklist
Thanks for submitting a pull request to the Postgres Operator project.
Please, ensure your contribution matches the following items:
acid.zalan.doapi package. (No API changes.)