Skip to content

Commit dbbe8d1

Browse files
meili-bors[bot]nlamiraultalallema
authored
Merge #168
168: Use helm-docs for documentation r=alallema a=nlamirault # Pull Request ## Related issue Fixes #<issue_number> ## What does this PR do? - Documentation using [helm-docs](https://github.com/norwoodj/helm-docs) ## PR checklist Please check if your PR fulfills the following requirements: - [ ] Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)? - [x] Have you read the contributing guidelines? - [x] Have you made sure that the title is accurate and descriptive of the changes? Thank you so much for contributing to Meilisearch! Co-authored-by: Nicolas Lamirault <[email protected]> Co-authored-by: Amélie <[email protected]>
2 parents 2a7746d + fc063a5 commit dbbe8d1

File tree

5 files changed

+176
-92
lines changed

5 files changed

+176
-92
lines changed

‎CONTRIBUTING.md‎

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,6 @@ helm uninstall meilisearch-chart-test
6060

6161
### Tests and Linter <!-- omit in toc -->
6262

63-
6463
Each PR should pass the linter to be accepted.
6564

6665
```bash
@@ -83,6 +82,20 @@ Or just by comment the PR:
8382

8483
Additionally, the GitHub CI will run a test to check if there are changes introduced to the charts. If changes were introduced, it will require you to update the Chart version.
8584

85+
### Generate Documentation <!-- omit in toc -->
86+
87+
Documentation for this repository is currently autogenerated using by [helm-docs](https://github.com/norwoodj/helm-docs).
88+
89+
At each PR, you must check that the documentation has been correctly updated.
90+
91+
- Install [helm-docs](https://github.com/norwoodj/helm-docs#installation) on your machine.
92+
93+
- Run and generate documentation:
94+
```bash
95+
helm-docs
96+
```
97+
- Then commit your changes in your PR.
98+
8699
## Git Guidelines
87100

88101
### Git Branches <!-- omit in toc -->

‎charts/meilisearch/Chart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ apiVersion: v1
22
appVersion: "v1.2.0"
33
description: A Helm chart for the Meilisearch search engine
44
name: meilisearch
5-
version: 0.1.54
5+
version: 0.1.55
66
icon: https://res.cloudinary.com/meilisearch/image/upload/v1597822872/Logo/logo_img.svg
77
home: https://github.com/meilisearch/meilisearch-kubernetes/tree/main/charts/meilisearch
88
maintainers:

‎charts/meilisearch/README.md‎

Lines changed: 66 additions & 87 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# Meilisearch
1+
# meilisearch
2+
3+
A Helm chart for the Meilisearch search engine
4+
5+
![Version: 0.1.55](https://img.shields.io/badge/Version-0.1.55-informational?style=flat-square) ![AppVersion: v1.2.0](https://img.shields.io/badge/AppVersion-v1.2.0-informational?style=flat-square)
26

37
Helm works as a package manager to run pre-configured Kubernetes resources.
48

@@ -38,92 +42,67 @@ To uninstall/delete the `Meilisearch` deployment:
3842
helm uninstall <your-service-name>
3943
```
4044

