このトピックでは、Grafana パッケージのリファレンス情報を示します。

Grafana について

Grafana (https://grafana.com/) は、オープン ソースの可視化および分析ソフトウェアです。Grafana を使用すると、保存納場所に関係なく、メトリックの照会、可視化、アラート、および確認を行うことができます。Grafana は、アプリケーション データからグラフを作成し、可視化するためのツールを提供します。

TKG クラスタに Grafana パッケージをインストールするには、次のトピックを参照してください。

Grafana パッケージのコンポーネント

Grafana パッケージは、表に一覧表示されているコンテナをクラスタにインストールします。Grafana パッケージは、パッケージ リポジトリで指定されているパブリック レジストリからコンテナをプルします。
コンテナ リソースの種類 レプリカ 説明
Grafana デプロイ 2 データの可視化

Grafana のデータ値

grafana-data-values.yaml ファイルの例を以下に示します。このファイルは、次のようにカスタマイズされています。
  • Ingress は有効です (ingress: enabled: true)。
  • Ingress は末尾が / (prefix:) の URL に対して構成されます。
  • Grafana の FQDN は grafana.system.tanzu (virtual_host_fqdn:) です。
  • Grafana の PVC は 2 GB で、デフォルトの vSphere storageClass の下に作成されます。
  • Grafana ユーザー インターフェイスの(Base64 エンコードの)管理者パスワード (grafana: secret: admin_password:)。
namespace: grafana-dashboard
grafana:
  deployment:
    replicas: 1
    updateStrategy: Recreate
  pvc:
    accessMode: ReadWriteOnce
    storage: 2Gi
    storageClassName: default
  secret:
    admin_password: admin
    admin_user: YWRtaW4=
    type: Opaque
  service:
    port: 80
    targetPort: 3000
    type: LoadBalancer
ingress:
  enabled: true
  prefix: /
  servicePort: 80
  virtual_host_fqdn: grafana.system.tanzu

Grafana の構成

Grafana の構成は、 grafana-data-values.yaml で設定されます。次の表に、使用可能なパラメータとその説明を示します。
表 1. Grafana 構成パラメータ
パラメータ 説明 タイプ デフォルト
monitoring.namespace Prometheus がデプロイされる名前空間 文字列 tanzu-system-monitoring
monitoring.create_namespace フラグは、monitoring.namespace で指定された名前空間を作成するかどうかを示します boolean false
monitoring.grafana.cluster_role.apiGroups grafana clusterrole に対して定義された api グループ リスト [""]
monitoring.grafana.cluster_role.resources grafana clusterrole に対して定義されたリソース リスト ["configmaps", "secrets"]
monitoring.grafana.cluster_role.verbs clusterrole に対して定義されたアクセス権限 リスト ["get", "watch", "list"]
monitoring.grafana.config.grafana_ini Grafana 構成ファイルの詳細 構成ファイル grafana.ini

このファイルでは、grafana_net URL を使用して Grafana と統合し、たとえばダッシュボードを Grafana.com から直接インポートします。

monitoring.grafana.config.datasource.type Grafana データソース タイプ 文字列 prometheus
monitoring.grafana.config.datasource.access アクセス モード。proxy または direct(ユーザー インターフェイスのサーバまたはブラウザ) 文字列 proxy
monitoring.grafana.config.datasource.isDefault デフォルトの Grafana データソースとしてマーク boolean true
monitoring.grafana.config.provider_yaml grafana ダッシュボード プロバイダを定義する構成ファイル yaml ファイル provider.yaml
monitoring.grafana.service.type Grafana を公開するサービスのタイプ。サポートされている値:ClusterIP、NodePort、LoadBalancer 文字列 vSphere: NodePort、aws/azure: LoadBalancer
monitoring.grafana.pvc.storage_class パーシステント ボリューム要求に対しアクセス モードを定義します。サポートされている値:ReadWriteOnce、ReadOnlyMany、ReadWriteMany 文字列 ReadWriteOnce
monitoring.grafana.pvc.storage パーシステント ボリューム要求に対しストレージ サイズを定義します 文字列 2Gi
monitoring.grafana.deployment.replicas grafana レプリカの数 整数型 1
monitoring.grafana.image.repository Grafana イメージを含むリポジトリの場所。デフォルトは、パブリック VMware レジストリです。プライベート リポジトリを使用している場合は(エアギャップ環境など)、この値を変更します。 文字列 projects.registry.vmware.com/tkg/grafana
monitoring.grafana.image.name Grafana イメージの名前 文字列 grafana
monitoring.grafana.image.tag Grafana イメージ タグ。バージョンをアップグレードしている場合は、この値の更新が必要になることがあります。 文字列 v7.3.5_vmware.1
monitoring.grafana.image.pullPolicy Grafana イメージ プル ポリシー 文字列 IfNotPresent
monitoring.grafana.secret.type Grafana ダッシュボードに定義されたシークレット タイプ 文字列 不透明
monitoring.grafana.secret.admin_user Grafana ダッシュボードにアクセスするユーザー名 文字列 YWRtaW4=

値は base64 でエンコードされています。デコードには以下を実行します:echo "xxxxxx" | base64 --decode

monitoring.grafana.secret.admin_password Grafana ダッシュボードにアクセスするパスワード 文字列 null
monitoring.grafana.secret.ldap_toml ldap 認証を使用している場合、ldap 構成ファイルのパス 文字列 ""
monitoring.grafana_init_container.image.repository grafana init コンテナ イメージを含むリポジトリ。デフォルトは、パブリック VMware レジストリです。プライベート リポジトリを使用している場合は(エアギャップ環境など)、この値を変更します。 文字列 projects.registry.vmware.com/tkg/grafana
monitoring.grafana_init_container.image.name grafana init コンテナ イメージの名前 文字列 k8s-sidecar
monitoring.grafana_init_container.image.tag grafana init コンテナ イメージ タグ。バージョンをアップグレードしている場合は、この値の更新が必要になることがあります。 文字列 0.1.99
monitoring.grafana_init_container.image.pullPolicy grafana init コンテナ イメージ プル ポリシー 文字列 IfNotPresent
monitoring.grafana_sc_dashboard.image.repository Grafana ダッシュボード イメージを含むリポジトリ。デフォルトは、パブリック VMware レジストリです。プライベート リポジトリを使用している場合は(エアギャップ環境など)、この値を変更します。 文字列 projects.registry.vmware.com/tkg/grafana
monitoring.grafana_sc_dashboard.image.name grafana ダッシュボード イメージの名前 文字列 k8s-sidecar
monitoring.grafana_sc_dashboard.image.tag grafana ダッシュボード イメージ タグ。バージョンをアップグレードしている場合は、この値の更新が必要になることがあります。 文字列 0.1.99
monitoring.grafana_sc_dashboard.image.pullPolicy grafana ダッシュボード イメージ プル ポリシー 文字列 IfNotPresent
monitoring.grafana.ingress.enabled Grafana に対し Ingress を有効または無効にします boolean true
monitoring.grafana.ingress.virtual_host_fqdn grafana にアクセスするホスト名 文字列 grafana.system.tanzu
monitoring.grafana.ingress.prefix grafana のパス プリフィックス 文字列 /
monitoring.grafana.ingress.tlsCertificate.tls.crt 独自の TLS 証明書を使用する場合は、Ingress のオプション証明書。自己署名証明書はデフォルトで生成されます 文字列 Generated cert
monitoring.grafana.ingress.tlsCertificate.tls.key 独自の TLS 証明書を使用する場合は、Ingress のオプション証明書プライベート キー。 文字列 Generated cert key