Obol Helm Charts

This repo contains Helm Charts for deploying Obol Distributed Validator middleware clients on Kubernetes using Helm.

List of charts

• charon
• charon-cluster
• charon-relay

Before you begin

Prerequisites

• Kubernetes 1.18+
• Helm 3

Setup a Kubernetes Cluster

For setting up Kubernetes on cloud platforms or bare-metal servers refer to the Kubernetes getting started guide.

Install Helm

Helm is a tool for managing Kubernetes charts. Charts are packages of pre-configured Kubernetes resources.

To install Helm, refer to the Helm install guide and ensure that the helm binary is in the PATH of your shell.

Using Helm

Once you have installed the Helm client, you can deploy a charts located in this repository into a Kubernetes cluster.

Please refer to the Quick Start guide if you wish to get running in just a few commands, otherwise the Using Helm Guide provides detailed instructions on how to use the Helm client to manage packages on your Kubernetes cluster.

Useful Helm Client Commands:

• Install a chart: helm install <release-name> obol/<chart-name>
• Upgrade your application: helm upgrade
• Uninstall a chart: helm uninstall <release-name>

Development

Prerequisites

• pre-commit - Used to setup pre-commit git hooks
• docker - Used by many Makefile targets

Pre-commit hooks

This repository used pre-commit to manage and run certain git hooks. Hook definitions can be found within the .pre-commit-config.yaml file.

Run the following to add the hooks to your local repository:

make init

Useful commands

The README for every chart is auto generated using helm-docs. This is defined as a pre-commit hook. If you want to run it manually, you can run:

make docs

The CT (Chart Testing) tool is used to lint and validate charts. You can run this via:

make lint