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. There are 3 ways in which you can deploy ParadeDB on Kubernetes:

• Using the ParadeDB Helm chart directly
• Using the Bitnami Helm chart with the ParadeDB-provided values.yaml
• Using the Bitnami Helm chart with the ParadeDB-provided helmfile.yaml

Prerequisites

• A Kubernetes cluster with at least v1.21
• Helm

The steps below assume you have an accessible Kubernetes cluster.

Installing 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.

Usage

Using the ParadeDB Helm Chart

First, 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 <mydb> paradedb/paradedb

To uninstall the chart:

helm delete <mydb>

You can also download the chart directly from ArtifactHub.

Using the Bitnami Helm Chart with ParadeDB values.yaml

You can install ParadeDB using Helm and the Bitnami Postgres chart directly. The ParadeDB Helm chart can be configured using the values.yaml file or by specifying values on the command line during installation. To do so, run:

helm install paradedb oci://registry-1.docker.io/bitnamicharts/postgresql --namespace paradedb --create-namespace --values values.yaml

You can configure the values inside the values.yaml file. Check the values.yaml file for more information. For a list of possible configurations, see the Bitnami Postgres chart parameters.

Using the Bitnami Helm Chart with ParadeDB helmfile.yaml

You can install ParadeDB using Helmfile. Once Helmfile is installed, you can download the helmfile.yaml file from this repository and run:

helmfile apply

You can configure values inside the helmfile.yaml. For a list of possible configurations, see the Bitnami Postgres hart parameters

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 and as commercial software.

For commercial licensing, please contact us at [email protected].

If you are an open-source project and would like to use ParadeDB under a different license, please contact us at [email protected].