Blobscan Helm Charts

A set of Helm charts to run blobscan on Kubernetes.

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 blobscan-helm-charts https://blobscan.github.io/blobscan-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 blobscan-helm-charts

To install the blobscan chart:

helm install blobscan blobscan-helm-charts/blobscan

To uninstall the chart:

helm delete blobscan

List of charts

• blobscan - Blobscan meta-chart (depends on blobscan-api, blobscan-web and blobscan-indexer).
• blobscan-api - Blobscan API.
• blobscan-web - Blobscan Web UI.
• blobscan-indexer - Blobscan blob indexer.

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