Skip to content

doc: add getting-started for helm charts #1096

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 36 additions & 0 deletions docs/helm-charts/getting-started.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
---
title: Getting Started with Helm Charts
hide_title: true
sidebar_level: Getting Started
description: Helm charts are kubernetes package manager and versioned deployment tools that allows Mina nodes to be set up using Kubernetes.
keywords:
- helm charts
- kubernetes
- mina
- nodes
---

:::info

Provides a general overview on using Helm charts for Mina Protocol. For more information about [Helm Charts](https://github.com/MinaFoundation/helm-charts)

# Prerequisites

- Kubernetes cluster (on-premise or cloud platforms such as AWS, Azure or GCP)
- Helm (>= v3.14.3)
- (Optional) helmfile >= v0.162.0 to install charts

## Deploying a local chart

This tutorial will provide an example on how to deploy a local chart.

1. Download the chart files for the `leaderboard` chart from the Mina Foundation Git repository.
2. Extract the files from the downloaded archive to a local directory.
3. Install the chart using the `helm install` command and passing in the path to the chart directory. For example:

```bash
helm install leaderboard ./leaderboard
```

This command installs the `leaderboard` chart using the local files in the `leaderboard directory`. You can adjust the command to fit your environment and specific requirements.

97 changes: 54 additions & 43 deletions examples/zkapps/04-zkapp-browser-ui/ui/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.