Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
29 changes: 29 additions & 0 deletions pg-cron/Dockerfile
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# 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

# Install extension via `apt-get`
RUN apt-get update && apt-get install -y --no-install-recommends \
"postgresql-${PG_MAJOR}-cron=${EXT_VERSION}"

FROM scratch
ARG PG_MAJOR

# Licenses
COPY --from=builder /usr/share/doc/postgresql-${PG_MAJOR}-cron/copyright /licenses/postgresql-${PG_MAJOR}-cron/

# Libraries
COPY --from=builder /usr/lib/postgresql/${PG_MAJOR}/lib/pg_cron* /lib/
COPY --from=builder /usr/lib/postgresql/${PG_MAJOR}/lib/bitcode/ /lib/bitcode/

# Share
COPY --from=builder /usr/share/postgresql/${PG_MAJOR}/extension/pg_cron* /share/extension/

USER 65532:65532
102 changes: 102 additions & 0 deletions pg-cron/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,102 @@
# pg_cron
<!--
SPDX-FileCopyrightText: Copyright © contributors to CloudNativePG, established as CloudNativePG a Series of LF Projects, LLC.
SPDX-License-Identifier: Apache-2.0
-->

[pg_cron](https://github.com/citusdata/pg_cron) is an open-source extension
that provides a simple cron-based job scheduler for PostgreSQL, allowing you
to schedule PostgreSQL commands directly from the database.

## Usage

### 1. Add the cron extension image to your Cluster

Define the `pg_cron` extension under the `postgresql.extensions` section of
your `Cluster` resource. For example:

```yaml
apiVersion: postgresql.cnpg.io/v1
kind: Cluster
metadata:
name: cluster-pg-cron
spec:
imageName: ghcr.io/cloudnative-pg/postgresql:18-minimal-trixie
instances: 1

storage:
size: 1Gi

postgresql:
parameters:
cron.database_name: app
cron.use_background_workers: "on"

shared_preload_libraries:
- "pg_cron"

extensions:
- name: pg_cron
image:
# renovate: suite=trixie-pgdg depName=postgresql-18-cron
reference: ghcr.io/cloudnative-pg/pg-cron:1.6.7-18-trixie
```

### 2. Enable the extension in a database

You can install `cron` 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-cron-app
spec:
name: app
owner: app
cluster:
name: cluster-pg-cron
extensions:
- name: pg_cron
```

### 3. Verify installation

Once the database is ready, connect to it with `psql` and run:

```sql
\dx
```

You should see `pg_cron` listed among the installed extensions.

## Contributors

This extension is maintained by:

- Jeremy Schneider (@ardentperf)

The maintainers are responsible for:

- Monitoring upstream releases and security vulnerabilities.
- Ensuring compatibility with supported PostgreSQL versions.
- Reviewing and merging contributions specific to this extension's container
image and lifecycle.

---

## 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_cron` 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.
29 changes: 29 additions & 0 deletions pg-cron/metadata.hcl
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
# SPDX-FileCopyrightText: Copyright © contributors to CloudNativePG, established as CloudNativePG a Series of LF Projects, LLC.
# SPDX-License-Identifier: Apache-2.0
metadata = {
name = "pg-cron"
image_name = "pg-cron"

licenses = ["PostgreSQL"]

sql_name = "pg_cron"
shared_preload_libraries = ["pg_cron"]
extension_control_path = []
dynamic_library_path = []
ld_library_path = []
bin_path = []
auto_update_os_libs = false
required_extensions = []
create_extension = false

versions = {
trixie = {
// renovate: suite=trixie-pgdg depName=postgresql-18-cron
"18" = "1.6.7-2.pgdg13+1"
}
bookworm = {
// renovate: suite=bookworm-pgdg depName=postgresql-18-cron
"18" = "1.6.7-2.pgdg12+1"
}
}
}