diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7d9a87b..562d665 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -22,5 +22,5 @@ If applicable, add screenshots or logs to help explain your problem. **Environment (please complete the following information):** - OS: [e.g. Debian GNU/Linux] -- MeiliSearch version: [e.g. v.0.20.0] +- Meilisearch version: [e.g. v.0.20.0] - meilisearch-kubernetes version: [e.g v0.1.14] diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2e6d6b6..dedd92f 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,6 +1,6 @@ # Contributing -First of all, thank you for contributing to MeiliSearch! The goal of this document is to provide everything you need to know in order to contribute to MeiliSearch and its different integrations. +First of all, thank you for contributing to Meilisearch! The goal of this document is to provide everything you need to know in order to contribute to Meilisearch and its different integrations. - [Assumptions](#assumptions) - [How to Contribute](#how-to-contribute) @@ -11,8 +11,8 @@ First of all, thank you for contributing to MeiliSearch! The goal of this docume ## Assumptions 1. **You're familiar with [GitHub](https://github.com) and the [Pull Request](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/about-pull-requests)(PR) workflow.** -2. **You've read the MeiliSearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** -3. **You know about the [MeiliSearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** +2. **You've read the Meilisearch [documentation](https://docs.meilisearch.com) and the [README](/README.md).** +3. **You know about the [Meilisearch community](https://docs.meilisearch.com/learn/what_is_meilisearch/contact.html). Please use this for help.** ## How to Contribute @@ -46,7 +46,7 @@ You can install and test the Helm chart by running: helm install meilisearch-chart-test -f charts/meilisearch/values.yaml charts/meilisearch ``` -An easy way to access your MeiliSearch instance and test that it is up and running is by using port-forwarding. This can be achieved by running: +An easy way to access your Meilisearch instance and test that it is up and running is by using port-forwarding. This can be achieved by running: ```bash kubectl port-forward --namespace default svc/meilisearch 7700:7700 @@ -119,7 +119,7 @@ Some notes on GitHub PRs: ## Release Process (for internal team only) -MeiliSearch tools follow the [Semantic Versioning Convention](https://semver.org/). +Meilisearch tools follow the [Semantic Versioning Convention](https://semver.org/). ### Automation to Rebase and Merge the PRs diff --git a/LICENSE b/LICENSE index ffafdd0..1f9d55d 100644 --- a/LICENSE +++ b/LICENSE @@ -1,7 +1,6 @@ MIT License -Copyright (c) 2020 sa -Copyright (c) 2020-2021 MeiliSearch +Copyright (c) 2020-2021 Meilisearch Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 224516f..6d82f6f 100644 --- a/README.md +++ b/README.md @@ -1,11 +1,11 @@

- Instant-MeiliSearch + Meilisearch Kubernetes

-

MeiliSearch Kubernetes

+

Meilisearch Kubernetes

- MeiliSearch | + Meilisearch | Documentation | Slack | Website | @@ -18,15 +18,15 @@ Bors enabled

-

The MeiliSearch tool for Kubernetes ⚓️

+

The Meilisearch tool for Kubernetes ⚓️

