Make sure to set your desired Weaviate version.
This can be done through either explicitly setting it as part of the
values.yaml or through overwriting the default as outlined in the deployment step below.
- A Kuberentes Cluster with a recent version (e.g. >=1.23).
- The cluster needs to be able to provision
PersistentVolumeClaims. No special file systems are required. Any default file system capable of
ReadWriteOnceaccess mode is sufficient.
- Helm (only v3 is compatible from Helm version
Weaviate Helm chart
To obtain and install the Weaviate chart on your Kubernetes cluster, take the following steps:
Verify tool setup and cluster access
# Check if helm is installed
$ helm version
# Make sure `kubectl` is configured correctly and you can access the cluster.
# For example, try listing the pods in the currently configured namespace.
$ kubectl get pods
Obtain the Helm Chart
Add the Weaviate helm repo that contains the Weaviate helm chart
helm repo add weaviate https://weaviate.github.io/weaviate-helm
Get the default
values.yaml configuration file from the Weaviate helm chart:
helm show values weaviate/weaviate > values.yaml
Modify values.yaml (as necessary)
You can skip this step and run with all default values.
But, if you do not modify the defaults in
values.yaml, make sure to set the appropriate Weaviate version at the deployment step.
file you can tweak the configuration to align it with your
setup. The yaml file is extensively documented to help you align the
configuration with your setup.
Out of the box, the configuration file is setup for:
- 1 Weaviate replica. (This cannot be changed at the moment, see below)
text2vec-contextionarymodule is enabled and running with 1 replica. (This can be adjusted based on the expected load).
- Other modules, such as
img2vec-neuralare disabled by default. They can be enabled by setting the respective
See the resource requests and limits in the example
values.yaml. You can
adjust them based on your expected load and the resources available on the
Authentication and authorization
An example configuration for authentication is shown below.
In this example, the key
readonly-key will authenticate a user as the
firstname.lastname@example.org identity, and
secr3tk3y will authenticate a user as
OIDC authentication is also enabled, with WCS as the token issuer/identity provider. Thus, users with WCS accounts could be authenticated. This configuration sets
email@example.com as an admin user, so if
firstname.lastname@example.org were to authenticate, they will be given full (read and write) privileges.
For further, general documentation on authentication and authorization configuration, see:
Deploy (install the Helm chart)
You can deploy the helm charts as follows:
# Create a Weaviate namespace
$ kubectl create namespace weaviate
$ helm install \
--namespace "weaviate" \
The above assumes that you have permissions to create a new namespace. If you
have only namespace-level permissions, you can skip creating a new
namespace and adjust the namespace argument on
helm upgrade according to the
name of your pre-configured namespace.
Updating the installation after the initial deployment
The above command (
helm upgrade...) is idempotent, you can run it again, for
example after adjusting your desired configuration.
Additional Configuration Help
- Cannot list resource "configmaps" in API group when deploying Weaviate k8s setup on GCP
- Error: UPGRADE FAILED: configmaps is forbidden
If you see
No private IP address found, and explicit IP not provided, set the pod subnet to be in an valid ip address range of the following:
If you can't find the answer to your question here, please look at the:
- Frequently Asked Questions. Or,
- Knowledge base of old issues. Or,
- For questions: Stackoverflow. Or,
- For more involved discussion: Weaviate Community Forum. Or,
- We also have a Slack channel.