Skip to content

Relocate Grafana Helm Setup doc onto Getting Started #270

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.

Sign up for GitHub

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

Merged
vishwa-uber merged 1 commit into from
Sep 2, 2025
+6 −23
Merged

Relocate Grafana Helm Setup doc onto Getting Started #270

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 5 additions & 22 deletions docs/03-concepts/12-grafana-helm-setup.md → docs/01-get-started/05-grafana-helm-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,31 +1,22 @@
---
layout: default
title: Grafana Helm Setup
permalink: /docs/concepts/grafana-helm-setup
permalink: /docs/get-started/grafana-helm-setup
---

# Grafana Helm Setup

<details>
<summary><h2>Introduction</h2></summary>

This guide explains how to set up Grafana for monitoring Cadence workflows and services using Helm charts. Helm simplifies the deployment and management of Grafana in Kubernetes environments. Pre-configured dashboards for Cadence are available to visualize metrics effectively.

</details>

<details>
<summary><h2>Prerequisites</h2></summary>
## Prerequisites

Before proceeding, ensure the following:

- Kubernetes cluster is up and running.
- Helm is installed on your system. Refer to the [Helm installation guide](https://helm.sh/docs/intro/install/).
- Access to the Cadence Helm charts repository.

</details>

<details>
<summary><h2>Setup Steps</h2></summary>
## Setup Steps

### Step 1: Add Cadence Helm Repository

Expand Down Expand Up @@ -108,10 +99,7 @@ curl https://raw.githubusercontent.com/cadence-workflow/cadence/refs/heads/maste
3. **Select Prometheus** as data source when prompted
4. Try the same steps for other dashboards

</details>

<details>
<summary><h2>Customization</h2></summary>
## Customization

The Grafana dashboards can be customized by editing the JSON files or modifying panels directly in Grafana. Additionally, Helm values can be overridden during installation to customize Grafana settings.

Expand All @@ -129,13 +117,8 @@ Install Grafana with the custom values:
helm install grafana cadence/grafana -n cadence-monitoring -f values.yaml
```

</details>

<details>
<summary><h2>Additional Information</h2></summary>
## Additional Information

- [Cadence Helm Charts Repository](https://github.com/cadence-workflow/cadence-charts)
- [Grafana Documentation](https://grafana.com/docs/)
- [Helm Documentation](https://helm.sh/docs/)

</details>
2 changes: 1 addition & 1 deletion sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,7 @@ const sidebars: SidebarsConfig = {
{ type: 'doc', id: 'get-started/java-hello-world' },
{ type: 'doc', id: 'get-started/golang-hello-world' },
{ type: 'doc', id: 'get-started/video-tutorials' },
{ type: 'doc', id: 'get-started/grafana-helm-setup' },
],
},
{
Expand Down Expand Up @@ -62,7 +63,6 @@ const sidebars: SidebarsConfig = {
{ type: 'doc', id: 'concepts/search-workflows' },
{ type: 'doc', id: 'concepts/http-api' },
{ type: 'doc', id: 'concepts/data-converter' },
{ type: 'doc', id: 'concepts/grafana-helm-setup' },
{ type: 'doc', id: 'concepts/workflow-queries-formatted-data' },
],
},
Expand Down