Page Comparison

...

This page describes

...

how you can set up Grafana on your cluster to help visualize the metrics retrieved by the Prometheus server.

It also contains example dashboards both as zip and yaml-files that you can download with these links:

• grafana-dashboards.

...

• yaml

• grafana-dashboards.

...

• zip

On Private Cloud and AWS

...

The steps for installing the Grafana tool using helm, as well as how to integrate it with

...

your Usage Engine deployment, are described in this section. Before

...

proceeding, see information on how to install Grafana using helm

...

at https://github.com/grafana/helm-charts/tree/main/charts/grafana.

Before

...

you install Grafana, it is recommended that you install the Prometheus server

...

, see Setting up Prometheus(4.1)

...

.

...

...

...

Installing Grafana without Persistence

The following steps show describe how to you install Grafana without the use of persistence. This means , meaning that if your deployment is brought goes down, the data is not retained. We do not recommend deploying Grafana without persistence in a production environment.

1. Add the helm repo for Grafana

...

1. by running the following command:

   Code Block
   helm repo add grafana https://grafana.github.io/helm-charts

2. To view data in Grafana you need to create one or more "dashboards". You can create them manually in the Grafana GUI or use a yaml file to create them in advance. This yaml file, grafana-dashboards.yaml, includes three pre-created dashboards for pico statistics, workflows, and MIMs. You can also

...

1. use your own yaml file with your own dashboard and data source configuration for this installation. You

...

1. must link the Prometheus server as your data source.

2. Install Grafana using the helm install command. This example shows how to install Grafana in its own namespace called Grafana. Enter the Grafana node port number. If you have another dashboard yaml file, you can replace the value by <dashboard yaml name>.

   Code Block
   helm install -n <namespace> grafana grafana/grafana \ --set service.type=NodePort \ --set service.nodePort=<port> \ -f ./<dashboard yaml name>

...

helm install -n grafana grafana grafana/grafana \ 
  --set service.type=NodePort \ 
  --set service.nodePort=30090 \
  -f ./grafana-dashboards.yaml

Installing Grafana with Persistence

The following steps show how to install Grafana with the use of using persistence volumes on your Kubernetes cluster.

1. Create a yaml file and describe the Persistent Volume and Persistent Volume Claim for Grafana. The example

...

1. below creates the persistent volume on an NFS file server that is mounted onto the cluster. The value set in nfs.path is the directory on the NFS file server that stores the data for Grafana.

...

apiVersion: v1
kind: PersistentVolume
metadata:
  name: grafana
spec:
  accessModes:
  - ReadWriteMany
  capacity:
    storage: 10Gi
  nfs:
    path: /export/snap/metrics/grafana
    server: files.dev.drint.net
  persistentVolumeReclaimPolicy: Retain
  storageClassName: grafana-persistent
---
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: grafana-persistent
spec:
  accessModes:
  - ReadWriteMany
  resources:
    requests:
      storage: 10Gi
  storageClassName: grafana-persistent

...

2. When the yaml file has been created, run this command:

   Code Block
   kubectl apply -f <persistent volume yaml> -n <namespace>

3. Add the helm repo for Grafana

...

2. by running this command:

   Code Block
   helm repo add grafana https://grafana.github.io/helm-charts

3. To view data in grafana you need to create one or more "dashboards". You can create them manually in the Grafana GUI or import them from json based definition files. This zip file, grafana-dashboards.zip, includes three pre-created dashboards for pico statistics, workflows, and MIMs. You

...

2. must link the Prometheus server as your data source.

3. Install Grafana using the helm install command. In this example, Grafana is installed in its own namespace called grafana. Enter the Grafana node port number. Set the name of the Persistent Volume Claim

...

2. created in the previous steps.
   If you have another dashboard yaml file, you can replace the value by <dashboard yaml name>.

   Code Block
   helm install -n <namespace> grafana grafana/grafana \ --set service.type=NodePort \ --set service.nodePort=<port> \ --set persistence.enabled=true \ --set persistence.accessMode=ReadWriteMany \ --set persistence.storageClass=grafana-persistent \ --set persistence.existingClaim="grafana-persistent" \ -f ./<dashboard yaml name>

...

...

...

helm install -n grafana grafana grafana/grafana \ 
  --set service.type=NodePort \ 
  --set service.nodePort=30090 \ 
  --set persistence.enabled=true \ 
  --set persistence.accessMode=ReadWriteMany \ 
  --set persistence.storageClass=grafana-persistent \ 
  --set persistence.existingClaim="grafana-persistent" \
  -f ./grafana-dashboards.yaml

Verify the Grafana Installation

This step shows describes how to check that your Grafana is deployed correctly.

$ export NODE_PORT=$(kubectl get --namespace grafana -o jsonpath="{.spec.ports[0].nodePort}" services grafana)
$ export NODE_IP=$(kubectl get nodes --namespace grafana -o jsonpath="{.items[0].status.addresses[0].address}")

http://192.168.52.26:30090

kubectl get secret --namespace <namespace> grafana -o jsonpath="{.data.admin-password}" | base64 --decode ; echo