How to Deploy Grafana on Kubernetes

This guide walks you through the deployment of Grafana, a powerful monitoring and visualization tool, on a Kubernetes cluster. It includes setting up a custom configuration and persistent storage to ensure data retention across restarts.

Prerequisites

1. Kubernetes Cluster: A running Kubernetes cluster with kubectl configured.
2. Storage: Ensure a PersistentVolume (PV) or provisioner is available in your cluster for persistent storage.

Namespace: Create a monitoring namespace for Grafana:

kubectl create namespace monitoring

Step 1: Configure Grafana

Create a ConfigMap to store Grafana’s configuration. The configuration below enables anonymous access, embedding of dashboards, and sets default admin credentials.

ConfigMap

apiVersion: v1
kind: ConfigMap
metadata:
  name: grafana-config
  namespace: monitoring
data:
  grafana.ini: |
    [server]
    root_url = http://IP:3000
    domain = IP

    [security]
    allow_embedding = true
    admin_user = admin
    admin_password = admin	    

    [auth.anonymous]
    enabled = true
    org_name = Main Org.
    org_role = Viewer

Apply the ConfigMap:

kubectl apply -f grafana-config.yaml

Step 2: Deploy Grafana

Create a Deployment for Grafana. This deployment uses the latest Grafana image and mounts both a ConfigMap for custom configurations and a PersistentVolumeClaim (PVC) for storage.

Deployment

apiVersion: apps/v1
kind: Deployment
metadata:
  name: grafana
  namespace: monitoring
spec:
  replicas: 1
  selector:
    matchLabels:
      app: grafana
  template:
    metadata:
      labels:
        app: grafana
    spec:
      containers:
      - name: grafana
        image: grafana/grafana:latest
        ports:
        - containerPort: 3000
        volumeMounts:
        - name: grafana-storage
          mountPath: /var/lib/grafana
        - name: grafana-config
          mountPath: /etc/grafana/grafana.ini
          subPath: grafana.ini
      volumes:
      - name: grafana-storage
        persistentVolumeClaim:
          claimName: grafana-storage
      - name: grafana-config
        configMap:
          name: grafana-config

Apply the Deployment:

kubectl apply -f grafana-deployment.yaml

Step 3: Configure Persistent Storage

Create a PersistentVolumeClaim (PVC) to provide persistent storage for Grafana. This ensures that dashboards, users, and other settings persist across pod restarts.

PersistentVolumeClaim

apiVersion: v1
kind: PersistentVolumeClaim
metadata:
  name: grafana-storage
  namespace: monitoring
spec:
  accessModes:
    - ReadWriteOnce
  resources:
    requests:
      storage: 5Gi

Apply the PVC:

kubectl apply -f grafana-pvc.yaml

Step 4: Expose Grafana

Create a Service to expose Grafana outside the cluster. Using a LoadBalancer service type ensures external access to the Grafana interface.

Service

apiVersion: v1
kind: Service
metadata:
  name: grafana
  namespace: monitoring
spec:
  type: LoadBalancer
  ports:
  - port: 3000
    targetPort: 3000
    protocol: TCP
  selector:
    app: grafana

Apply the Service:

kubectl apply -f grafana-service.yaml

Step 5: Access Grafana

1. Open your browser and navigate to http://<EXTERNAL-IP>:3000.
2. Log in with the default credentials (admin/admin) or those defined in the ConfigMap.

After deploying the Service, check the external IP:

kubectl get svc -n monitoring

Note the EXTERNAL-IP under the grafana service.

以上資訊來自ChatGPT的整理