ToolJet/docs/versioned_docs/version-3.0.0-LTS/setup/helm.md
Pratik Agrawal 5d71e0face
[docs]: AI Release (#11965)
* [docs]: Add Marketplace Plugin Anthropic

* [docs]: Add Marketplace Plugin Gemini

* Update Operations

* Update Operation

* [docs]: Add Marketplace Plugin Hugging Face

* Update Intro Pata

* Update Intro Para

* Add Model Example and Info on Inference API

* Update intro para

* Update Model Example

* Grammatical Improvements

* Grammatical Updates

* Grammar

* Update example

* [docs]: Add Marketplace Plugin Mistral AI

* Update models

* [docs]: Add Marketplace Plugin Qdrant

* Update Models in Beta

* Update Models in V3

* [docs]: Add Marketplace Plugin Cohere

* [docs]: Add Marketplace OpenAI Embedding

* Update model in beta

* Update model LTS

* [docs]:AI Whitelist info in setups

* update: ecs and cloud run

* [docs] added chromadb

* [docs] updated digital-ocean

* [docs] updated k8s

* Made changes in the docs for adding chromadb

* [dos]: ToolJet AI license update

* fix: formatting

* fix: formatting

* [docs]: Add Chat Component

* Update Example and Add Info Box

* [docs]: updated pinecone plugin

* Update SS

* [docs]: ToolJet AI

* Update available model link

* Fix typo

* Add advanced parameters table

* [docs] added AI_GATEWAY_URL

* [fix] indentation

* update: AI credits

* fix: typo

* Chat Component Properties

* update: improved doc

* CSA and Replicate to LTS

* [docs] updated kubernetes and helm for Chromadb

* [docs]: Add Marketplace Plugin Qdrant

* [docs]: Add Marketplace Plugin Qdrant

* Add Markdown

* [docs]: Add Marketplace Plugin Weviate DB

* Update qdrant beta

* Update qdrant LTS

* Update sidebars.js

* Update sidebars.js

* Update marketplace_overview beta

* Update marketplace_overview.md

* Update marketplace_overview.md

* Update Response

* formatting updates

* Parameter Definition Updates

* Update intro qdrant.md Beta

* Update intro qdrant.md LTS

* update local host

* update: added to beta

* fix: fomatting

* fix: formatting

* fix: doc

* fix: review

* update pritesh feedback

* fix: typo

* Mansukha Feedback Updates

* Remove required and optional emoji

* fix: updates

* fix: updates

* fix: review

* minor update in the markdown docs

* fix: plans

* update: added screenshots

* update: added docs to beta

* add minor changes

---------

Co-authored-by: Akshat Virmani <akshatvirmani93@gmail.com>
Co-authored-by: PriteshKiri <pritesh.d.kiri@gmail.com>
Co-authored-by: Souvik <psouvik260@gmail.com>
Co-authored-by: Adish M <adish.madhu@gmail.com>
Co-authored-by: Pritesh Kiri <77957844+PriteshKiri@users.noreply.github.com>
Co-authored-by: Vaishnavi Joshi <vj.codes29@gmail.com>
Co-authored-by: Karan Rathod <karan.altcampus@gmail.com>
2025-02-11 13:02:43 +05:30

92 lines
3.4 KiB
Markdown

---
id: helm
title: Helm
---
# Deploying ToolJet with Helm Chart
This repository contains Helm charts for deploying [ToolJet](https://github.com/ToolJet/helm-charts) on a Kubernetes Cluster using Helm v3. The charts include an integrated PostgreSQL server that is enabled by default. However, you have the option to disable it and configure a different PostgreSQL server by updating the `values.yml` file.
## Installation
### From Helm repo
```bash
helm repo add tooljet https://github.com/ToolJet/helm-charts.git
helm install tooljet tooljet/tooljet
```
### From the Source
1. Clone the repository and navigate to this directory
2. Run `helm dependency update`
3. It is recommended but optional to modify the values in the `values.yaml` file, such as usernames, passwords, persistence settings, etc.
4. Run `helm install -n $NAMESPACE --create-namespace $RELEASE .`
Remember to replace the variables with your specific configuration values.
:::warning
To enable ToolJet AI features in your ToolJet deployment, whitelist `api-gateway.tooljet.ai` and `docs.tooljet.ai`.
:::
## ToolJet Database
ToolJet offers a hosted database solution that allows you to build applications quickly and manage your data effortlessly. The ToolJet database requires no setup and provides a user-friendly interface for data management.
For more information about the ToolJet database, you can visit [here](/docs/tooljet-db/tooljet-database).
You need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
## Upgrading to the Latest LTS Version
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
#### Prerequisites for Upgrading to the Latest LTS Version:
- It is crucial to perform a **comprehensive backup of your database** before starting the upgrade process to prevent data loss.
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
### Additional Step for Upgrading from v3.0.33-ee-lts to the Latest LTS Version
If you are upgrading from version v3.0.33-ee-lts to the latest LTS, please ensure that the following configuration is done:
Setup ChromaDB Deployment.
*Currently, ChromaDB does not have support for Kubernetes.*
1. To use ChromaDB, you need to set up a VM, deploy ChromaDB on it, and then connect to it for usage.
This service helps to deploy chromadb using docker-compose.
```yml
name: ChromaDB
services:
chroma:
name: chromadb
image: chromadb/chroma
ports:
- "8000:8000"
environment:
- CHROMA_HOST_ADDR=0.0.0.0
- CHROMA_HOST_PORT=8000
volumes:
- chromadb_data:/chroma
volumes:
chromadb_data:
driver: local
```
2. Add these environment variable in the ToolJet deployment file:
```
- name: CHROMA_DB_URL
value: <instance_ip:8000>
```
```
- name: AI_GATEWAY_URL
value: https://api-gateway.tooljet.ai
```
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*