diff --git a/.github/workflows/bake.yml b/.github/workflows/bake.yml index efbbfb0..6cd30e0 100644 --- a/.github/workflows/bake.yml +++ b/.github/workflows/bake.yml @@ -13,6 +13,7 @@ on: - postgis - pgaudit - pg-crash + - pg-ivm defaults: run: @@ -55,6 +56,9 @@ jobs: pg-crash: - 'pg-crash/**' - *shared + pg-ivm: + - 'pg-ivm/**' + - *shared # Compute a matrix containing the list of all extensions that have been modified - name: Compute matrix diff --git a/CODEOWNERS b/CODEOWNERS index f4dd1e7..a41073c 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -3,3 +3,6 @@ # https://docs.github.com/en/free-pro-team@latest/github/creating-cloning-and-archiving-repositories/about-code-owners * @cloudnative-pg/maintainers @NiccoloFei + +# pg-ivm +/pg-ivm/ @shusaan @cloudnative-pg/maintainers @NiccoloFei diff --git a/README.md b/README.md index 0b9b4ed..f9cb8ad 100644 --- a/README.md +++ b/README.md @@ -36,6 +36,7 @@ they are maintained by their respective authors, and PostgreSQL Debian Group | :--- | :--- | :--- | | **[pgAudit](pgaudit)** | PostgreSQL audit extension | [github.com/pgaudit/pgaudit](https://github.com/pgaudit/pgaudit) | | **[pg_crash](pg-crash)** | **Disruptive** fault injection and chaos engineering extension | [github.com/cybertec-postgresql/pg_crash](https://github.com/cybertec-postgresql/pg_crash) | +| **[pg_ivm](pg_ivm)** | Incremental View Maintenance for PostgreSQL | [github.com/sraoss/pg_ivm](https://github.com/sraoss/pg_ivm) | | **[pgvector](pgvector)** | Vector similarity search for PostgreSQL | [github.com/pgvector/pgvector](https://github.com/pgvector/pgvector) | | **[PostGIS](postgis)** | Geospatial database extension for PostgreSQL | [postgis.net/](https://postgis.net/) | diff --git a/pg-ivm/Dockerfile b/pg-ivm/Dockerfile new file mode 100644 index 0000000..b1ebfc0 --- /dev/null +++ b/pg-ivm/Dockerfile @@ -0,0 +1,28 @@ +# SPDX-FileCopyrightText: Copyright © contributors to CloudNativePG, established as CloudNativePG a Series of LF Projects, LLC. +# SPDX-License-Identifier: Apache-2.0 + +ARG BASE=ghcr.io/cloudnative-pg/postgresql:18-minimal-trixie +FROM $BASE AS builder + +ARG PG_MAJOR +ARG EXT_VERSION + +USER 0 + +RUN apt-get update && \ + apt-get install -y --no-install-recommends "postgresql-${PG_MAJOR}-pg-ivm=${EXT_VERSION}" + +FROM scratch +ARG PG_MAJOR + +# Licenses +COPY --from=builder /usr/share/doc/postgresql-${PG_MAJOR}-pg-ivm/copyright /licenses/postgresql-${PG_MAJOR}-pg-ivm/ + +# Libraries +COPY --from=builder /usr/lib/postgresql/${PG_MAJOR}/lib/pg_ivm* /lib/ +COPY --from=builder /usr/lib/postgresql/${PG_MAJOR}/lib/bitcode/ /lib/bitcode/ + +# Share +COPY --from=builder /usr/share/postgresql/${PG_MAJOR}/extension/pg_ivm* /share/extension/ + +USER 65532:65532 \ No newline at end of file diff --git a/pg-ivm/README.md b/pg-ivm/README.md new file mode 100644 index 0000000..14ed49b --- /dev/null +++ b/pg-ivm/README.md @@ -0,0 +1,84 @@ +# `pg_ivm` + +[pg_ivm](https://github.com/sraoss/pg_ivm) is an open-source extension +that provides **Incremental View Maintenance (IVM)** for PostgreSQL, allowing +materialized views to be updated incrementally when base tables change. + +## Usage + +### 1. Add the pg_ivm extension image to your Cluster + +Define the `pg_ivm` extension under the `postgresql.extensions` section of +your `Cluster` resource. For example: + +```yaml +apiVersion: postgresql.cnpg.io/v1 +kind: Cluster +metadata: + name: cluster-pg-ivm +spec: + imageName: ghcr.io/cloudnative-pg/postgresql:18-minimal-trixie + instances: 1 + + storage: + size: 1Gi + + postgresql: + extensions: + - name: pg_ivm + image: + # renovate: suite=trixie-pgdg depName=postgresql-18-pg-ivm + reference: ghcr.io/cloudnative-pg/pg-ivm:1.13-18-trixie +``` + +### 2. Enable the extension in a database + +You can install `pg_ivm` in a specific database by creating or updating a +`Database` resource. For example, to enable it in the `app` database: + +```yaml +apiVersion: postgresql.cnpg.io/v1 +kind: Database +metadata: + name: cluster-pg-ivm-app +spec: + name: app + owner: app + cluster: + name: cluster-pg-ivm + extensions: + - name: pg_ivm + # renovate: suite=trixie-pgdg depName=postgresql-18-pg-ivm extractVersion=^(?\d+\.\d+) + version: '1.13' +``` + +### 3. Verify installation + +Once the database is ready, connect to it with `psql` and run: + +```sql +\dx +``` + +You should see `pg_ivm` listed among the installed extensions. + +## Maintainers + +This container image is maintained by @shuusan. + +--- + +## Licenses and Copyright + +This container image contains software that may be licensed under various +open-source licenses. + +All relevant license and copyright information for the `pg_ivm` extension +and its dependencies are bundled within the image at: + +```text +/licenses/ +``` + +By using this image, you agree to comply with the terms of the licenses +contained therein. diff --git a/pg-ivm/metadata.hcl b/pg-ivm/metadata.hcl new file mode 100644 index 0000000..da3952b --- /dev/null +++ b/pg-ivm/metadata.hcl @@ -0,0 +1,35 @@ +metadata = { + name = "pg-ivm" + sql_name = "pg_ivm" + image_name = "pg-ivm" + licenses = ["PostgreSQL"] + shared_preload_libraries = [] + postgresql_parameters = {} + extension_control_path = [] + dynamic_library_path = [] + ld_library_path = [] + bin_path = [] + env = {} + auto_update_os_libs = false + required_extensions = [] + create_extension = true + + versions = { + trixie = { + "18" = { + // renovate: suite=trixie-pgdg depName=postgresql-18-pg-ivm + package = "1.13-1.pgdg13+1" + // renovate: suite=trixie-pgdg depName=postgresql-18-pg-ivm extractVersion=^(?\d+\.\d+) + sql = "1.13" + } + } + bookworm = { + "18" = { + // renovate: suite=bookworm-pgdg depName=postgresql-18-pg-ivm + package = "1.13-1.pgdg12+1" + // renovate: suite=bookworm-pgdg depName=postgresql-18-pg-ivm extractVersion=^(?\d+\.\d+) + sql = "1.13" + } + } + } +} diff --git a/pg-ivm/test/chainsaw-test.yaml b/pg-ivm/test/chainsaw-test.yaml new file mode 100644 index 0000000..783f262 --- /dev/null +++ b/pg-ivm/test/chainsaw-test.yaml @@ -0,0 +1,28 @@ +apiVersion: chainsaw.kyverno.io/v1alpha1 +kind: Test +metadata: + name: verify-pg-ivm-extension +spec: + timeouts: + apply: 5s + assert: 3m + delete: 30s + description: Verify pg_ivm extension is properly installed + steps: + - name: Create a Cluster with the extension + try: + - apply: + file: cluster.yaml + - apply: + file: database.yaml + - assert: + file: cluster-assert.yaml + - assert: + file: database-assert.yaml + + - name: Verify extension is installed + try: + - apply: + file: check-extension.yaml + - assert: + file: check-extension-assert.yaml diff --git a/pg-ivm/test/check-extension-assert.yaml b/pg-ivm/test/check-extension-assert.yaml new file mode 100644 index 0000000..a7971fc --- /dev/null +++ b/pg-ivm/test/check-extension-assert.yaml @@ -0,0 +1,6 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: extension-installed +status: + succeeded: 1 diff --git a/pg-ivm/test/check-extension.yaml b/pg-ivm/test/check-extension.yaml new file mode 100644 index 0000000..11afb20 --- /dev/null +++ b/pg-ivm/test/check-extension.yaml @@ -0,0 +1,33 @@ +apiVersion: batch/v1 +kind: Job +metadata: + name: extension-installed +spec: + template: + spec: + restartPolicy: OnFailure + containers: + - name: data-test + env: + - name: EXT_VERSION + value: ($values.version) + - name: DB_URI + valueFrom: + secretKeyRef: + name: (join('-', [$values.name, 'app'])) + key: uri + image: alpine/psql:latest + command: ['sh', '-c'] + args: + - | + set -e + DB_URI=$(echo $DB_URI | sed "s|/\*|/|") + test "$(psql "$DB_URI" -tAc "SELECT EXISTS (SELECT FROM pg_catalog.pg_extension WHERE extname = 'pg_ivm' AND extversion = '${EXT_VERSION}')" -q)" = "t" + psql "$DB_URI" -c "DROP TABLE IF EXISTS test_ivm CASCADE;" + psql "$DB_URI" -c "DROP TABLE IF EXISTS base_table CASCADE;" + psql "$DB_URI" -c "CREATE TABLE base_table (id INT PRIMARY KEY, value TEXT);" + psql "$DB_URI" -c "INSERT INTO base_table VALUES (1, 'test');" + psql "$DB_URI" -c "SELECT pgivm.create_immv('test_ivm', 'SELECT * FROM base_table');" + test "$(psql "$DB_URI" -tAc "SELECT COUNT(*) FROM test_ivm" -q)" = "1" + psql "$DB_URI" -c "INSERT INTO base_table VALUES (2, 'test2');" + test "$(psql "$DB_URI" -tAc "SELECT COUNT(*) FROM test_ivm" -q)" = "2" diff --git a/pg-ivm/test/cluster-assert.yaml b/pg-ivm/test/cluster-assert.yaml new file mode 100644 index 0000000..aa22123 --- /dev/null +++ b/pg-ivm/test/cluster-assert.yaml @@ -0,0 +1,8 @@ +apiVersion: postgresql.cnpg.io/v1 +kind: Cluster +metadata: + name: ($values.name) +status: + readyInstances: 1 + phase: Cluster in healthy state + image: ($values.pg_image) diff --git a/pg-ivm/test/cluster.yaml b/pg-ivm/test/cluster.yaml new file mode 100644 index 0000000..48d6fe0 --- /dev/null +++ b/pg-ivm/test/cluster.yaml @@ -0,0 +1,15 @@ +apiVersion: postgresql.cnpg.io/v1 +kind: Cluster +metadata: + name: ($values.name) +spec: + imageName: ($values.pg_image) + instances: 1 + + storage: + size: 1Gi + + postgresql: + parameters: ($values.postgresql_parameters) + shared_preload_libraries: ($values.shared_preload_libraries) + extensions: ($values.extensions) diff --git a/pg-ivm/test/database-assert.yaml b/pg-ivm/test/database-assert.yaml new file mode 100644 index 0000000..dcc0f42 --- /dev/null +++ b/pg-ivm/test/database-assert.yaml @@ -0,0 +1,10 @@ +apiVersion: postgresql.cnpg.io/v1 +kind: Database +metadata: + name: (join('-', [$values.name, 'app'])) +status: + applied: true + extensions: + - applied: true + name: ($values.sql_name) + observedGeneration: 1 diff --git a/pg-ivm/test/database.yaml b/pg-ivm/test/database.yaml new file mode 100644 index 0000000..fd61499 --- /dev/null +++ b/pg-ivm/test/database.yaml @@ -0,0 +1,12 @@ +apiVersion: postgresql.cnpg.io/v1 +kind: Database +metadata: + name: (join('-', [$values.name, 'app'])) +spec: + name: app + owner: app + cluster: + name: ($values.name) + extensions: + - name: ($values.sql_name) + version: ($values.version)