Ethereum Helm Charts

A set of Helm charts to run multiple components of the Ethereum blockchain on Kubernetes.

Deployment examples that use these helm charts can be found under skylenet/ethereum-k8s-testnets.

Usage

Helm must be installed to use the charts. Please refer to Helm's documentation to get started.

Once Helm has been set up correctly, add the repo as follows:

helm repo add ethereum-helm-charts https://skylenet.github.io/ethereum-helm-charts

If you had already added this repo earlier, run helm repo update to retrieve the latest versions of the packages. You can then run the following command to see the charts.

helm search repo ethereum-helm-charts

To install the ethstats chart:

helm install ethstats ethereum-helm-charts/ethstats

To uninstall the chart:

helm delete ethstats

List of charts

Execution layer clients

• besu
• erigon
• geth
• nethermind

Consensus layer clients

• lighthouse
• lodestar
• nimbus
• prysm
• teku

Tooling

• beaconchain-explorer - Beacon chain block explorer
• blockscout - Execution layer block explorer
• consensus-monitor - Web UI to check your ethereum consensus layer nodes via their beacon APIs
• dshackle - Fault tolerant load balancer for blockchain apis, including Ethereum RPC
• eth2-fork-mon - Fork monitor for a configurable set of beacon nodes
• ethstats - Web UI to track execution layer node status
• fauceth - EIP1559 compatible web faucet using Hcaptcha.
• forkmon - Fork monitor for execution layer nodes
• ganache - Simulator for development and testing purposes of the execution layer
• genesis-generator - A tool to generate and expose genesis files for the execution and consensus layer clients
• rpc-proxy - A proxy for web3 JSONRPC. Rate limiting and method filtering.
• testnet-faucet - Web faucet that can be used to distribute testnet ETH to users
• testnet-homepage - Simple website that can be used to display useful information about your testnet.
• ethereum-metrics-exporter - A prometheus exporter for Ethereum execution and consensus clients.
• checkpointz - A beacon chain Checkpoint Sync provider.
• ethereum-address-metrics-exporter - A prometheus exporter for Ethereum externally owned account and contract addresses.

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

License

MIT License