Files
cozystack/packages/apps/postgres/templates/NOTES.txt
T
Alexey Artamonov 2b5877eff9 feat(postgres)!: generate user passwords and read them at runtime
users[].password is gone from the chart, its schema and the API type.
Every application-user password is generated into <release>-credentials
and kept across reconciles by lookup, so an upgraded release keeps the
password it already has and a password left in values is ignored. The
init-job mounts that Secret and applies each password with ALTER ROLE
and a psql variable, so no password is rendered into the init-script
Secret that Helm keeps in release history. While bootstrap is enabled
the Secret is marked credentials-pending, and NOTES say the generated
passwords apply once the init-job runs.

Names reach superuser SQL and the init-script shell, so render-time
guards reject a username, database or extension name outside
[-._a-zA-Z0-9] or past the length PostgreSQL silently truncates: 63
bytes for a role or extension, 54 for a database, whose <db>_readonly
role would otherwise truncate and fail the next run. A username over 63
bytes that the credentials Secret already carries still upgrades.
users.postgres, the CNPG superuser, is rejected in every bootstrap
state. Changing a database's key in values drops the database, so the
reject message and the README give the rename that keeps the data: a
platform administrator renames it and its roles as the CNPG superuser
before the key changes.

The init-job cannot hang its Helm hook: the readiness wait ends on
elapsed time below activeDeadlineSeconds and the Job never retries, so a
purged restore target fails with a diagnostic. The delete-users pass
reads managed users from pg_shdescription instead of parsing the
version-dependent \du+ layout, which on PostgreSQL 16 and later matched
nothing and left a removed user able to log in; it compares names as
CREATE ROLE stores them and reassigns a removed user's objects in every
database before dropping it. A database without roles renders, and
extension names are quoted for hyphenated names and folded to lowercase
so they resolve as they did unquoted. A value that carries its own
surrounding quotes, the only way a hyphenated extension rendered before,
has that pair removed and keeps its case, so such a release still
upgrades. The README reads a password with jq, since jsonpath splits a
dotted key.

Signed-off-by: Alexey Artamonov <aleksei.artamonov@aenix.io>
2026-09-24 18:10:57 +03:00

21 lines
1.3 KiB
Plaintext

{{- if and .Values.bootstrap.enabled .Values.users }}
WARNING: this PostgreSQL was provisioned as a restore (bootstrap.enabled=true).
The roles recovered from the backup keep their original password hashes, but the
{{ .Release.Name }}-credentials Secret now holds freshly generated passwords that
are NOT yet applied to the database — the init-job that runs ALTER ROLE is skipped
while bootstrap is on. While bootstrap is on the credentials Secret carries the
annotation postgres.cozystack.io/credentials-pending: "true". That flag tracks only
the bootstrap phase, not the whole convergence: the restore driver REMOVES it when
it clears bootstrap.enabled, and that same reconcile is what triggers the init-job
— so the flag is already gone for the short window before the init-job has finished
applying the passwords. Do not read a missing flag as "converged".
The restore driver clears bootstrap.enabled automatically once recovery is healthy,
and the next reconcile runs the init-job to apply the Secret's passwords onto the
recovered roles — no action is required. Confirm convergence by logging in as an
application user rather than by the flag; until a login with the Secret's password
succeeds, do not treat the advertised application passwords as usable — the database
is reachable as the CloudNativePG superuser in the meantime.
{{- end }}