Skip to content

docs: correct operator parameter names, defaults and secret template - #3234

Open
sarankumar1325 wants to merge 2 commits into
zalando:masterfrom
sarankumar1325:docs/fix-operator-parameters-3226
Open

sarankumar1325 wants to merge 2 commits into
zalando:masterfrom
sarankumar1325:docs/fix-operator-parameters-3226

Conversation

@sarankumar1325

Copy link
Copy Markdown

Problem description

The operator parameter reference (docs/reference/operator_parameters.md) disagrees with what the operator actually reads in pkg/util/config/config.go and config.NewFromMap:

  • secret_name_template is 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.
  • Several keys are shown in CamelCase (MaxUnavailability, IgnoreUserSecretPath, Novolumepath) or as the typo connection_pooler_default_meomry_request. NewFromMap lower-cases keys and only fills struct fields that match, so those documented names are ignored.
  • Patroni configuration keys are documented as 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_interval is documented as 5s; the default in config.NewFromMap is 4s.
  • team_api_role_configuration is described but has no example of the name:value list 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:

  • Your go code is formatted. Your IDE should do it automatically for you. (No Go code in this PR.)
  • You have updated generated code when introducing new fields to the acid.zalan.do api package. (No API changes.)
  • New configuration options are reflected in CRD validation, helm charts and sample manifests. (No new options; the reference is aligned with existing parser keys and defaults.)
  • New functionality is covered by unit and/or e2e tests. (Documentation only.)
  • You have checked existing open PRs for possible overlay and referenced them.

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>
@FxKu FxKu added this to the 2.1.0 milestone Nov 11, 2026
@FxKu FxKu moved this to Good state for merge in Postgres Operator Nov 11, 2026

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

Status: Good state for merge

Development

Successfully merging this pull request may close these issues.

Operator parameter reference documents unsupported secret placeholder and configuration keys

2 participants