Skip to content

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

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.

Sign up for GitHub

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

Open
sarankumar1325 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

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

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aca637e
docs: correct operator parameter names, defaults and secret template
sarankumar1325 Nov 11, 2026
03d664c
Merge branch 'master' into docs/fix-operator-parameters-3226
FxKu Nov 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 10 additions & 12 deletions docs/reference/operator_parameters.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -430,13 +430,11 @@ configuration they are grouped under the `kubernetes` key.

* **secret_name_template**
a template for the name of the database user secrets generated by the
operator. `{namespace}` is replaced with name of the namespace if
`enable_cross_namespace_secret` is set, otherwise the
secret is in cluster's namespace. `{username}` is replaced with name of the
secret, `{cluster}` with the name of the cluster, `{tprkind}` with the kind
of CRD (formerly known as TPR) and `{tprgroup}` with the group of the CRD.
No other placeholders are allowed. The default is
`{namespace}.{username}.{cluster}.credentials.{tprkind}.{tprgroup}`.
operator. `{username}` is replaced with the name of the user, `{cluster}`
with the name of the cluster, `{tprkind}` with the kind of CRD (formerly
known as TPR) and `{tprgroup}` with the group of the CRD. No other
placeholders are allowed. The default is
`{username}.{cluster}.credentials.{tprkind}.{tprgroup}`.

* **cluster_domain**
defines the default DNS domain for the kubernetes cluster the operator is
Expand Down Expand Up @@ -659,11 +657,11 @@ configuration `resource_check_interval` and `resource_check_timeout` have no
effect, and the parameters are grouped under the `timeouts` key in the
CRD-based configuration.

* **PatroniAPICheckInterval**
* **patroni_api_check_interval**
the interval between consecutive attempts waiting for the return of
Patroni Api. The default is `1s`.

* **PatroniAPICheckTimeout**
* **patroni_api_check_timeout**
the timeout for a response from Patroni Api. The default is `5s`.

* **resource_check_interval**
Expand All @@ -687,7 +685,7 @@ CRD-based configuration.

* **ready_wait_interval**
the interval between consecutive attempts waiting for the `postgresql` CRD to
be created. The default is `5s`.
be created. The default is `4s`.

* **ready_wait_timeout**
the timeout for the complete `postgresql` CRD creation. The default is `30s`.
Expand Down Expand Up @@ -970,7 +968,7 @@ key.
with the exception of the `search_path`. For instance:

```yaml
teams_api_role_configuration: "log_statement:all,search_path:'data,public'"
team_api_role_configuration: "log_statement:all,search_path:'data,public'"
```
The default is `"log_statement:all"`

Expand Down Expand Up @@ -1108,7 +1106,7 @@ operator being able to provide some reasonable defaults.
Default pooler mode, `session` or `transaction`. Default is `transaction`.

* **connection_pooler_default_cpu_request**
**connection_pooler_default_memory_reques**
**connection_pooler_default_memory_request**
**connection_pooler_default_cpu_limit**
**connection_pooler_default_memory_limit**
Default resource configuration for connection pooler deployment.