Skip to content

Add post-installation notes#297

Open
databyjp wants to merge 7 commits into
mainfrom
add-notes
Open

Add post-installation notes#297
databyjp wants to merge 7 commits into
mainfrom
add-notes

Conversation

@databyjp
Copy link
Copy Markdown

@databyjp databyjp commented Apr 11, 2025

Add NOTES.txt and version status tracking

This PR introduces two new files:

  • templates/NOTES.txt - Provides version information and support status on Helm install
  • files/weaviate-issues.yaml - Contains version metadata for tracking support status

The NOTES.txt file displays conditional messages, containing:

  • The installed version
  • Latest available version
  • Any later patch versions
  • Support status information and
  • Relevant warnings for known issues that affect the installed version.

The relevant latest patch version information, support status & warnings are pulled from files/weaviate-issues.yaml. This is designed to be centralised source of truth for easy maintenance.


Example: create this yaml file with a custom config:

# Custom configuration for Weaviate

# Specify a different Weaviate version to trigger notes
image:
  tag: 1.30.0

# Set resources
resources:
  requests:
    cpu: '500m'
    memory: '500Mi'
  limits:
    cpu: '1000m'
    memory: '1Gi'

# Use ClusterIP instead of LoadBalancer for testing
service:
  type: ClusterIP

# Set a smaller storage size for testing
storage:
  size: 10Gi

Then perform dry run installation e.g.:

helm install --dry-run --debug my-weaviate weaviate/ -f my-values.yaml

Example outputs

v1.26.10

Thank you for installing weaviate.

Your release is named my-weaviate.

Installed Weaviate version: 1.26.10
Latest available version: 1.30.0

NOTE: A newer patch version (1.26.17) is available for your Weaviate 1.26.x installation.

SUPPORT STATUS: This version of Weaviate is still maintained with regular updates.

WARNING: In this version, very large backups may get stuck. This was addressed in 1.27.0 by introducing an ability to cancel backups.

To learn more about the release, try:
  $ helm status my-weaviate
  $ helm get all my-weaviate

v1.29.1

Thank you for installing weaviate.

Your release is named my-weaviate.

Installed Weaviate version: 1.29.1
Latest available version: 1.30.0

NOTE: A newer patch version (1.29.3) is available for your Weaviate 1.29.x installation.

SUPPORT STATUS: This version of Weaviate is still maintained with regular updates.

To learn more about the release, try:
  $ helm status my-weaviate
  $ helm get all my-weaviate

v1.30.0

Thank you for installing weaviate.

Your release is named my-weaviate.

Installed Weaviate version: 1.30.0
Latest available version: 1.30.0

SUPPORT STATUS: You are using the current minor version of Weaviate.

IMPORTANT: 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).

To learn more about the release, try:
  $ helm status my-weaviate
  $ helm get all my-weaviate

@databyjp databyjp requested a review from antas-marcin April 11, 2025 19:12
Copy link
Copy Markdown

@orca-security-eu orca-security-eu Bot left a comment

Choose a reason for hiding this comment

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

Orca Security Scan Summary

Status Check Issues by priority
Passed Passed Infrastructure as Code high 0   medium 0   low 0   info 0 View in Orca
Passed Passed SAST high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Secrets high 0   medium 0   low 0   info 0 View in Orca
Passed Passed Vulnerabilities high 0   medium 0   low 0   info 0 View in Orca

"1.26": "maintained"

issueWarnings:
# Available levels: "critical", "important", "warning"
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.

thought: do we wanna add waiting for database to be restored known issue here ?

@weaviate-git-bot
Copy link
Copy Markdown

To avoid any confusion in the future about your contribution to Weaviate, we work with a Contributor License Agreement. If you agree, you can simply add a comment to this PR that you agree with the CLA so that we can merge.

beep boop - the Weaviate bot 👋🤖

PS:
Are you already a member of the Weaviate Forum?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants