Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions charts/meilisearch/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A Helm chart for the Meilisearch search engine

![Version: 0.2.1](https://img.shields.io/badge/Version-0.2.1-informational?style=flat-square) ![AppVersion: v1.2.0](https://img.shields.io/badge/AppVersion-v1.2.0-informational?style=flat-square)
![Version: 0.20.0](https://img.shields.io/badge/Version-0.20.0-informational?style=flat-square) ![AppVersion: v1.31.0](https://img.shields.io/badge/AppVersion-v1.31.0-informational?style=flat-square)

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

Expand Down Expand Up @@ -63,18 +63,19 @@ You can also use `auth.existingMasterKeySecret` to use an existing secret that h
| envFrom | list | `[]` | Additional environment variables from ConfigMap or secrets |
| environment.MEILI_ENV | string | `"development"` | Sets the environment. Either **production** or **development** |
| environment.MEILI_NO_ANALYTICS | bool | `true` | Deactivates analytics |
| extraDeploys | list | `[]` | Extra objects to deploy with the release |
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
| extraDeploys | list | `[]` | Extra objects to deploy with the release |
| extraDeploy | list | `[]` | Extra objects to deploy with the release |

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Or maybe we should keep extraDeploys everywhere?

| fullnameOverride | string | `""` | String to fully override meilisearch.fullname |
| image.pullPolicy | string | `"IfNotPresent"` | Meilisearch image pull policy |
| image.pullSecret | string | `nil` | Secret to authenticate against the docker registry |
| image.repository | string | `"getmeili/meilisearch"` | Meilisearch image name |
| image.tag | string | `"v1.2.0"` | Meilisearch image tag |
| image.digest | string | `""` | Meilisearch image digest in the way sha256:aa.... Please note this parameter, if set, will override the tag |
| image.tag | string | `"v1.31.0"` | Meilisearch image tag |
| ingress.annotations | object | `{}` | Ingress annotations |
| ingress.className | string | `"nginx"` | Ingress ingressClassName |
| ingress.enabled | bool | `false` | Enable ingress controller resource |
| ingress.hosts | list | `["meilisearch-example.local"]` | List of hostnames |
| ingress.path | string | `"/"` | Path within the host |
| ingress.tls | list | `[]` | TLS specification |
| initContainers | list | `[]` | Additional initContainers for pod |
| livenessProbe.InitialDelaySeconds | int | `0` | |
| livenessProbe.periodSeconds | int | `10` | |
| livenessProbe.timeoutSeconds | int | `10` | |
Expand All @@ -85,7 +86,7 @@ You can also use `auth.existingMasterKeySecret` to use an existing secret that h
| persistence.enabled | bool | `false` | Enable persistence using PVC |
| persistence.existingClaim | string | `""` | Existing PVC |
| persistence.size | string | `"10Gi"` | PVC Storage Request |
| persistence.storageClass | string | `"-"` | PVC Storage Class |
| persistence.storageClass | string | `nil` | PVC Storage Class |
| persistence.volume.mountPath | string | `"/meili_data"` | |
| persistence.volume.name | string | `"data"` | |
| podAnnotations | object | `{}` | |
Expand All @@ -95,10 +96,10 @@ You can also use `auth.existingMasterKeySecret` to use an existing secret that h
| podSecurityContext.runAsGroup | int | `1000` | |
| podSecurityContext.runAsNonRoot | bool | `true` | |
| podSecurityContext.runAsUser | int | `1000` | |
| priorityClassName | string | `""` | Priority class name for pod |
| readinessProbe.InitialDelaySeconds | int | `0` | |
| readinessProbe.periodSeconds | int | `10` | |
| readinessProbe.timeoutSeconds | int | `10` | |
| replicaCount | int | `1` | Number of Meilisearch pods to run |
| resources | object | `{}` | Resources allocation (Requests and Limits) |
| securityContext.allowPrivilegeEscalation | bool | `false` | |
| securityContext.capabilities.drop[0] | string | `"ALL"` | |
Expand All @@ -107,15 +108,17 @@ You can also use `auth.existingMasterKeySecret` to use an existing secret that h
| service.annotations | object | `{}` | Additional annotations for service |
| service.type | string | `"ClusterIP"` | Kubernetes Service type |
| serviceAccount.annotations | object | `{}` | Additional annotations for created service account |
| serviceAccount.automountServiceAccountToken | bool | `false` | |
| serviceAccount.create | bool | `true` | Should this chart create a service account |
| serviceAccount.name | string | `""` | Custom service account name, if not created by this chart |
| serviceMonitor | object | `{"additionalLabels":{},"enabled":false,"interval":"1m","metricRelabelings":[],"relabelings":[],"scrapeTimeout":"10s","targetLabels":[],"telemetryPath":"/metrics"}` | Monitoring with Prometheus Operator |
| serviceMonitor | object | `{"additionalLabels":{},"enabled":false,"interval":"1m","metricRelabelings":[],"namespace":null,"relabelings":[],"scrapeTimeout":"10s","targetLabels":[],"telemetryPath":"/metrics"}` | Monitoring with Prometheus Operator |
| serviceMonitor.additionalLabels | object | `{}` | Set of labels to transfer from the Kubernetes Service onto the target |
| serviceMonitor.enabled | bool | `false` | Enable ServiceMonitor to configure scraping |
| serviceMonitor.interval | string | `"1m"` | Set scraping frequency |
| serviceMonitor.metricRelabelings | list | `[]` | MetricRelabelConfigs to apply to samples before ingestion |
| serviceMonitor.namespace | string | `nil` | Set Namespace |
| serviceMonitor.relabelings | list | `[]` | Set relabel_configs as per https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config |
| serviceMonitor.scrapeTimeout | string | `"10s"` | Set scraping timeout |
| serviceMonitor.scrapeTimeout | string | `"10s"` | Set scraping timeout |
| serviceMonitor.targetLabels | list | `[]` | Set of labels to transfer from the Kubernetes Service onto the target |
| serviceMonitor.telemetryPath | string | `"/metrics"` | Set path to metrics |
| startupProbe.InitialDelaySeconds | int | `1` | |
Expand All @@ -127,4 +130,4 @@ You can also use `auth.existingMasterKeySecret` to use an existing secret that h
| volumes | list | `[]` | Additional volumes for pod |

----------------------------------------------
Autogenerated from chart metadata using [helm-docs v1.11.0](https://github.com/norwoodj/helm-docs/releases/v1.11.0)
Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2)
8 changes: 8 additions & 0 deletions charts/meilisearch/templates/extra-deploy.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{{- range .Values.extraDeploy }}
---
{{- if typeIs "string" . }}
{{ tpl . $ }}
{{- else }}
{{ tpl (. | toYaml) $ }}
{{- end }}
{{- end }}
Comment on lines +1 to +8
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

⚠️ Potential issue | 🔴 Critical

Fix whitespace handling to avoid malformed YAML output.

Two issues with this template:

  1. Naming mismatch: References .Values.extraDeploy but values.yaml defines extraDeploys (covered in values.yaml comment).

  2. Leading whitespace: Lines 4 and 6 have leading spaces that will be included in the rendered output, causing indentation issues in the generated manifests.

🐛 Proposed fix
 {{- range .Values.extraDeploy }}
 ---
-{{- if typeIs "string" . }}
-    {{ tpl . $ }}
-{{- else }}
-    {{ tpl (. | toYaml) $ }}
-{{- end }}
+{{ if typeIs "string" . }}
+{{ tpl . $ }}
+{{- else }}
+{{ tpl (toYaml .) $ }}
+{{- end }}
 {{- end }}

Note: The YAMLlint syntax error is a false positive since this is a Helm template, not a standalone YAML file.

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
{{- range .Values.extraDeploy }}
---
{{- if typeIs "string" . }}
{{ tpl . $ }}
{{- else }}
{{ tpl (. | toYaml) $ }}
{{- end }}
{{- end }}
{{- range .Values.extraDeploy }}
---
{{ if typeIs "string" . }}
{{ tpl . $ }}
{{- else }}
{{ tpl (toYaml .) $ }}
{{- end }}
{{- end }}
🧰 Tools
🪛 YAMLlint (1.37.1)

[error] 1-1: syntax error: expected the node content, but found '-'

(syntax)

🤖 Prompt for AI Agents
In @charts/meilisearch/templates/extra-deploy.yaml around lines 1 - 8, The
template references the wrong value name and injects extra leading spaces into
rendered manifests; change .Values.extraDeploy to .Values.extraDeploys and
remove the leading spaces before the tpl calls so the lines reading tpl . $ and
tpl (. | toYaml) $ are not indented (keep the '---' separator line intact),
ensuring the range over the correct values key and that tpl output is emitted
without unwanted leading whitespace.

2 changes: 2 additions & 0 deletions charts/meilisearch/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -179,3 +179,5 @@ serviceMonitor:
metricRelabelings: []
# -- Set relabel_configs as per https://prometheus.io/docs/prometheus/latest/configuration/configuration/#relabel_config
relabelings: []
# -- Extra objects to deploy with the release
extraDeploy: []
Loading