Skip to content

docs: fix extension name in timescaledb-oss README example#225

Merged
gbartolini merged 1 commit into
mainfrom
docs/fix-timescaledb-oss-extension-name
May 29, 2026
Merged

docs: fix extension name in timescaledb-oss README example#225
gbartolini merged 1 commit into
mainfrom
docs/fix-timescaledb-oss-extension-name

Conversation

@gbartolini
Copy link
Copy Markdown
Contributor

@gbartolini gbartolini commented May 29, 2026

Fixes the extension name used in the postgresql.extensions section of the Cluster example in timescaledb-oss/README.md.

The example used timescaledb instead of the correct extension name timescaledb-oss (the metadata name). This now matches the convention used by the other extensions (e.g. pgvector uses name: pgvector under postgresql.extensions and name: vector under the Database resource).

The Database resource example and the \dx verification text are left unchanged, as they correctly refer to the SQL extension name timescaledb (the metadata sql_name).

Closes #224

The `postgresql.extensions` section of the Cluster example used
`timescaledb` instead of the correct extension name `timescaledb-oss`
(the metadata `name`). The `Database` resource correctly keeps the SQL
extension name `timescaledb` (the metadata `sql_name`).

Closes #224

Assisted-by: Claude Opus 4.8
Signed-off-by: Gabriele Bartolini <gabriele.bartolini@enterprisedb.com>
@jcpunk
Copy link
Copy Markdown

jcpunk commented May 29, 2026

Since the name of the element from ClusterImageCatalog is timescaledb-oss, but the name of the extension for postgresql is timescaledb, I don't think documentation alone will resolve the issue.

CNPG tries to either map timescaledb to an artifact (https://github.com/cloudnative-pg/artifacts/blob/main/image-catalogs-extensions/catalog-minimal-trixie.yaml#L45) and fails to find the extension image or tries to create extension timescaledb-oss. Neither of those will work.

@gbartolini
Copy link
Copy Markdown
Contributor Author

gbartolini commented May 29, 2026

The create extension command is driven by what's written in the Database resource though.

@gbartolini gbartolini merged commit 044deef into main May 29, 2026
17 checks passed
@gbartolini gbartolini deleted the docs/fix-timescaledb-oss-extension-name branch May 29, 2026 11:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: incorrect extension name in timescaledb-oss README example

4 participants