41-
## Parameters
42-
43-
| Parameter | Description | Default |
44-
|----------------------------------|----------------------------------------------------------------|-----------------------------------|
45-
| `nameOverride` | String to partially override meilisearch.fullname | `nil`
46-
| | |
47-
| `fullnameOverride` | String to fully override meilisearch.fullname | `nil`
48-
| | |
49-
| `replicaCount` | Number of Meilisearch pods to run | `1`
50-
| | |
51-
| `environment.MEILI_ENV` | Sets the environment. Either **production** or **development** | `development`
52-
| | |
53-
| `environment.MEILI_NO_ANALYTICS` | Deactivates analytics | `true`
54-
| | |
55-
| `auth.existingMasterKeySecret` | Uses an existing secret that has the MEILI_MASTER_KEY set | `nil`
56-
| | |
57-
| `envFrom` | Additional environment variables from ConfigMap or secrets | `[]`
58-
| | |
59-
| `image.repository` | Meilisearch image name | `getmeili/meilisearch`
60-
| | |
61-
| `image.tag` | Meilisearch image tag | `{TAG_NAME}`
62-
| | |
63-
| `image.pullPolicy` | Meilisearch image pull policy | `IfNotPresent`
64-
| | |
65-
| `image.pullSecret` | Secret to authenticate against the docker registry | '' |
66-
| | |
67-
| `serviceAccount.create` | Should this chart create a service account | `true`
68-
| | |
69-
| `serviceAccount.annotations` | Additional annotations for created service account | `{}`
70-
| | |
71-
| `serviceAccount.name` | Custom service account name, if not created by this chart | ''
72-
| | |
73-
| `ingress.enabled` | Enable ingress controller resource | `false`
74-
| | |
75-
| `ingress.annotations` | Ingress annotations | `{}`
76-
| | |
77-
| `ingress.className` | Ingress ingressClassName | `nginx`
78-
| | |
79-
| `ingress.path` | Path within the host | `/`
80-
| | |
81-
| `ingress.hosts` | List of hostnames | `[meilisearch-example.local]`
82-
| | |
83-
| `ingress.tls` | TLS specification | `[]`
84-
| | |
85-
| `service.port` | Service HTTP port | `7700`
86-
| | |
87-
| `service.type` | Kubernetes Service type | `ClusterIP`
88-
| | |
89-
| `service.externalTrafficPolicy` | Service external traffic policy | `-` (No external traffic policy)
90-
| | |
91-
| `service.loadBalancerIP` | Service load balancer IP | `-` (No load balancer IP)
92-
| | |
93-
| `service.annotations` | Additional annotations for service | `{}`
94-
| | |
95-
| `persistence.enabled` | Enable persistence using PVC | `false`
96-
| | |
97-
| `persistence.existingClaim` | Existing PVC | `false`
98-
| | |
99-
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce`
100-
| | |
101-
| `persistence.storageClass` | PVC Storage Class | `-` (No storage class)
102-
| | |
103-
| `persistence.size` | PVC Storage Request | `10Gi`
104-
| | |
105-
| `persistence.annotations` | Additional annotations for PVC | `{}`
106-
| | |
107-
| `resources` | Resources allocation (Requests and Limits) | `{}`
108-
| | |
109-
| `command` | Pod command | `[]`
110-
| | |
111-
| `volumes` | Additional volumes for pod | `[]`
112-
| | |
113-
| `volumeMounts` | Additional volumes to mount on pod | `[]`
114-
| | |
115-
| `containers` | Additional containers for pod | `[]`
116-
| | |
117-
| `tolerations` | Tolerations for pod assignment | `[]`
118-
| | |
119-
| `nodeSelector` | Node labels for pod assignment | `{}`
120-
| | |
121-
| `affinity` | Affinity for pod assignment | `{}`
122-
| | |
123-
124-
125-
### Environment
45+
## Environment
12646

12747
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)
12848

129-
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`
49+
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.
50+
51+
You can also use `auth.existingMasterKeySecret` to use an existing secret that has the key `MEILI_MASTER_KEY`
52+
53+
## Values
54+
55+
| Key | Type | Default | Description |
56+
|-----|------|---------|-------------|
57+
| affinity | object | `{}` | Affinity for pod assignment |
58+
| auth.existingMasterKeySecret | string | `""` | Use an existing Kubernetes secret for the MEILI_MASTER_KEY |
59+
| command | list | `[]` | Pod command |
60+
| container.containerPort | int | `7700` | |
61+
| containers | list | `[]` | Additional containers for pod |
62+
| customLabels | object | `{}` | Additional labels to add to all resources |
63+
| envFrom | list | `[]` | Additional environment variables from ConfigMap or secrets |
64+
| environment.MEILI_ENV | string | `"development"` | Sets the environment. Either **production** or **development** |
65+
| environment.MEILI_NO_ANALYTICS | bool | `true` | Deactivates analytics |
66+
| fullnameOverride | string | `""` | String to fully override meilisearch.fullname |
67+
| image.pullPolicy | string | `"IfNotPresent"` | Meilisearch image pull policy |
68+
| image.pullSecret | string | `nil` | Secret to authenticate against the docker registry |
69+
| image.repository | string | `"getmeili/meilisearch"` | Meilisearch image name |
70+
| image.tag | string | `"v1.2.0"` | Meilisearch image tag |
71+
| ingress.annotations | object | `{}` | Ingress annotations |
72+
| ingress.className | string | `"nginx"` | Ingress ingressClassName |
73+
| ingress.enabled | bool | `false` | Enable ingress controller resource |
74+
| ingress.hosts | list | `["meilisearch-example.local"]` | List of hostnames |
75+
| ingress.path | string | `"/"` | Path within the host |
76+
| ingress.tls | list | `[]` | TLS specification |
77+
| livenessProbe.InitialDelaySeconds | int | `0` | |
78+
| livenessProbe.periodSeconds | int | `10` | |
79+
| nameOverride | string | `""` | String to partially override meilisearch.fullname |
80+
| nodeSelector | object | `{}` | Node labels for pod assignment |
81+
| persistence.accessMode | string | `"ReadWriteOnce"` | PVC Access Mode |
82+
| persistence.annotations | object | `{}` | Additional annotations for PVC |
83+
| persistence.enabled | bool | `false` | Enable persistence using PVC |
84+
| persistence.existingClaim | string | `""` | Existing PVC |
85+
| persistence.size | string | `"10Gi"` | PVC Storage Request |
86+
| persistence.storageClass | string | `"-"` | PVC Storage Class |
87+
| persistence.volume.mountPath | string | `"/meili_data"` | |
88+
| persistence.volume.name | string | `"data"` | |
89+
| podAnnotations | object | `{}` | |
90+
| readinessProbe.InitialDelaySeconds | int | `0` | |
91+
| readinessProbe.periodSeconds | int | `10` | |
92+
| replicaCount | int | `1` | Number of Meilisearch pods to run |
93+
| resources | object | `{}` | Resources allocation (Requests and Limits) |
94+
| service | object | `{"annotations":{},"port":7700,"type":"ClusterIP"}` | Service HTTP port |
95+
| service.annotations | object | `{}` | Additional annotations for service |
96+
| service.type | string | `"ClusterIP"` | Kubernetes Service type |
97+
| serviceAccount.annotations | object | `{}` | Additional annotations for created service account |
98+
| serviceAccount.create | bool | `true` | Should this chart create a service account |
99+
| serviceAccount.name | string | `""` | Custom service account name, if not created by this chart |
100+
| startupProbe.InitialDelaySeconds | int | `1` | |
101+
| startupProbe.failureThreshold | int | `60` | |
102+
| startupProbe.periodSeconds | int | `1` | |
103+
| tolerations | list | `[]` | Tolerations for pod assignment |
104+
| volumeMounts | list | `[]` | Additional volumes to mount on pod |
105+
| volumes | list | `[]` | Additional volumes for pod |
106+
107+
----------------------------------------------
108+
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)

