Meilisearch Kubernetes

Meilisearch | Documentation | Discord | Website | Blog | FAQ

The Meilisearch tool for Kubernetes ⚓️

Meilisearch is an open-source search engine. Discover what Meilisearch is!

Table of Contents

• 📖 Documentation
• 🚀 Getting Started
• 🤖 Compatibility with Meilisearch
• ⚙️ Development Workflow and Contributing

📖 Documentation

See our Documentation or our API References.

🚀 Getting Started

Kubernetes (K8s), is an open-source system for automating deployment, scaling, and management of containerized applications. You can run a Meilisearch instance inside your Kubernetes cluster, either if you want to expose it to the outside world or just let some other applications use it inside your cluster and take advantage of the instant and powerful search engine.

First of all, you will need a Kubernetes cluster up and running. If you are not familiar with how Kuberentes works or need some help with this step, please check the Kubernetes documentation.

Install kubectl

kubectl is the most commonly used CLI to manage a Kubernetes cluster. The installation instructions are available here.

Deploy Meilisearch using manifests

Install and run Meilisearch

kubectl apply -f manifests/meilisearch.yaml

Uninstall Meilisearch

kubectl delete -f manifests/meilisearch.yaml

Deploy Meilisearch using Helm

Helm works as a package manager to run pre-configured Kubernetes resources. Using our Helm chart you will be able to deploy a Meilisearch instance in you Kubernetes cluster, with several customizable configurations.

Install helm

Helm CLI is a Command Line Interface which will automate chart management and installation on your Kubernetes cluster. To install Helm, follow the Helm installation instructions.

The Parameters section lists the parameters that can be configured during installation.

Install Meilisearch chart

First, add the Meilisearch chart repository

helm repo add meilisearch https://meilisearch.github.io/meilisearch-kubernetes

Now install/upgrade the chart

# Replace <your-instance-name> with the name you would like to give to your service
helm upgrade -i <your-service-name> meilisearch/meilisearch

Uninstalling the Chart

To uninstall/delete the Meilisearch deployment:

# Replace <your-instance-name> with the name of your deployed service
helm uninstall <your-service-name>

🤖 Compatibility with Meilisearch

This chart guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome in this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

---

Meilisearch provides and maintains many SDKs and Integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.