# Deploy StarRocks Cluster by starrocks Chart

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0) [![Release Charts](https://img.shields.io/badge/Release-helmcharts-green.svg)](https://github.com/StarRocks/starrocks-kubernetes-operator/releases)

[Helm](https://helm.sh/) is a package manager for Kubernetes. A [Helm Chart](https://helm.sh/docs/topics/charts/) is a Helm package and contains all of the resource definitions necessary to run an application on a Kubernetes cluster. This topic describes how to use Helm to automatically deploy a StarRocks cluster on a Kubernetes cluster.

## Before you begin

- [Create a Kubernetes cluster](https://kubernetes.io/).
- [Install Helm](https://helm.sh/docs/intro/quickstart/).
- [Install StarRocks operator](../operator/README.md#install-operator-chart).

## Install starrocks Chart

1. Add the StarRocks Helm repository.

    ```bash
    $ helm repo add starrocks https://starrocks.github.io/starrocks-kubernetes-operator
    $ helm repo update starrocks
    $ helm search repo starrocks
    NAME                                    CHART VERSION    APP VERSION  DESCRIPTION
    starrocks/kube-starrocks      1.8.0            3.1-latest   kube-starrocks includes two subcharts, starrock...
    starrocks/operator            1.8.0            1.8.0        A Helm chart for StarRocks operator
    starrocks/starrocks           1.8.0            3.1-latest   A Helm chart for StarRocks cluster
    ```

2. Install the starrocks Chart.

    ```bash
    helm install starrocks starrocks/starrocks
    ```

    Please see [values.yaml](./values.yaml) for more details.

## Uninstall starrocks Chart

```bash
helm uninstall starrocks
```
