paradedb v0.1.0

Databases

ParadeDB — a PostgreSQL distribution with full-text search and analytics built in (a Postgres-native Elasticsearch alternative). Drop-in Postgres wire-compatible. Deployed as a single host-networked Nomad service.

nomad-pack run paradedb --registry nomploy

…or one line (add registry + run)

curl -fsSL https://packs.nomploy.com/install.sh | sh -s -- paradedb

Needs nomad-pack on PATH. The script only adds the nomploy registry and runs this pack.

Source ↗ Project ↗ ★ 9.3k ⚑ Report an issue

1 task db 5432 1 volume image paradedb/paradedb:latest tracks :latest image bumped today

Variables 11

values.hcl

Save as values.hcl, edit, then run:

nomad-pack run paradedb -f values.hcl --registry nomploy

# The name of the Nomad job.
job_name = "paradedb"

# The Nomad namespace to deploy into.
namespace = "default"

# The datacenters to deploy to.
datacenters = ["*"]

# The ParadeDB container image. Pin a tag in production.
image = "paradedb/paradedb:latest"

# Host port for the PostgreSQL wire protocol.
port = 5432

# Initial database name (POSTGRES_DB).
db_name = "paradedb"

# PostgreSQL superuser name (POSTGRES_USER).
db_user = "postgres"

# PostgreSQL superuser password (POSTGRES_PASSWORD). CHANGE THIS.
db_password = "change-me-paradedb"

# Named volume mounted at /var/lib/postgresql/data.
data_volume = "paradedb_data"

# Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
constraints = []

# The task resources.
resources = {
    cpu    = 500
    memory = 512
  }

Name	Type	Default	Description
job_name	string	"paradedb"	The name of the Nomad job.
namespace	string	"default"	The Nomad namespace to deploy into.
datacenters	list	["*"]	The datacenters to deploy to.
image	string	"paradedb/paradedb:latest"	The ParadeDB container image. Pin a tag in production.
port	number	5432	Host port for the PostgreSQL wire protocol.
db_name	string	"paradedb"	Initial database name (POSTGRES_DB).
db_user	string	"postgres"	PostgreSQL superuser name (POSTGRES_USER).
db_password set me	string	"change-me-paradedb"	PostgreSQL superuser password (POSTGRES_PASSWORD). CHANGE THIS.
data_volume	string	"paradedb_data"	Named volume mounted at /var/lib/postgresql/data.
constraints	list	[]	Placement constraints. On a nomploy cluster: attribute = "$${meta.nomploy_control_plane}", operator = "=", value = "true".
resources	object	{ cpu = 500 memory = 512 }	The task resources.

Back up this pack

This pack stores data in one Docker named volume: paradedb_data

restic

# Run on the node hosting this pack. Point restic at your repo first:
#   export RESTIC_REPOSITORY="s3:https://<account>.r2.cloudflarestorage.com/<bucket>"
#   export RESTIC_PASSWORD="<repo-password>"
#   export AWS_ACCESS_KEY_ID=<key>  AWS_SECRET_ACCESS_KEY=<secret>
restic backup \
  /var/lib/docker/volumes/paradedb_data/_data

rclone (sync to S3/R2)

rclone sync /var/lib/docker/volumes/paradedb_data/_data backup:<bucket>/paradedb_data

Paths assume the default Docker volume location (/var/lib/docker/volumes). Restore by stopping the job, restoring files into the same volume, and re-running the pack.

Readme

paradedb

ParadeDB — a PostgreSQL distribution with full-text search (BM25) and analytics built in, a Postgres-native alternative to bolting on Elasticsearch. It's wire-compatible with Postgres, so existing drivers, ORMs and tools just work — you get pg_search and columnar analytics inside your database.

Single host-networked Nomad service with a persistent data volume.

Deploy

nomad-pack registry add nomploy https://github.com/Nomploy/nomad-packs
nomad-pack run paradedb --registry=nomploy

Configure

Variable	Default	Description
`port`	`5432`	PostgreSQL port (`PGPORT`).
`db_name`	`paradedb`	Initial database (`POSTGRES_DB`).
`db_user`	`postgres`	Superuser name (`POSTGRES_USER`).
`db_password`	`change-me-…`	Change this. Superuser password (`POSTGRES_PASSWORD`).
`image`	`paradedb/paradedb:latest`	Container image. Pin a tag in production.
`data_volume`	`paradedb_data`	`/var/lib/postgresql/data`.
`resources`	`{ cpu = 500, memory = 512 }`	Task resources.

Connect with any Postgres client: postgres://postgres:<password>@<host>:5432/paradedb. Enable search with CREATE EXTENSION pg_search;. Because the database lives on the volume, pin the job to the node holding it with constraints and back it up.