Postgres for Search and Analytics
Website •
Docs •
<<<<<<< HEAD
Community •
=======
Community •
Blog •
---
[](https://github.com/paradedb/charts/actions/workflows/paradedb-publish-chart.yml)
[](https://artifacthub.io/packages/search?repo=paradedb)
[](https://hub.docker.com/r/paradedb/paradedb)
[](https://github.com/paradedb/paradedb?tab=AGPL-3.0-1-ov-file#readme)
[](https://join.slack.com/t/paradedbcommunity/shared_invite/zt-32abtyjg4-yoYoi~RPh9MSW8tDbl0BQw)
[](https://x.com/paradedb)
# ParadeDB Helm Chart
The [ParadeDB](https://github.com/paradedb/paradedb) Helm Chart is based on the official [CloudNativePG Helm Chart](https://cloudnative-pg.io/). CloudNativePG is a Kubernetes operator that manages the full lifecycle of a highly available PostgreSQL database cluster with a primary/standby architecture using Postgres streaming (physical) replication.
Kubernetes, and specifically the CloudNativePG operator, is the recommended approach for deploying ParadeDB in production, with high availability. ParadeDB also provides a [Docker image](https://hub.docker.com/r/paradedb/paradedb) and [prebuilt binaries](https://github.com/paradedb/paradedb/releases) for Debian, Ubuntu, Red Hat Enterprise Linux, and macOS.
The ParadeDB Helm Chart supports Postgres 13+ and ships with Postgres 17 by default.
The ParadeDB Helm Chart supports Postgres 13+ and ships with Postgres 16 by default.
The chart is also available on [Artifact Hub](https://artifacthub.io/packages/helm/paradedb/paradedb).
## Usage
### ParadeDB Bring-Your-Own-Cloud (BYOC)
The most reliable way to run ParadeDB in production is with ParadeDB BYOC, an end-to-end managed solution that runs in the customer’s cloud account. It deploys on managed Kubernetes services and uses the ParadeDB Helm Chart.
ParadeDB BYOC includes built-in integration with managed PostgreSQL services, such as AWS RDS and GCP CloudSQL, via logical replication. It also provides monitoring, logging and alerting through Prometheus and Grafana. The ParadeDB team manages the underlying infrastructure and lifecycle of the cluster.
You can read more about the optimal architecture for running ParadeDB in production [here](https://docs.paradedb.com/deploy/overview) and you can contact sales [here](mailto:sales@paradedb.com).
### Self-Hosted
First, install [Helm](https://helm.sh/docs/intro/install/). The following steps assume you have a Kubernetes cluster running v1.29+. If you are testing locally, we recommend using [Minikube](https://minikube.sigs.k8s.io/docs/start/).
#### Monitoring
The ParadeDB Helm chart supports monitoring via Prometheus and Grafana. To enable monitoring, you need to have the Prometheus CRDs installed before installing the CloudNativePG operator. The Promotheus CRDs can be found [here](https://prometheus-community.github.io/helm-charts).
#### Installing the CloudNativePG Operator
Skip this step if the CloudNativePG operator is already installed in your cluster. For advanced CloudNativePG configuration and monitoring, please refer to the [CloudNativePG Cluster Chart documentation](https://github.com/cloudnative-pg/charts/blob/main/charts/cloudnative-pg/README.md#values).
```bash
helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --atomic --install cnpg \
--create-namespace \
--namespace cnpg-system \
cnpg/cloudnative-pg
```
Create a `values.yaml` and configure it to your requirements. Here is a basic example:
```yaml
type: paradedb
mode: standalone
cluster:
instances: 3
storage:
size: 256Mi
```
Then, launch the ParadeDB cluster.
```bash
helm repo add paradedb https://paradedb.github.io/charts
helm upgrade --atomic --install paradedb \
--namespace paradedb \
--create-namespace \
--values values.yaml \
paradedb/paradedb
```
If `--values values.yaml` is omitted, the default values will be used. For advanced ParadeDB configuration and monitoring, please refer to the [ParadeDB Chart documentation](https://github.com/paradedb/charts/tree/dev/charts/paradedb#values).
#### Connecting to a ParadeDB CNPG Cluster
You can launch a Bash shell inside a specific pod via:
```bash
kubectl exec --stdin --tty -n paradedb -- bash
```
The primary is called `paradedb-1`. The replicas are called `paradedb-2` onwards depending on the number of replicas you configured. You can connect to the ParadeDB database with `psql` via:
```bash
psql -d paradedb
```
## Development
To test changes to the Chart on a local Minikube cluster, follow the instructions from [Self Hosted](#self-hosted) replacing the `helm upgrade` step by the path to the directory of the modified `Chart.yaml`.
```bash
helm upgrade --atomic --install paradedb --namespace paradedb --create-namespace ./charts/paradedb
```
## License
ParadeDB is licensed under the [GNU Affero General Public License v3.0](/charts/LICENSE) and as commercial software. For commercial licensing, please contact us at [sales@paradedb.com](mailto:sales@paradedb.com).