Skip to content
This repository has been archived by the owner on Sep 1, 2024. It is now read-only.

Latest commit

 

History

History
104 lines (74 loc) · 4.16 KB

README.md

File metadata and controls

104 lines (74 loc) · 4.16 KB
Raw

Weaviate

Test Workflow Release Workflow The SLSA Level 3 badge The Apache 2.0 license badge Follow us on Twitter

Warning This package has been archived. If you need a vector database, you can choose PostgreSQL with the PGVector extension, supported by Kadras, or bring your own database package.

A Carvel package for Weaviate, an AI-native vector database that helps developers create intuitive and reliable AI-powered applications.

🚀  Getting Started

Prerequisites

  • Kubernetes 1.28+

  • Carvel kctrl CLI.

  • Carvel kapp-controller deployed in your Kubernetes cluster. You can install it with Carvel kapp (recommended choice) or kubectl.

    kapp deploy -a kapp-controller -y \
  -f https://github.com/carvel-dev/kapp-controller/releases/latest/download/release.yml

Installation

Add the Kadras package repository to your Kubernetes cluster:

kctrl package repository add -r kadras-packages \
  --url ghcr.io/kadras-io/kadras-packages \
  -n kadras-system --create-namespace
Installation without package repository The recommended way of installing the Weaviate package is via the Kadras package repository. If you prefer not using the repository, you can add the package definition directly using kapp or kubectl. 
kubectl create namespace kadras-system
kapp deploy -a weaviate-package -n kadras-system -y \
  -f https://github.com/kadras-io/package-for-weaviate/releases/latest/download/metadata.yml \
  -f https://github.com/kadras-io/package-for-weaviate/releases/latest/download/package.yml

Install the Weaviate package:

kctrl package install -i weaviate \
  -p weaviate.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-system

Note You can find the ${VERSION} value by retrieving the list of package versions available in the Kadras package repository installed on your cluster.

kctrl package available list -p weaviate.packages.kadras.io -n kadras-system

Verify the installed packages and their status:

kctrl package installed list -n kadras-system

📙  Documentation

Documentation, tutorials and examples for this package are available in the docs folder. For documentation specific to Weaviate, check out weaviate.io.

🎯  Configuration

The Weaviate package can be customized via a values.yml file.

storage:
  size: 32Gi

Reference the values.yml file from the kctrl command when installing or upgrading the package.

kctrl package install -i weaviate \
  -p weaviate.packages.kadras.io \
  -v ${VERSION} \
  -n kadras-system \
  --values-file values.yml

Values

The Weaviate package has the same configurable properties as the upstream Helm chart. Check the documentation for a list of properties.

🛡️  Security

The security process for reporting vulnerabilities is described in SECURITY.md.

🖊️  License

This project is licensed under the Apache License 2.0. See LICENSE for more information.