From 6ae5ddf1650c1495aee0f50fc6915b5e0b64c0b9 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Fri, 11 Apr 2025 17:02:25 +0100 Subject: [PATCH 1/7] Add NOTES.txt template for Weaviate installation instructions and version warnings --- weaviate/templates/NOTES.txt | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 weaviate/templates/NOTES.txt diff --git a/weaviate/templates/NOTES.txt b/weaviate/templates/NOTES.txt new file mode 100644 index 0000000..2d8fd93 --- /dev/null +++ b/weaviate/templates/NOTES.txt @@ -0,0 +1,33 @@ +Thank you for installing {{ .Chart.Name }}. + +Your release is named {{ .Release.Name }}. + +Installed Weaviate version: {{ .Values.image.tag }} +Latest available version: {{ .Chart.AppVersion }} + +{{- if ne .Values.image.tag .Chart.AppVersion }} + +NOTE: You are not using the latest available version of Weaviate. +{{- end }} + +{{- if eq .Values.image.tag "1.30.0" }} + +IMPORTANT: You are installing Weaviate version 1.30.0, which includes significant changes to the vector indexing mechanism. +Please refer to the migration guide if upgrading from an earlier version. +{{- end }} + +{{- if eq .Values.image.tag "1.29.0" }} + +IMPORTANT: You are installing Weaviate version 1.29.0, which has been deprecated and will reach end-of-life soon. +We recommend upgrading to version 1.30.0 or newer. +{{- end }} + +{{- if semverCompare "< 1.28.0" .Values.image.tag }} + +WARNING: You are installing an outdated version of Weaviate ({{ .Values.image.tag }}). +Please consider upgrading to the latest version for improved features and security updates. +{{- end }} + +To learn more about the release, try: + $ helm status {{ .Release.Name }} + $ helm get all {{ .Release.Name }} From f9aaa6829e778e0b32482249afab4be14cfa6665 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Fri, 11 Apr 2025 18:37:25 +0100 Subject: [PATCH 2/7] Add weaviate-issues.yaml file for known issues and version warnings; update NOTES.txt to include support status and issue warnings --- weaviate/files/weaviate-issues.yaml | 48 +++++++++++++++++++++++++++ weaviate/templates/NOTES.txt | 51 +++++++++++++++++++++-------- 2 files changed, 85 insertions(+), 14 deletions(-) create mode 100644 weaviate/files/weaviate-issues.yaml diff --git a/weaviate/files/weaviate-issues.yaml b/weaviate/files/weaviate-issues.yaml new file mode 100644 index 0000000..31c47a4 --- /dev/null +++ b/weaviate/files/weaviate-issues.yaml @@ -0,0 +1,48 @@ +# 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.0" + "1.29": "1.29.3" + "1.28": "1.28.12" + "1.27": "1.27.17" + "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: "blockmax-wand-migration" + title: "BlockMax WAND migration available" + message: "This version sets BlockMax WAND as the default type of inverted index. If you are migrating from an earlier version, see our migration guide." + affectedVersions: + exact: ["1.30.0"] + range: [] + level: "important" + + - id: "backups-getting-stuck" + title: "Backups may get stuck" + message: "In this version, very large backup 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" diff --git a/weaviate/templates/NOTES.txt b/weaviate/templates/NOTES.txt index 2d8fd93..3af722f 100644 --- a/weaviate/templates/NOTES.txt +++ b/weaviate/templates/NOTES.txt @@ -1,3 +1,5 @@ +{{- $issueWarnings := .Files.Get "files/weaviate-issues.yaml" | fromYaml -}} + Thank you for installing {{ .Chart.Name }}. Your release is named {{ .Release.Name }}. @@ -5,27 +7,48 @@ Your release is named {{ .Release.Name }}. Installed Weaviate version: {{ .Values.image.tag }} Latest available version: {{ .Chart.AppVersion }} -{{- if ne .Values.image.tag .Chart.AppVersion }} - -NOTE: You are not using the latest available version of Weaviate. -{{- end }} +{{- $currentMinorVersion := regexFind "^\\d+\\.\\d+" .Values.image.tag }} -{{- if eq .Values.image.tag "1.30.0" }} +{{- if hasKey $issueWarnings.latestVersions $currentMinorVersion -}} +{{- $latestPatch := index $issueWarnings.latestVersions $currentMinorVersion -}} +{{- if ne .Values.image.tag $latestPatch }} -IMPORTANT: You are installing Weaviate version 1.30.0, which includes significant changes to the vector indexing mechanism. -Please refer to the migration guide if upgrading from an earlier version. +NOTE: A newer patch version ({{ $latestPatch }}) is available for your Weaviate {{ $currentMinorVersion }}.x installation. +{{- end -}} {{- end }} -{{- if eq .Values.image.tag "1.29.0" }} +{{- if hasKey $issueWarnings.supportStatus $currentMinorVersion -}} +{{- $supportStatus := index $issueWarnings.supportStatus $currentMinorVersion }} -IMPORTANT: You are installing Weaviate version 1.29.0, which has been deprecated and will reach end-of-life soon. -We recommend upgrading to version 1.30.0 or newer. -{{- end }} +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 }} -{{- if semverCompare "< 1.28.0" .Values.image.tag }} +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 }} -WARNING: You are installing an outdated version of Weaviate ({{ .Values.image.tag }}). -Please consider upgrading to the latest version for improved features and security updates. +{{- 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: From 33c1060fd24a16c061b4bc192e37ed049bf57c91 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Fri, 11 Apr 2025 19:57:44 +0100 Subject: [PATCH 3/7] Update BlockMax WAND migration message in weaviate-issues.yaml to include details on upgrading and link to the official migration guide. --- weaviate/files/weaviate-issues.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/weaviate/files/weaviate-issues.yaml b/weaviate/files/weaviate-issues.yaml index 31c47a4..ea6c825 100644 --- a/weaviate/files/weaviate-issues.yaml +++ b/weaviate/files/weaviate-issues.yaml @@ -25,7 +25,7 @@ issueWarnings: # Available levels: "critical", "important", "warning" - 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 migrating from an earlier version, see our migration guide." + 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: [] From 07e96717d78bb69622b1ca1def77ef8c6e9528aa Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Fri, 11 Apr 2025 20:12:05 +0100 Subject: [PATCH 4/7] Fix typo in weaviate-issues.yaml regarding backup issue message for clarity. --- weaviate/files/weaviate-issues.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/weaviate/files/weaviate-issues.yaml b/weaviate/files/weaviate-issues.yaml index ea6c825..32e1509 100644 --- a/weaviate/files/weaviate-issues.yaml +++ b/weaviate/files/weaviate-issues.yaml @@ -33,7 +33,7 @@ issueWarnings: - id: "backups-getting-stuck" title: "Backups may get stuck" - message: "In this version, very large backup may get stuck. This was addressed in 1.27.0 by introducing an ability to cancel backups." + 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"] From a6177f919dd705bdb59b4616c1fb9ffacc1f1826 Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Wed, 16 Apr 2025 09:11:37 +0100 Subject: [PATCH 5/7] Update latest patch version for Weaviate 1.30 to 1.30.1 in weaviate-issues.yaml --- weaviate/files/weaviate-issues.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/weaviate/files/weaviate-issues.yaml b/weaviate/files/weaviate-issues.yaml index 32e1509..e7d58da 100644 --- a/weaviate/files/weaviate-issues.yaml +++ b/weaviate/files/weaviate-issues.yaml @@ -5,7 +5,7 @@ # Latest patch versions for each supported minor version # Update this section manually when new patch releases are available latestVersions: - "1.30": "1.30.0" + "1.30": "1.30.1" "1.29": "1.29.3" "1.28": "1.28.12" "1.27": "1.27.17" From f946e9fbcd9a08ce6cfa78b60b8d0cc2ee31332c Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Tue, 13 May 2025 17:34:23 +0100 Subject: [PATCH 6/7] Update latest patch versions in weaviate-issues.yaml and add RAFT snapshot downgrade warning --- weaviate/files/weaviate-issues.yaml | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/weaviate/files/weaviate-issues.yaml b/weaviate/files/weaviate-issues.yaml index e7d58da..cbd9d40 100644 --- a/weaviate/files/weaviate-issues.yaml +++ b/weaviate/files/weaviate-issues.yaml @@ -5,10 +5,10 @@ # Latest patch versions for each supported minor version # Update this section manually when new patch releases are available latestVersions: - "1.30": "1.30.1" - "1.29": "1.29.3" - "1.28": "1.28.12" - "1.27": "1.27.17" + "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 @@ -23,6 +23,14 @@ supportStatus: 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: 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. \nA fix for this issue will be released with `1.27.26`, which safely handles the downgrade path to `1.27`. \nIf 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)." From 9392c1f621b6694fba9caa2221f83cee474c5fef Mon Sep 17 00:00:00 2001 From: JP Hwang Date: Tue, 13 May 2025 17:39:35 +0100 Subject: [PATCH 7/7] Copyedit --- weaviate/files/weaviate-issues.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/weaviate/files/weaviate-issues.yaml b/weaviate/files/weaviate-issues.yaml index cbd9d40..f6863ae 100644 --- a/weaviate/files/weaviate-issues.yaml +++ b/weaviate/files/weaviate-issues.yaml @@ -25,7 +25,7 @@ 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: 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. \nA fix for this issue will be released with `1.27.26`, which safely handles the downgrade path to `1.27`. \nIf you need to downgrade Weaviate to `v1.27.x`, use `1.27.26` or higher." + 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"]