本主题提供了 Grafana 软件包的参考信息。

关于 Grafana

Grafana (https://grafana.com/) 是开源可视化和分析软件。通过 Grafana,您可以查询、可视化、警示和浏览指标,而无论指标的存储位置如何。Grafana 提供通过应用程序数据形成图形和可视化的工具。

要在 TKG 集群上安装 Grafana 软件包,请参阅以下主题:
  • 适用于 vSphere 8.x 的 TKr:安装 Grafana
  • 适用于 vSphere 7.x 的 TKr:

Grafana 软件包组件

Grafana 软件包将在集群上安装下表中列出的容器。此 Grafana 软件包将从软件包存储库中指定的公共注册表中提取容器。
容器 资源类型 副本 描述
Grafana 部署 2 数据可视化

Grafana 数据值

下面是一个示例 grafana-data-values.yaml 文件,其中具有以下自定义:
  • 已启用 Ingress (ingress: enabled: true)
  • 针对以 / (prefix:) 结尾的 URL 配置了 Ingress
  • Grafana 的 FQDN 为 grafana.system.tanzu (virtual_host_fqdn:)
  • Grafana 的 pvc 为 2 GB,将在默认的 vSphere storageClass 下创建
  • Grafana UI 的管理员密码(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 的命名空间 string tanzu-system-monitoring
monitoring.create_namespace 标记指示是否创建 monitoring.namespace 指定的命名空间 布尔 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 数据源类型 string prometheus
monitoring.grafana.config.datasource.access 访问模式。代理或直接(UI 中的服务器或浏览器) string 代理
monitoring.grafana.config.datasource.isDefault 标记为默认 Grafana 数据源 布尔 true
monitoring.grafana.config.provider_yaml 用于定义 grafana 仪表板提供程序的配置文件 Yaml 文件 provider.yaml
monitoring.grafana.service.type 用于公开 Grafana 的服务类型。支持的值:ClusterIP、NodePort、LoadBalancer string vSphere: NodePort、aws/azure: LoadBalancer
monitoring.grafana.pvc.storage_class 为持久卷声明定义访问模式。支持的值: ReadWriteOnce、ReadOnlyMany、ReadWriteMany string ReadWriteOnce
monitoring.grafana.pvc.storage 为持久卷声明定义存储大小 string 2Gi
monitoring.grafana.deployment.replicas Grafana 副本数 integer 1
monitoring.grafana.image.repository 包含 Grafana 映像的存储库的位置。默认为公共 VMware 注册表。如果使用的是专用存储库(例如气隙环境),请更改此值。 string projects.registry.vmware.com/tkg/grafana
monitoring.grafana.image.name Grafana 映像的名称 string grafana
monitoring.grafana.image.tag Grafana 映像标记。如果升级版本,可能需要更新此值。 string v7.3.5_vmware.1
monitoring.grafana.image.pullPolicy Grafana 映像提取策略 string IfNotPresent
monitoring.grafana.secret.type 为 Grafana 仪表板定义的密钥类型 string 不透明
monitoring.grafana.secret.admin_user 用于访问 Grafana 仪表板的用户名 string YWRtaW4=

值为 base64 编码;用于解码:echo "xxxxxx" | base64 --decode

monitoring.grafana.secret.admin_password 用于访问 Grafana 仪表板的密码 string
monitoring.grafana.secret.ldap_toml 如果使用 ldap 身份验证,则 ldap 配置文件路径 string ""
monitoring.grafana_init_container.image.repository 包含 grafana init 容器映像的存储库。默认为公共 VMware 注册表。如果使用的是专用存储库(例如气隙环境),请更改此值。 string projects.registry.vmware.com/tkg/grafana
monitoring.grafana_init_container.image.name grafana init 容器映像的名称 string k8s-sidecar
monitoring.grafana_init_container.image.tag Grafana init 容器映像标记。如果升级版本,可能需要更新此值。 string 0.1.99
monitoring.grafana_init_container.image.pullPolicy grafana init 容器映像拉取策略 string IfNotPresent
monitoring.grafana_sc_dashboard.image.repository 包含 Grafana 仪表板映像的存储库。默认为公共 VMware 注册表。如果使用的是专用存储库(例如气隙环境),请更改此值。 string projects.registry.vmware.com/tkg/grafana
monitoring.grafana_sc_dashboard.image.name grafana 仪表板映像的名称 string k8s-sidecar
monitoring.grafana_sc_dashboard.image.tag Grafana 仪表板映像标记。如果升级版本,可能需要更新此值。 string 0.1.99
monitoring.grafana_sc_dashboard.image.pullPolicy grafana 仪表板映像提取策略 string IfNotPresent
monitoring.grafana.ingress.enabled 为 grafana 启用/禁用输入 布尔 true
monitoring.grafana.ingress.virtual_host_fqdn 用于访问 grafana 的主机名 string grafana.system.tanzu
monitoring.grafana.ingress.prefix grafana 的路径前缀 string /
monitoring.grafana.ingress.tlsCertificate.tls.crt 如果要使用自己的 TLS 证书,则为用于输入的可选证书。默认情况下生成自签名证书 string 生成的证书
monitoring.grafana.ingress.tlsCertificate.tls.key 如果要使用自己的 TLS 证书,则为用于输入的可选证书私钥。 string 生成的证书密钥