Repository files navigation

The Meilisearch tool for Kubernetes ⚓️

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

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

See ourDocumentation or ourAPI References.

Say goodbye to server deployment and manual updates withMeilisearch Cloud. Get started with a 14-day free trial! No credit card required.

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 theKubernetes documentation.

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

kubectl apply -f manifests/meilisearch.yaml

kubectl delete -f manifests/meilisearch.yaml

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

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

TheParameters section lists the parameters that can be configured during installation.

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 servicehelm upgrade -i<your-service-name> meilisearch/meilisearch

To uninstall/delete the Meilisearch deployment:

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

This chart only guarantees the compatibility with theversion v1.30.0 of Meilisearch.

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 ourcontributing guidelines for detailed instructions!

Meilisearch provides and maintains manySDKs and Integration tools like this one. We want to provide everyone with anamazing 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 theintegration-guides repository.