-**MeiliSearch** is an open-source search engine. [Discover what MeiliSearch is!](https://github.com/meilisearch/MeiliSearch) +**Meilisearch** is an open-source search engine. [Discover what Meilisearch is!](https://github.com/meilisearch/meilisearch) ## Table of Contents - [📖 Documentation](#-documentation) - [🚀 Getting Started](#-getting-started) -- [🤖 Compatibility with MeiliSearch](#-compatibility-with-meilisearch) +- [🤖 Compatibility with Meilisearch](#-compatibility-with-meilisearch) - [⚙️ Development Workflow and Contributing](#️-development-workflow-and-contributing) ## 📖 Documentation @@ -36,7 +36,7 @@ See our [Documentation](https://docs.meilisearch.com/learn/tutorials/getting_sta ## 🚀 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. +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](https://kubernetes.io/docs/home/). @@ -44,23 +44,23 @@ First of all, you will need a Kubernetes cluster up and running. If you are not `kubectl` is the most commonly used CLI to manage a Kubernetes cluster. The installation instructions are [available here](https://kubernetes.io/docs/tasks/tools/install-kubectl/). -### Deploy MeiliSearch using manifests +### Deploy Meilisearch using manifests -#### Install and run MeiliSearch +#### Install and run Meilisearch ```bash kubectl apply -f manifests/meilisearch.yaml ``` -#### Uninstall MeiliSearch +#### Uninstall Meilisearch ```bash kubectl delete -f manifests/meilisearch.yaml ``` -### Deploy MeiliSearch using Helm +### Deploy Meilisearch using Helm -Helm works as a package manager to run pre-configured Kubernetes resources. Using our [Helm chart](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch) you will be able to deploy a MeiliSearch instance in you Kubernetes cluster, with several customizable configurations. +Helm works as a package manager to run pre-configured Kubernetes resources. Using our [Helm chart](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch) you will be able to deploy a Meilisearch instance in you Kubernetes cluster, with several customizable configurations. #### Install helm @@ -68,9 +68,9 @@ Helm CLI is a Command Line Interface which will automate chart management and in The [Parameters](https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch#parameters) section lists the parameters that can be configured during installation. -#### Install MeiliSearch chart +#### Install Meilisearch chart -First, add the meilisearch chart repository +First, add the Meilisearch chart repository ```bash helm repo add meilisearch https://meilisearch.github.io/meilisearch-kubernetes ``` @@ -83,16 +83,16 @@ helm upgrade -i meilisearch/meilisearch #### Uninstalling the Chart -To uninstall/delete the MeiliSearch` deployment: +To uninstall/delete the Meilisearch deployment: ```bash # Replace with the name of your deployed service helm uninstall ``` -## 🤖 Compatibility with MeiliSearch +## 🤖 Compatibility with Meilisearch -This chart only guarantees the compatibility with the [version v0.25.0 of MeiliSearch](https://github.com/meilisearch/MeiliSearch/releases/tag/v0.25.0). +This chart only guarantees the compatibility with the [version v0.25.0 of Meilisearch](https://github.com/meilisearch/meilisearch/releases/tag/v0.25.0). ## ⚙️ Development Workflow and Contributing @@ -102,4 +102,4 @@ If you want to know more about the development workflow or want to contribute, p
-**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](https://github.com/meilisearch/integration-guides) repository. +**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](https://github.com/meilisearch/integration-guides) repository. diff --git a/charts/meilisearch/Chart.yaml b/charts/meilisearch/Chart.yaml index 5209ab8..0d57eb3 100644 --- a/charts/meilisearch/Chart.yaml +++ b/charts/meilisearch/Chart.yaml @@ -2,7 +2,7 @@ apiVersion: v1 appVersion: "v0.25.2" description: A Helm chart for the Meilisearch search engine name: meilisearch -version: 0.1.25 +version: 0.1.26 icon: https://res.cloudinary.com/meilisearch/image/upload/v1597822872/Logo/logo_img.svg home: https://github.com/meilisearch/meilisearch-kubernetes/charts maintainers: diff --git a/charts/meilisearch/README.md b/charts/meilisearch/README.md index f2057f4..caa236d 100644 --- a/charts/meilisearch/README.md +++ b/charts/meilisearch/README.md @@ -2,7 +2,7 @@ Helm works as a package manager to run pre-configured Kubernetes resources. -MeiliSearch provides a customizable Helm chart, ready to deploy a [Meilisearch](https://github.com/meilisearch/MeiliSearch) instance on your Kubernetes cluster. +Meilisearch provides a customizable Helm chart, ready to deploy a [Meilisearch](https://github.com/meilisearch/meilisearch) instance on your Kubernetes cluster. # Getting started @@ -16,7 +16,7 @@ First of all, you will need a Kubernetes cluster up and running. If you are not 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](https://helm.sh/docs/intro/install/) -### Install MeiliSearch chart +### Install Meilisearch chart Clone this repository and install the chart @@ -27,11 +27,11 @@ cd meilisearch-kubernetes helm install charts/meilisearch ``` -This command deploys MeiliSearch on your Kubernetes cluster using the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation. +This command deploys Meilisearch on your Kubernetes cluster using the default configuration. The [Parameters](#parameters) section lists the parameters that can be configured during installation. ## Uninstalling the Chart -To uninstall/delete the `MeiliSearch` deployment: +To uninstall/delete the `Meilisearch` deployment: ```bash # Replace with the name of your deployed service @@ -46,7 +46,7 @@ helm uninstall | | | | `fullnameOverride` | String to fully override meilisearch.fullname | `nil` | | | -| `replicaCount` | Number of MeiliSearch pods to run | `1` +| `replicaCount` | Number of Meilisearch pods to run | `1` | | | | `environment.MEILI_ENV` | Sets the environment. Either **production** or **development** | `development` | | | @@ -54,11 +54,11 @@ helm uninstall | | | | `auth.existingMasterKeySecret` | Uses an existing secret that has the MEILI_MASTER_KEY set | `nil` | | | -| `image.repository` | MeiliSearch image name | `getmeili/meilisearch` +| `image.repository` | Meilisearch image name | `getmeili/meilisearch` | | | -| `image.tag` | MeiliSearch image tag | `{TAG_NAME}` +| `image.tag` | Meilisearch image tag | `{TAG_NAME}` | | | -| `image.pullPolicy` | MeiliSearch image pull policy | `IfNotPresent` +| `image.pullPolicy` | Meilisearch image pull policy | `IfNotPresent` | | | | `image.pullSecret` | Secret to authenticate against the docker registry | '' | | | | @@ -102,6 +102,6 @@ helm uninstall ### Environment -The `environment` block allows to specify all the environment variables declared on [MeiliSearch Configuration](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#passing-arguments-via-the-command-line) +The `environment` block allows to specify all the environment variables declared on [Meilisearch Configuration](https://docs.meilisearch.com/guides/advanced_guides/configuration.html#passing-arguments-via-the-command-line) For production deployment, the `environment.MEILI_MASTER_KEY` is required. If `MEILI_ENV` is set to "production" without setting `environment.MEILI_MASTER_KEY`, then this chart will automatically create a secure `environment.MEILI_MASTER_KEY` as a secret. To get the value of this secret, you can read it with this command: `kubectl get secret meilisearch-master-key --template={{.data.MEILI_MASTER_KEY}} | base64 --decode`. You can also use `auth.existingMasterKeySecret` to use an existing secret that has the key `MEILI_MASTER_KEY`