Skip to content

Latest commit

 

History

13 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

PostgreSQL (CloudNativePG)

Build Status Last Commit OCI Pulls sysvipc Required

PostgreSQL on FreeBSD, compatible with the CloudNativePG Kubernetes operator. Includes pgvector, pgaudit, and pg_failover_slots.

Port 5432
Registry ghcr.io/daemonless/cnpg-postgres
Source https://www.postgresql.org/
Website https://cloudnative-pg.io/

Version Tags

Tag Description Best For
17 / 17-standard FreeBSD Quarterly. Uses stable, tested packages. Production stability.
18 / 18-standard / latest / standard FreeBSD Quarterly. Uses stable, tested packages. Most users — recommended.

Prerequisites

Before deploying, ensure your host environment is ready. See the Quick Start Guide for host setup instructions.

Deployment

Podman Compose

services:
  cnpg-postgres:
    image: "ghcr.io/daemonless/cnpg-postgres:latest"
    container_name: cnpg-postgres
    volumes:
      - "/path/to/containers/cnpg-postgres:/var/lib/postgresql/data"
    ports:
      - "5432:5432"
    annotations:
      org.freebsd.jail.allow.sysvipc: "true"
    # always (not unless-stopped) so FreeBSD's podman rc.d auto-starts it at boot
    restart: always

Save as compose.yaml, then run podman-compose up -d.

AppJail Director

.env:

# .env

DIRECTOR_PROJECT=cnpg-postgres

appjail-director.yml:

# appjail-director.yml

options:
  - virtualnet: ':<random> default'
  - nat:
services:
  cnpg-postgres:
    name: cnpg_postgres
    options:
      - container: 'args:--pull'
      - expose: '5432:5432 proto:tcp'
      - template: !ENV '${PWD}/template.conf'
    volumes:
      - cnpg-postgres: /var/lib/postgresql/data
volumes:
  cnpg-postgres:
    device: '/path/to/containers/cnpg-postgres'

Makejail:

# Makejail

ARG tag=latest

OPTION container=boot
OPTION overwrite=force
OPTION from=ghcr.io/daemonless/cnpg-postgres:${tag}

template.conf:

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

Save the files above, then run appjail-director up.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Podman CLI

podman run -d --name cnpg-postgres \
  -p 5432:5432 \
  --annotation 'org.freebsd.jail.allow.sysvipc=true' \
  -v /path/to/containers/cnpg-postgres:/var/lib/postgresql/data \
  ghcr.io/daemonless/cnpg-postgres:latest

Save as run.sh, then run sh run.sh.

AppJail

appjail oci run -Pd \
  -o overwrite=force \
  -o container="args:--pull" \
  -o virtualnet=":<random> default" \
  -o nat \
  -o template=template.conf \
  -o expose="5432:5432 proto:tcp" \
  -o fstab="/path/to/containers/cnpg-postgres /var/lib/postgresql/data <pseudofs>" \
  ghcr.io/daemonless/cnpg-postgres:latest cnpg-postgres

template.conf:

# template.conf

exec.start: "/bin/sh /etc/rc"
exec.stop: "/bin/sh /etc/rc.shutdown jail"
mount.devfs
persist
allow.sysvipc

Save the files above, then run sh run.sh.

Warning

Exposing ports in AppJail means that your service can be reached from remote hosts. If that is not your intention, do not expose the ports and communicate with the service using the jail's IPv4 address or hostname assigned by the virtual network.

To avoid exposing ports, just remove the expose option in your appjail-director.yml or from your command-line arguments.

Bastille

Warning

Bastille's OCI support is experimental. It requires buildah and shares the host network stack (inherit). Mount volumes with --volume HOST JAIL; without it, image-declared volumes are stored under ${bastille_volumesdir}/${jail}.

services:
  cnpg-postgres:
    name: cnpg-postgres
    image: "ghcr.io/daemonless/cnpg-postgres:latest"
    network:
      - mode: host
    volumes:
      - "/path/to/containers/cnpg-postgres:/var/lib/postgresql/data"

Save as bastille-compose.yml, then run bastille up. Or via CLI:

bastille create -O \
  --volume /path/to/containers/cnpg-postgres /var/lib/postgresql/data \
  cnpg-postgres ghcr.io/daemonless/cnpg-postgres:latest inherit

Ansible

- name: Deploy cnpg-postgres
  containers.podman.podman_container:
    name: cnpg-postgres
    image: "ghcr.io/daemonless/cnpg-postgres:latest"
    state: started
    restart_policy: always
    ports:
      - "5432:5432"
    volumes:
      - "/path/to/containers/cnpg-postgres:/var/lib/postgresql/data"
    annotation:
      org.freebsd.jail.allow.sysvipc: "true"

Save as cnpg-postgres-deploy.yaml, then run ansible-playbook cnpg-postgres-deploy.yaml.

Parameters

Volumes

Path Description
/var/lib/postgresql/data Database data directory

Ports

Port Protocol Description
5432 TCP PostgreSQL port

Architectures: amd64 User: bsd (UID/GID via PUID/PGID, defaults to 1000:1000) Base: FreeBSD 15.1


Need help? Join our Discord community.

About

PostgreSQL on FreeBSD, compatible with the CloudNativePG Kubernetes operator. Includes pgvector, pgaudit, and pg_failover_slots.

Topics

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages