Skip to content

Commit

Permalink
Refine Presto chart readme
Browse files Browse the repository at this point in the history
  • Loading branch information
dnskr committed Jul 14, 2024
1 parent fed88e5 commit fc42b1c
Showing 1 changed file with 21 additions and 16 deletions.
37 changes: 21 additions & 16 deletions charts/presto/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,59 +2,64 @@
[Presto](https://prestodb.io) is a Fast and Reliable SQL Engine for Data Analytics and the Open Lakehouse.

## Introduction
This chart bootstraps a [Presto](https://github.com/prestodb/presto) on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.
This chart bootstraps a [Presto](https://prestodb.io) on a [Kubernetes](https://kubernetes.io) cluster using the [Helm](https://helm.sh) package manager.

## Prerequisites
- Kubernetes 1.23+
- Kubernetes 1.27+
- Helm 3

## Add Presto charts Helm repo
Use the following command to add Presto charts repository to Helm configuration:
## Presto charts Helm repository
Helm chart repository is a location where packaged charts can be stored and shared.

Use the following command to add Presto charts repository to Helm client configuration:
```shell
$ helm repo add presto https://prestodb.github.io/presto-helm-charts
helm repo add presto https://prestodb.github.io/presto-helm-charts
```

## Installing the Chart
Install the chart with `my-presto` release name:
```shell
$ helm install my-presto presto/presto
helm install my-presto presto/presto
```

## Uninstalling the Chart
Uninstall `my-presto` release:
```shell
$ helm uninstall my-presto
helm uninstall my-presto
```

## Configuration
Refer default `values.yaml` file of the chart for all the possible config properties:
Refer default `values.yaml` file of the chart for all the possible configuration properties:
```shell
$ helm show values presto/presto
helm show values presto/presto
```

## Presto deployment modes
The chart supports three Presto deployment modes: single, cluster and highly available cluster.

### Single
Minimal Presto deployment, where single pod acts as Coordinator and Worker.
This mode can be used for experimentation and testing purposes in environments with limited resources.\
This mode can be used for experimentation and testing purposes in environments with limited resources.

The following command installs Presto in **single** mode:
```shell
$ helm install my-presto presto/presto --set mode=single
helm install my-presto presto/presto --set mode=single
```

### Cluster
Standard Presto deployment with one Coordinator and multiple Workers.
The chart deploys Presto in cluster mode by default.\
The chart deploys Presto in cluster mode by default.

The following command installs Presto in **cluster** mode with 3 workers:
```shell
$ helm install my-presto presto/presto --set mode=cluster --set worker.replicas=3
helm install my-presto presto/presto --set mode=cluster --set worker.replicas=3
```

### Highly Available Cluster
Highly available Presto deployment with multiple Resource Managers, Coordinators and Workers.
This mode allows to avoid single point of failure and mitigate coordinator bottleneck in high load Presto clusters.\
Highly available Presto deployment with Resource Manager and multiple Coordinators and Workers.
This mode allows to avoid single point of failure for coordinator and mitigate coordinator bottleneck in high load Presto clusters.

The following command installs Presto in **ha-cluster** mode with 2 coordinators and 3 workers:
```shell
$ helm install my-presto presto/presto --set mode=ha-cluster --set coordinator.replicas=2 --set worker.replicas=3
helm install my-presto presto/presto --set mode=ha-cluster --set coordinator.replicas=2 --set worker.replicas=3
```

0 comments on commit fc42b1c

Please sign in to comment.