Add post-installation notes

weaviate/files/weaviate-issues.yaml

@@ -0,0 +1,56 @@
+# Weaviate Known Issues and Version Warnings
+# This file contains known issues, bugs, and important notes for specific Weaviate versions.
+# Maintain this file to help users be aware of potential problems when using certain versions.
+
+# Latest patch versions for each supported minor version
+# Update this section manually when new patch releases are available
+latestVersions:
+  "1.30": "1.30.3"
+  "1.29": "1.29.7"
+  "1.28": "1.28.15"
+  "1.27": "1.27.25"
+  "1.26": "1.26.17"
+
+# Support status for each minor version
+# Options: "current", "maintained", "security" or "eol"
+# All other versions not listed here will show as "End of life"
+supportStatus:
+  "1.30": "current"
+  "1.29": "maintained"
+  "1.28": "maintained"
+  "1.27": "maintained"
+  "1.26": "maintained"
+
+issueWarnings:
+  # Available levels: "critical", "important", "warning"
+  - id: "raft-snapshot-1-27-downgrade"
+    title: "RAFT Snapshots (v1.28.13+, v1.29.5+, v1.30.2+)"
+    message: "CAUTION FOR DOWNGRADES: Multi-node instances of Weaviate running `1.28.13+`, `1.29.5+`, or `1.30.2+` may experience problems if downgraded to a `v1.27.x` version earlier than `1.27.26`. The cluster may not reach a **Ready** state due to a change in the way that RAFT snapshots are stored in the database. A fix for this issue will be released with `1.27.26`, which safely handles the downgrade path to `1.27`. If you need to downgrade Weaviate to `v1.27.x`, use `1.27.26` or higher."
+    affectedVersions:
+      exact: []
+      range: ["> 1.28.13", "> 1.29.5", "> 1.30.2"]
+    level: "important"
+
+  - id: "blockmax-wand-migration"
+    title: "BlockMax WAND migration available"
+    message: "This version sets BlockMax WAND as the default type of inverted index. If you are upgrading from an earlier version, you can migrate the inverted index for improved keyword & hybrid search. See our documentation for the official migration guide (https://weaviate.io/developers/weaviate/more-resources/migration/weaviate-1-30)."
+    affectedVersions:
+      exact: ["1.30.0"]
+      range: []
+    level: "important"
+
+  - id: "backups-getting-stuck"
+    title: "Backups may get stuck"
+    message: "In this version, very large backups may get stuck. This was addressed in 1.27.0 by introducing an ability to cancel backups."
+    affectedVersions:
+      exact: []
+      range: ["< 1.27.0"]
+    level: "warning"
+
+  - id: "strongly-suggest-upgrading"
+    title: "Suggest a different version"
+    message: "This version is not supported. Consider upgrading to a newer version."
+    affectedVersions:
+      exact: []
+      range: ["< 1.25.0"]
+    level: "critical"

weaviate/templates/NOTES.txt

@@ -0,0 +1,56 @@
+{{- $issueWarnings := .Files.Get "files/weaviate-issues.yaml" | fromYaml -}}
+
+Thank you for installing {{ .Chart.Name }}.
+
+Your release is named {{ .Release.Name }}.
+
+Installed Weaviate version: {{ .Values.image.tag }}
+Latest available version: {{ .Chart.AppVersion }}
+
+{{- $currentMinorVersion := regexFind "^\\d+\\.\\d+" .Values.image.tag }}
+
+{{- if hasKey $issueWarnings.latestVersions $currentMinorVersion -}}
+{{- $latestPatch := index $issueWarnings.latestVersions $currentMinorVersion -}}
+{{- if ne .Values.image.tag $latestPatch }}
+
+NOTE: A newer patch version ({{ $latestPatch }}) is available for your Weaviate {{ $currentMinorVersion }}.x installation.
+{{- end -}}
+{{- end }}
+
+{{- if hasKey $issueWarnings.supportStatus $currentMinorVersion -}}
+{{- $supportStatus := index $issueWarnings.supportStatus $currentMinorVersion }}
+
+SUPPORT STATUS:{{ if eq $supportStatus "current" }} You are using the current minor version of Weaviate.{{ else if eq $supportStatus "maintained" }} This version of Weaviate is still maintained with regular updates.{{ else if eq $supportStatus "security" }} This version of Weaviate receives security updates only.{{ else if eq $supportStatus "eol" }} This version of Weaviate has reached end-of-life and is no longer supported.{{ end }}
+{{- else }}
+
+SUPPORT STATUS: This version of Weaviate is not listed in our supported versions and is likely end-of-life (EOL). We recommend upgrading to a supported version.
+{{- end }}
+
+{{- range $issueWarnings.issueWarnings -}}
+  {{- /* Check if this version is affected */ -}}
+  {{- $affected := false -}}
+
+  {{- /* Check exact matches */ -}}
+  {{- range .affectedVersions.exact -}}
+    {{- if eq $.Values.image.tag . -}}
+      {{- $affected = true -}}
+    {{- end -}}
+  {{- end -}}
+
+  {{- /* Check range matches */ -}}
+  {{- range .affectedVersions.range -}}
+    {{- if semverCompare . $.Values.image.tag -}}
+      {{- $affected = true -}}
+    {{- end -}}
+  {{- end -}}
+
+  {{- /* Display warning */ -}}
+  {{- if $affected }}
+
+{{ if eq .level "critical" }}CRITICAL:{{ else if eq .level "important" }}IMPORTANT:{{ else }}WARNING:{{ end }} {{ .message }}
+  {{- end -}}
+{{- end }}
+
+To learn more about the release, try:
+  $ helm status {{ .Release.Name }}
+  $ helm get all {{ .Release.Name }}