Skip to main content
Version: 0.5.2

Kubernetes (Helm)

Helm is a package manager for Kubernetes that allows you to configure, install, and upgrade containerized applications in a Kubernetes cluster in a version-controlled and reproducible way.

Install Quickwit using Helm

Install Quickwit on Kubernetes with the official Quickwit Helm chart. If you encounter any problem with the chart, please, open on issue in our GitHub repository.

Requirements

To deploy Quickwit on Kubernetes, you will need:

  • kubectl, compatible with your cluster (+/- 1 minor release from your cluster) (kubectl version)
  • Helm v3 (helm version)
  • A Kubernetes cluster
  1. Install kubectl and helm

To install kubectl and helm locally, follow the Kubernetes and Helm documentation pages.

  1. Add the Quickwit Helm chart repository to Helm

    helm repo add quickwit https://helm.quickwit.io
  1. Update the repository

    helm repo update quickwit
  2. Create and customize your configuration file values.yaml

You can inspect the default configuration values of the chart using the following command:

helm show values quickwit/quickwit

Here is an example of a minimal configuration:

image:
tag: v0.4.0

config:
default_index_root_uri: s3://<my-bucket>/quickwit-indexes

postgres:
host: localhost
port: 5432
database: quickwit-metastore
username: quickwit
password: <my strong password> # This password will be stored as a Kubernetes Secret

s3:
region: eu-east-1
# We recommend using IAM roles and permissions to access Amazon S3 resources,
# but you can specify a pair of access and secret keys if necessary.
access_key: <my access key>
secret_key: <my secret key>
  1. Deploy Quickwit

    helm install <deployment name> quickwit/quickwit -f values.yaml

Uninstall the deployment

Run the following Helm command to uninstall the deployment

```
helm delete <deployment name>
```