Helm で Kubernetes に Grafana を導入する

Grafana を Helm で導入し、PVC による永続化、Prometheus とダッシュボードのプロビジョニング、Ingress の TLS 設定まで解説します。

ベストプラクティス
Prometheus メトリクスとダッシュボードの可視化イメージ

Grafana の Pod を入れ替えたら、ダッシュボードが消えた。こんなときも、Prometheus にはメトリクスが残っていることがあります。両者が保存するものは別です。Prometheus は時系列データを保存し、Grafana は画面で作ったダッシュボードやユーザー設定を自身のデータベースに保存します。永続ボリュームは Grafana のデータベースを保持し、プロビジョニングは管理下のファイルからデータソースやダッシュボードを再現するための仕組みです。

この記事では、Helm で Kubernetes に Grafana を導入し、Prometheus につなぎます。画面は開くのにパネルが空のときの確認手順も取り上げます。例は Grafana 13.3.0 を含むコミュニティチャート 14.4.0 を使います。対象は Kubernetes 1.25 以降の 1.x 系です。構成例はローカルの Helm でレンダリングを確認しました。

Grafana をインストールしてローカルから開く

使い捨ての確認環境なら、Grafana コミュニティチャートのデフォルト値で始められます。このインスタンスでダッシュボードを作って残す場合は、最初から次節の永続化設定を使います。

helm repo add grafana-community https://grafana-community.github.io/helm-charts
helm repo update grafana-community

helm upgrade --install grafana grafana-community/grafana \
  --version 14.4.0 --namespace monitoring --create-namespace

生成された初期管理者パスワードを取得し、Grafana Service にポートフォワードします。デフォルトでは Service の 80 番ポートからコンテナの 3000 番ポートにつながります。

kubectl -n monitoring get secret grafana \
  -o jsonpath='{.data.admin-password}' | base64 -d; printf '\n'
kubectl -n monitoring port-forward svc/grafana 3000:80

ブラウザーで http://localhost:3000 を開き、ユーザー名 admin でログインします。Secret に入っているのは初期認証情報です。Grafana 側でパスワードを変更済みなら、現在の値は異なります。

Grafana のデータベースを PVC に置く

デフォルトの SQLite を使う単一レプリカ構成では、データディレクトリに永続ボリュームをマウントします。要求したストレージをクラスタで確保できることを確認してください。この例では Deployment の方式を Recreate にし、旧 Pod の停止後に新 Pod を起動します。更新時には短時間の中断が発生します。

monitoring 名前空間に grafana-bootstrap という Secret を用意し、admin-user と admin-password を設定します。次を values.yaml に保存します。パスワードそのものは values に含めません。

replicas: 1
deploymentStrategy:
  type: Recreate
persistence:
  enabled: true
  size: 10Gi
admin:
  existingSecret: grafana-bootstrap
  userKey: admin-user
  passwordKey: admin-password
datasources:
  datasources.yaml:
    apiVersion: 1
    datasources:
      - name: Prometheus
        uid: prometheus
        type: prometheus
        access: proxy
        url: http://prometheus-server.monitoring.svc:80
        isDefault: true
dashboardProviders:
  dashboardproviders.yaml:
    apiVersion: 1
    providers:
      - name: default
        orgId: 1
        type: file
        options:
          path: /var/lib/grafana/dashboards/default
dashboards:
  default:
    node-exporter:
      gnetId: 1860
      revision: 46
      curlOptions: "-sSLf"

URL は monitoring 名前空間にリリース名 prometheus で導入した独立版の Prometheus チャートの例です。この URL に接続するのは Grafana サーバーです。構成が異なる場合は kubectl -n monitoring get svc で実際の Service とポートを確認してください。

ダッシュボードに表示するデータを確かめる

チャートは Pod の初期化時に Node Exporter Full のリビジョン 46 を取得します。プロバイダーが読むのはチャートの JSON 配置先です。ダウンロード先に到達できないクラスタでは、gnetId のダウンロード設定を外し、確認済みの JSON を ConfigMap でマウントします。

