Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scalar-labs/helm-charts

Helm charts to deploy ScalarDB and ScalarDL
https://github.com/scalar-labs/helm-charts

helm helm-charts kubernetes

Last synced: 3 months ago
JSON representation

Helm charts to deploy ScalarDB and ScalarDL

Awesome Lists containing this project

README

        

# Scalar Helm Charts Repository

[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
[![Release Charts](https://github.com/scalar-labs/helm-charts/actions/workflows/release.yml/badge.svg)](https://github.com/scalar-labs/helm-charts/actions/workflows/release.yml)
[![Chart Testing and Kubeval](https://github.com/scalar-labs/helm-charts/actions/workflows/helm_charts_scalar.yml/badge.svg)](https://github.com/scalar-labs/helm-charts/actions/workflows/helm_charts_scalar.yml)

This directory contains the following helm charts.
* [ScalarDB](./charts/scalardb/)
* [ScalarDL Ledger](./charts/scalardl/)
* [ScalarDL Auditor](./charts/scalardl-audit/)
* [Schema Loading for ScalarDL](./charts/schema-loading/)
* [Envoy](./charts/envoy/)

## Prerequisites

You need the [`helm`](https://helm.sh/docs/intro/install/) command. For details on supported Helm versions, see the [Package manager section in the Requirements document](https://scalardb.scalar-labs.com/docs/latest/requirements/#package-manager).

## Supported Kubernetes versions

For details on supported Kubernetes versions, see the [Kubernetes section in the Requirements document](https://scalardb.scalar-labs.com/docs/latest/requirements/#platform).

We decide which versions to support based on the supported versions in [Amazon Elastic Kubernetes Service](https://docs.aws.amazon.com/eks/latest/userguide/kubernetes-versions.html) and [Azure Kubernetes Service](https://learn.microsoft.com/en-us/azure/aks/supported-kubernetes-versions). However, we do not consider the LTS versions in each managed Kubernetes service.

## Usage

### Helm

[Helm](https://helm.sh) must be installed to use the charts.
Please refer to Helm's [documentation](https://helm.sh/docs/) to get started.

Once Helm is set up properly, add the repo as follows:

```console
helm repo add scalar-labs https://scalar-labs.github.io/helm-charts
```

You can then run `helm search repo scalar-labs` to see the Scalar charts.
Also, you can see all the versions by `helm search repo scalar-labs --versions` command.

### Pre-commit hook

If you want to automatically generate `README.md` files and `values.schema.json` with a pre-commit hook,
then run:

``` bash
cd $(git rev-parse --show-toplevel)
ln -s ../../.git-hooks/pre-commit .git/hooks/pre-commit
```

## Contributing

This repo is mainly maintained by the Scalar Engineering Team, but of course we appreciate any help.

* For asking questions, finding answers and helping other users, please go to [stackoverflow](https://stackoverflow.com/) and use [scalardl](https://stackoverflow.com/questions/tagged/scalardl) tag.
* For filing bugs, suggesting improvements, or requesting new features, help us out by opening an issue.

## License

[Apache 2.0 License](https://github.com/scalar-labs/helm-charts/blob/main/LICENSE).