‎charts/meilisearch/README.md.gotmpl‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
{{ template "chart.header" . }}
2+
{{ template "chart.description" . }}
3+
4+
{{ template "chart.versionBadge" . }}{{ template "chart.typeBadge" . }}{{ template "chart.appVersionBadge" . }}
5+
6+
Helm works as a package manager to run pre-configured Kubernetes resources.
7+
8+
Meilisearch provides a customizable Helm chart, ready to deploy a [Meilisearch](https://github.com/meilisearch/meilisearch) instance on your Kubernetes cluster.
9+
10+
# Getting started
11+
12+
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/).
13+
14+
## Install kubectl
15+
16+
`kubectl` is the most commonly used CLI to handle a Kubernetes cluster. The installation instructions are [available here](https://kubernetes.io/docs/tasks/tools/install-kubectl/).
17+
18+
## Install helm
19+
20+
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/)
21+
22+
### Install Meilisearch chart
23+
24+
Clone this repository and install the chart
25+
26+
```bash
27+
git clone https://github.com/meilisearch/meilisearch-kubernetes.git
28+
cd meilisearch-kubernetes
29+
# Replace <your-instance-name> with the name you would like to give to your service
30+
helm install <your-service-name> charts/meilisearch
31+
```
32+
33+
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.
34+
35+
## Uninstalling the Chart
36+
37+
To uninstall/delete the `Meilisearch` deployment:
38+
39+
```bash
40+
# Replace <your-instance-name> with the name of your deployed service
41+
helm uninstall <your-service-name>
42+
```
43+
44+
## Environment
45+
46+
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)
47+
48+
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.
49+
50+
You can also use `auth.existingMasterKeySecret` to use an existing secret that has the key `MEILI_MASTER_KEY`
51+
52+
{{ template "chart.requirementsSection" . }}
53+
54+
{{ template "chart.valuesSection" . }}
55+
56+
{{ template "helm-docs.versionFooter" . }}

0 commit comments

Comments
 (0)