文档 Grafana 文档 可观测性即代码 预配置资源和同步仪表盘 设置文件预配置

设置文件预配置

Grafana 中的文件预配置允许您包含存储在本地文件系统中的资源，包括文件夹和仪表盘 JSON 文件。

本页介绍如何设置本地文件预配置。

本地路径挂载被称为仓库。

使用本地路径还可以让您使用像 fuse 这样的工具，从而可以将 S3 存储桶挂载为本地路径。您还可以使用 restic 等工具自动将仪表盘备份到您偏好的备份存储解决方案。

要使用本地文件设置文件同步，您需要：

1. 在 Grafana 配置文件中启用功能开关和路径（首次设置）。
2. 设置本地路径。
3. 选择要与 Grafana 同步的内容。

新的文件预配置功能

使用**管理** > **预配置**进行本地文件预配置最终将取代 Grafana 用于引用本地文件系统来获取仪表盘文件的传统方法。

限制

• 无法从 Grafana UI 中删除已预配置的仪表盘。必须在本地文件系统中删除该仪表盘，并将这些更改同步到 Grafana。
• 本地文件系统的更改是单向的：您无法从 Grafana 中保存更改。

开始之前

要设置文件预配置，您需要：

• 在您的 Grafana 组织中拥有管理权限。
• 一个用于存储仪表盘的本地目录。
  • 如果您想使用 GitHub 仓库，请参阅设置 Git 同步。
• 更新 custom.ini 文件中的 permitted_provisioning_paths 部分。
• 在您的 Grafana 实例中启用所需的功能开关。

启用所需功能开关并配置允许的路径

要在 Grafana 中激活本地文件预配置，您需要启用 provisioning 和 kubernetesDashboards 功能开关。有关功能开关的更多信息，请参阅配置功能开关。

本地设置必须是相对路径，并且其相对路径必须在 permitted_provisioned_paths 配置选项中配置。该配置选项相对于您的工作目录，即您运行 Grafana 的位置；通常是 /usr/share/grafana 或类似位置。

本地文件路径可以指向配置允许的任何目录。默认路径是 Grafana 安装目录下的 devenv/dev-dashboards 和 conf/provisioning。

该路径必须在所选系统上表现为标准文件目录。所有子目录都会自动包含。

您为 permitted_provisioning_paths 输入的值将成为您在**连接到本地存储**向导中输入本地路径时的基础路径。

1. 打开您的 Grafana 配置文件，可以是 grafana.ini 或 custom.ini。有关基于操作系统的文件位置，请参阅配置文件位置。

2. 找到或添加 [feature_toggles] 部分。添加这些值：

   ini 复制

   [feature_toggles]
   provisioning = true
   kubernetesDashboards = true ; use k8s from browser
   
   # If you want easy kubectl setup development mode
   grafanaAPIServerEnsureKubectlAccess = true

3. 找到或添加 [paths] 部分。要添加多个位置，请使用竖线字符 (|) 分隔路径。列表中不应包含空路径或末尾竖线。添加这些值：

   ini 复制

   [paths]
   ; This is devenv/dev-dashboards and conf/provisioning by default.
   permitted_provisioning_paths = grafana/ | /etc/grafana/provisioning/

4. 保存文件更改并启动 Grafana。

设置基于文件的预配置

要使用基于文件的预配置，您需要仓库中存储仪表盘的 grafana 文件夹的文件路径。

要开始设置基于文件的预配置：

1. 使用具有 Grafana 管理员标志的账户登录您的 Grafana 服务器。
2. 在左侧菜单中选择**管理**，然后选择**预配置**。
3. 选择配置文件预配置。

连接到本地存储

本地路径可以指向配置允许的任何目录。有关信息，请参阅启用所需功能开关和路径。

始径始终是您的工作 grafana 目录。必须输入的前缀由 permitted_provisioning_paths 中配置的位置决定。默认路径是 Grafana 安装目录下的 devenv/dev-dashboards 和 conf/provisioning。您在 Grafana UI 中输入的值必须**以**任何配置的值**开头**。例如，conf/provisioning/test 是有效的，但 conf/test 无效。

1. 输入**本地路径**，例如 grafana/。此路径必须以任何配置的 permitted_provisioned_paths 开头。
2. 选择**选择要同步的内容**。

设置过程会验证路径，并在出现问题时提供错误消息。

选择要同步的内容

在本节中，您确定对所选存储执行的操作。

1. 选择在 Grafana 中如何处理资源。

• 如果您想通过外部存储同步和管理整个 Grafana 实例，请选择**将所有资源与外部存储同步**。您只能有一个采用此选择的预配置连接。
• 选择**将外部存储同步到新的 Grafana 文件夹**，将外部资源同步到新文件夹，而不影响实例的其余部分。您最多可以对 10 个文件夹重复此过程。- 为仓库连接输入一个**显示名称**。存储在此连接中的资源将以所选显示名称出现在 Grafana UI 中。

1. 选择**同步**继续。

与外部存储同步

完成此一次性步骤后，所有未来的更新将自动保存到本地文件路径并预配置回实例。

在初始同步期间，您的仪表盘将暂时不可用。不会丢失任何数据或配置。过程所需时间取决于涉及的资源数量。

选择**开始同步**启动过程。

选择附加设置

如果您愿意，可以将同步的任何文件设置为**只读**，以便无法通过 Grafana 修改资源。在 Grafana 外部对本地仓库所做的任何更改都将反映在 Grafana 中。

选择**完成**。

在 Grafana 中验证您的仪表盘

要验证您的仪表盘是否可在指定位置使用，请单击**仪表盘**。仪表盘的名称将列在**名称**列中。