Skip to content

Latest commit

 

History

History
110 lines (79 loc) · 3.8 KB

README.md

File metadata and controls

110 lines (79 loc) · 3.8 KB
Raw

Helm Charts for RisingWave

Test Charts License Slack X

Charts

Prerequisites

  • Kubernetes cluster (version >= 1.24)
  • Helm (version >= 3.7)

Installation

Add Helm Repository

Add the Helm Repository

helm repo add risingwavelabs https://risingwavelabs.github.io/helm-charts/ --force-update

Update the local Helm chart repository cache

helm repo update

Install RisingWave

Note

The following command installs a standalone RisingWave with local persistency. It will create a PersistentVolumeClaim with StatefulSet and the data will be persisted in the provisioned PersistentVolume. Therefore, it requires the Kubernetes cluster to allow dynamic volume provisioning. Please download and revise the values file if it doesn't suit you well.

helm install risingwave risingwavelabs/risingwave \
  -f https://raw.githubusercontent.com/risingwavelabs/helm-charts/main/examples/dev/dev.values.yaml \
  # --set wait=true         # Uncomment to wait before RisingWave's ready

Tip

The following command will help create a RisingWave similar to above except without persistency guarantee. If the dynamic volume provisioning isn't setup in your Kubernetes cluster, you could take a quick try with RisingWave with this.

helm install risingwave risingwavelabs/risingwave \
  --set metaStore.sqlite.enabled=true \
  --set stateStore.localFs.enabled=true \
  --set standalone.enabled=true \
  # --set wait=true         # Uncomment to wait before RisingWave's ready

Install RisingWave Operator

Prerequisites:

Note

CustomResourceDefinitions are included in the RisingWave Operator Helm chart and will be installed by default.

Create a dedicated namespace for RisingWave Operator.

kubectl create namespace risingwave-operator-system

Install the RisingWave Operator Helm chart.

helm install risingwave-operator risingwavelabs/risingwave-operator \
  --namespace risingwave-operator-system --create-namespace

Documentation

Contributing

Contributions are welcome! Please see our Contributing Guide for more information.

License

This project is licensed under the Apache 2.0 License.