An open API service indexing awesome lists of open source software.

https://github.com/marta-barea/typesense-helm

Helm chart to deploy Typesense
https://github.com/marta-barea/typesense-helm

helm-charts kubernetes typesense

Last synced: 4 months ago
JSON representation

Helm chart to deploy Typesense

Awesome Lists containing this project

README

        

# Typesense Helm Chart

## 📌 Overview

This Helm chart deploys [Typesense](https://typesense.org/), an open-source, fast, and typo-tolerant search engine, onto a Kubernetes cluster. The source code is based on [Spittal/typesense-helm](https://github.com/Spittal/typesense-helm).

- 🌐 [Official Website](https://typesense.org/)
- 💡 [GitHub Repository](https://github.com/typesense/typesense)

---

## 🛠 Prerequisites

- Helm v3.x
- Kubernetes v1.16+
- Persistent Volume (PV) provisioner support in the underlying infrastructure

---

## 🚀 Installation

To add the Typesense repository and install the chart with the release name `my-release`, run:

```bash
$ helm repo add typesense https://marta-barea.github.io/typesense-helm/
$ helm install my-release typesense/typesense -n [namespace]
```

---

## ⚙️ Configuration

### 🐳 Docker Image

- **Repository**: `docker.io/typesense/typesense`
- **Tag**: `0.25.0`
- **Pull Policy**: `IfNotPresent`

### 🎛 Resources

- **CPU and Memory**: No limits or requests specified by default.

### 💽 Persistence

- **Enabled**: Yes
- **Path**: `/data`
- **Access Mode**: `ReadWriteOnce`
- **Size**: `25Gi`

### 💼 Pod Disruption Budget

- **Min Available**: Set by default to `1`
- **Enabled**: Set by default to `true`
---

## 🗄 StatefulSet Configuration

- **Replicas**: 3
- **Application Port**: 8108

#### 🩺 Health Checks

- **Liveness Probe**: Starts after 60 seconds, times out after 5 seconds.
- **Readiness Probe**: Starts after 10 seconds, times out after 3 seconds.

---

## 📡 Service Configuration

- **Service Type**: Configurable (`ClusterIP` by default)
- **Service Port**: Configurable (80 by default)