Postgres for Search and Analytics

Website • Docs • Community • Blog • Changelog

---

ParadeDB Helm Chart

This repository contains the Helm chart for deploying and managing ParadeDB on Kubernetes.

Prerequisites

• A Kubernetes cluster with at least v1.21
• Helm
• CloudNative Operator installed on the Kubernetes cluster

Usage

The steps below assume you have an accessible Kubernetes cluster.

Install Helm

First, install Helm. You can do so using their installation script:

curl -fsSL -o get_helm.sh https://raw.githubusercontent.com/helm/helm/main/scripts/get-helm-3
chmod 700 get_helm.sh
./get_helm.sh

See the Helm docs for more information.

Install CloudNative Operator

This chart does not include the Custom Resource Definitions (CRDs) from the CloudNative Operator, and it doesn't explicitly depend on it due to Helm's constraints with CRD management. As such, the operator itself is not bundled within this chart.

To use this chart, you need to independently install the operator CRDs. You can install the operator using the official helm chart.

helm repo add cnpg https://cloudnative-pg.github.io/charts
helm upgrade --install cnpg \
  --namespace cnpg-system \
  --create-namespace \
  cnpg/cloudnative-pg

It is also possible to install using the manifest directly. See the operator installation documentation for more information.

Install ParadeDB Helm Chart

Once the operator is installed, add the ParadeDB repo to Helm as follows:

helm repo add paradedb https://paradedb.github.io/helm-charts

If you had already added this repository earlier, run helm repo update to retrieve the latest versions of the packages. You can then run helm search repo paradedb to see the charts.

To install the paradedb chart:

helm install <my-db> paradedb/paradedb

To uninstall the chart:

helm delete <my-db>

You can also download the chart directly from Artifact Hub.

Configuration

The ParadeDB Helm chart can be configured using the values.yaml file or by specifying values on the command line during installation.

Check the values.yaml file for more information.

Development

For local development, it is recommended to use a local Kubernetes cluster like Minikube or kind. Then, install ParadeDB by doing the following:

1. Clone this repository:

git clone https://github.com/paradedb/helm-charts && cd charts

2. Change into the charts directory:

cd helm-charts/charts

3. Build dependencies:

helm dep up

4. Install the chart using Helm:

helm install paradedb paradedb --namespace paradedb --create-namespace

You are now all set to start developing and testing locally!

License

ParadeDB is licensed under the GNU Affero General Public License v3.0.