weaviate installation instructions

Author: GrantMelvin

README.md

@@ -16,6 +16,8 @@
       - [Manual Database Setup (Optional)](#manual-database-setup-optional)
   - [Application Deployment Guides](#application-deployment-guide)
     - [Retrieve License](#retrieve-license)
+    - [Install Required Dependencies](#install-required-dependencies)
+    - [Optional Components](#optional-components)
   - [Backup and Restore Guide](#backup-and-restore-guide)
   - [Troubleshooting](#troubleshooting)
     - [Common Issues](#common-issues)
@@ -227,10 +229,18 @@ After you have access to the Kubernetes cluster, you must install the necessary
 > 2. The service mesh (Linkerd) must be installed second, as it depends on the certificates and issuers created during the
 >    first step.
 >
-> 3. Other dependencies can be installed in any order after that. They do not have hard dependencies on each other, but
+> 3. Other dependencies or optional components can be installed in any order after that. They do not have hard dependencies on each other, but
 >    do require the previous two steps to be completed to ensure internal traffic is properly secured.
 > Note: It is critical to provide an `azure-dns-label` for Azure NGINX Controller deployments. This is documented at the top of the example NGINX values file given.
 
+### Optional Components
+
+SAS has partnered with Weaviate and supports it as an alternative to PGVector storage. This installation is not required but is compatible with RAM.
+
+| Component |    Version    | Example Values File |                                   Installation Instructions                                 |
+|-----------|---------------|---------------------|---------------------------------------------------------------------------------------------|
+| **Weaviate**     |v17.3.3 |[weaviate.yaml](./examples/weaviate.yaml)   | [instructions](./docs/user/DependencyInstall.md#weaviate)            |
+
 ### Install SAS Retrieval Agent Manager
 
 After you have configured a Kubernetes cluster and PostgreSQL 15 database, use the following code to deploy SAS Retrieval Agent Manager on your platform:

docs/user/DependencyInstall.md

@@ -1,6 +1,8 @@
 # Dependency Installations
 
-## Certificate and Trust Management
+## Required Dependencies
+
+### Certificate and Trust Management
 
 SAS Retrieval Agent Manager requires TLS certificates for secure communication. You can use cert-manager to automate the
 management and issuance of TLS certificates. The provided chart:
@@ -29,7 +31,7 @@ kubectl apply -f helm/cert-manager/templates/linkerd-certs/ \
 
 ```
 
-## Service Mesh
+### Service Mesh
 
 SAS Retrieval Agent Manager uses Linkerd to enable mutual TLS (mTLS) for secure internal communication between its
 components. The provided chart sets up the necessary configurations to enable mTLS within the application with automated
@@ -55,7 +57,7 @@ helm install linkerd ./helm/linkerd \
 
 ```
 
-## Kueue
+### Kueue
 
 SAS Retrieval Agent Manager requires Kueue for workload management of vectorization jobs.
 
@@ -72,7 +74,7 @@ helm install kueue oci://registry.k8s.io/kueue/charts/kueue \
   --create-namespace
 ```
 
-## Ingress-Nginx
+### Ingress-Nginx
 
 SAS Retrieval Agent Manager requires the NGINX Ingress controller for managing incoming traffic.
 
@@ -93,3 +95,26 @@ helm install nginx-ingress-nginx-controller \
     -f <nginx_values_file> \
     --create-namespace
 ```
+
+## Optional Components
+
+### Weaviate
+
+SAS Retrieval Agent Manager supports Weaviate as an alternative to PGVector storage.
+
+Here is an [Example Weaviate Values File](../../examples/weaviate.yaml). You can edit it as you'd like to fit your deployment.
+
+You can install it onto your cluster with the following commands:
+
+```bash
+# Add the Helm repo that contains Weaviate
+helm repo add weaviate https://weaviate.github.io/weaviate-helm
+helm repo update
+
+# Install Weaviate using your custom values file
+helm install weaviate weaviate/weaviate \
+  --version=v17.3.3 \
+  --namespace weaviate \
+  -f <weaviate_values_file> \
+  --create-namespace
+```

examples/weaviate.yaml

@@ -0,0 +1,49 @@
+---
+# -- Service configuration for Weaviate HTTP endpoint
+# -- Exposes the Weaviate REST API for client connections
+service:
+  # -- Service name for Weaviate HTTP endpoint
+  name: weaviate
+  
+  # -- Service ports configuration for HTTP traffic
+  ports:
+    # -- HTTP port configuration for REST API
+    - name: http
+      protocol: TCP
+      port: 80
+  
+  # -- Service type for internal cluster communication
+  # -- ClusterIP restricts access to within the Kubernetes cluster
+  type: ClusterIP
+
+# -- gRPC service configuration for Weaviate
+# -- Provides gRPC endpoint for high-performance client communication
+grpcService:
+  # -- Enable gRPC service for Weaviate
+  # -- Controls whether the gRPC service is created
+  enabled: true
+  
+  # -- Service name for Weaviate gRPC endpoint
+  name: weaviate-grpc
+  
+  # -- Service ports configuration for gRPC traffic
+  ports:
+    # -- gRPC port configuration for client connections
+    - name: grpc
+      protocol: TCP
+      port: 50051
+  
+  # -- Service type for internal cluster communication
+  # -- ClusterIP restricts access to within the Kubernetes cluster
+  type: ClusterIP
+
+# -- Persistent storage configuration for Weaviate data
+# -- Defines the storage volume for vector database persistence
+storage:
+  # -- Persistent volume size for Weaviate data storage
+  # -- Allocates disk space for vector indices and object data
+  size: 32Gi
+  
+  # -- Storage class name for dynamic volume provisioning
+  # -- Uses cloud provider's managed storage class for reliability
+  storageClassName: managed