設定を適用し、PVC の状態を確認します。

helm upgrade --install grafana grafana-community/grafana \
  --version 14.4.0 --namespace monitoring --create-namespace \
  -f values.yaml
kubectl -n monitoring get pvc,svc

PVC が Bound になったら、Grafana の Explore で Prometheus を選び、up を実行します。別のターゲットが返ってきても、Node Exporter の収集を確認できたとは限りません。node_uname_info が取れているかを確認し、ダッシュボードでも対応するデータソースを選びます。まだ空のパネルがあれば、先に時間範囲とフィルターを確認します。

Guance にも Kubernetes のメトリクスを送る場合は、DataKit の KubernetesPrometheus コレクター(英語)でアノテーションによる検出を有効にし、収集する Pod または Service にアノテーションを付けます。Prometheus と DataKit はそれぞれの設定で収集対象を選び、Grafana は引き続き Prometheus の Service にクエリを送ります。

Ingress からアクセスできるようにする

次を ingress.yaml に保存し、Helm コマンドの -f values.yaml の後に -f ingress.yaml を追加します。private-web は実際の IngressClass に置き換えます。DNS はコントローラーに向け、ホスト名に対応する TLS Secret を同じ名前空間に用意します。root_url にはブラウザーで開く HTTPS URL を指定します。

ingress:
  enabled: true
  ingressClassName: private-web
  hosts: [grafana.example.com]
  tls:
    - secretName: grafana-tls
      hosts: [grafana.example.com]
grafana.ini:
  server:
    root_url: https://grafana.example.com/

利用者に URL を共有する前に、必要な認証とアクセス制限を設定します。利用者が参照できるデータは、Grafana とデータソースの権限によって変わります。ポートフォワードは手元での確認に使えます。

kube-prometheus-stack に Grafana が含まれている場合

stack の values で grafana.enabled を確認します。有効なら、既存リリースの grafana: を変更します。同梱されるチャートのバージョンは stack が決めるため、そのバージョンの values も確認してください。

grafana:
  enabled: true
  deploymentStrategy:
    type: Recreate
  persistence:
    enabled: true
  admin:
    existingSecret: grafana-bootstrap
    userKey: admin-user
    passwordKey: admin-password

ここでも SQLite を使う単一レプリカ構成です。複数レプリカには共有の PostgreSQL または MySQL が必要です。Grafana Alerting の高可用性は別に設定します。

導入後によくある質問

Pod を置き換えたらダッシュボードが消えたのはなぜですか?

永続化を有効にしていない場合、Grafana のデータディレクトリは Pod の一時ボリュームにあります。そのデータベースにしかないダッシュボードは失われることがあります。プロビジョニング用ファイルが残っていれば、対象のダッシュボードは再作成できます。既存環境を PVC に切り替える前に必要なデータをエクスポートするか、バックアップしてください。既存の内容は新しいボリュームに自動で移りません。

管理者パスワードをリセットできますか?

ログインできるなら Grafana で変更します。復旧時は grafana cli admin reset-admin-password を使い、稼働中のインスタンスと同じ設定とデータディレクトリを参照させます。Kubernetes Secret で更新されるのは初期認証情報で、作成済みユーザーのパスワードは変わりません。

ダッシュボードを Git で管理できますか?

JSON を Git で管理し、ConfigMap を通してプロビジョニングできます。GitOps の仕組みでラベル付き ConfigMap を作り、sidecar.dashboards.enabled で有効にしたサイドカーに監視させる方法もあります。管理元のファイルを更新すると、画面から保存した変更が上書きされる場合があります。Grafana のダッシュボードプロビジョニング

関連記事 · Grafana で Prometheus のメトリクスを可視化する

最適なプランを相談する

お問い合わせ

コミュニティに参加

WeChatでスキャンして
コミュニティに参加

Guanceを試す

オンラインですぐに始めて、使った分だけお支払いください。

利用を開始

Guanceのプランを選択

コードリポジトリ