Skip to content

Commit

Permalink
capital P
Browse files Browse the repository at this point in the history
  • Loading branch information
heiko-braun committed Jun 24, 2024
1 parent cda2757 commit 23a43f8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 68 deletions.
71 changes: 4 additions & 67 deletions platform/clusters/advanced/monitoring.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,9 @@ sidebar_label: Monitoring
description: Monitor your cluster with Prometheus and view Grafana dashboards in the Platform UI.
---

vCluster Platform provides direct integration with [Grafana](https://grafana.com/) and you can view any Grafana dashboard directly in vCluster Platform. With the recommended app kube-prometheus-stack, a complete monitoring setup can be enabled in your cluster with a single click.
Grafana itself is the most popular technology used to compose observability dashboards with everything from Prometheus and Graphite metrics, to logs and application data to power plants and beehives.
vCluster Platform provides direct integration with Prometheus. With the recommended app kube-prometheus-stack, a complete monitoring setup can be enabled in your cluster with a single click.
To leverage the prometheus integration, you'd have to install the kube-prometheus-stack application from within the platform.

vCluster Platform provides additional custom Grafana dashboards for easier cost, account, and resource tracking.

<figure class="frame">
<img
src="/docs/media/v1/ui/clusters/monitoring-loft-dashboards-view.png"
alt="dashboards"
/>
<figcaption>vCluster Platform Grafana dashboard</figcaption>
</figure>

## 1. Install kube-prometheus-stack

Expand All @@ -29,65 +20,11 @@ Navigate to `Clusters -> CLUSTER -> Overview` and click on the recommended app `
<figcaption>kube prometheus stack</figcaption>
</figure>

In the app values, make sure the values for `grafana.grafana.ini.server.root_url` and `grafana.grafana.ini.server.domain` are correct. You can also add any values the chart [kube-prometheus-stack](https://github.com/prometheus-community/helm-charts/tree/main/charts/kube-prometheus-stack) supports:

```yaml
# Required values by vCluster Platform
grafana:
grafana.ini:
auth.proxy:
auto_sign_up: true
enabled: true
header_name: X-WEBAUTH-USER
header_property: username
security:
allow_embedding: true
server:
# CHANGE THIS
domain: ${DOMAIN_WHERE_LOFT_IS_REACHABLE}
# CHANGE THIS
root_url: https://${DOMAIN_WHERE_LOFT_IS_REACHABLE}/grafana/${LOFT_CLUSTER_NAME}/
serve_from_sub_path: true
users:
allow_sign_up: false
auto_assign_org: true
auto_assign_org_role: Admin
```

If you already have a Prometheus installation, you can also just install the [Grafana chart](https://github.com/grafana/helm-charts/tree/main/charts/grafana) with the above values without the initial grafana prefix.
```

After pressing _Install_, please be patient until the kube-prometheus-stack is installed.

## 2. Install vCluster Platform Grafana dashboards (optional)
To install the additional vCluster Platform Grafana dashboards, navigate to `Clusters -> CLUSTER -> Overview` and click on the recommended app `loft-grafana-dashboards`.

<figure class="frame">
<img
src="/docs/media/v1/ui/clusters/monitoring-loft-dashboards.png"
alt="loft dashboards"
/>
<figcaption>vCluster Platform Grafana dashboards</figcaption>
</figure>

:::warning Same Namespace
The vCluster Platform dashboards can only be discovered by Grafana if you install them into the same namespace as you installed the `kube-prometheus-stack`.
:::

## 3. Viewing Grafana dashboards in vCluster Platform

After installing the kube-prometheus-stack with Grafana, you can select the discovered Grafana dashboards in the view `Clusters -> CLUSTER -> Monitoring`. There should be several dashboards you can select from. After selecting a dashboard, the dashboard is shown below.

<figure class="frame">
<img
src="/docs/media/v1/ui/clusters/monitoring-dashboards.png"
alt="dashboards"
/>
<figcaption>Selecting a Grafana dashboard</figcaption>
</figure>

:::info Empty Panels
It may be possible that sometimes a panel appears to be empty. This can happen if Grafana does not recognize the iframe height change fast enough. The panel and all other empty panels should be shown after collapsing and expanding the empty panel.
:::

Congratulations, you now have a fully fledged monitoring setup with vCluster Platform, Prometheus, and Grafana!
Congratulations, you now have a fully fledged monitoring setup with vCluster Platform & Prometheus.
2 changes: 1 addition & 1 deletion platform/clusters/cluster-roles.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ Cluster Roles lets you define Kubernetes RBAC Cluster roles that are synced to t

Cluster Roles also support aggregation rules that allow combining multiple cluster roles into one using label selectors.

The vCluster platform comes with some predefined cluster roles out-of-the-box. You can make use of them within your own spaces or clusters. However, if none of them quite fit your needs, then you can create your own Cluster Role by following the below steps.
The vCluster Platform comes with some predefined cluster roles out-of-the-box. You can make use of them within your own spaces or clusters. However, if none of them quite fit your needs, then you can create your own Cluster Role by following the below steps.

### Creating a Cluster Role

Expand Down

0 comments on commit 23a43f8

Please sign in to comment.