grafana/build-container

Grafana 构建容器镜像文档

镜像概述和主要用途

该容器镜像专为构建 Grafana 应用程序设计，提供了预配置的构建环境，包含 Grafana 编译所需的依赖工具链、开发环境及构建脚本，旨在简化 Grafana 源码的本地构建、自定义版本编译及 CI/CD 流程集成。

核心功能和特性

• 预配置构建环境：集成 Grafana 构建所需的全套依赖（如 Go 编译器、Node.js、npm、make、Git 等），无需手动安装工具链。
• 版本兼容性：支持主流 Grafana 源码版本，适配不同分支（如 main、v9.x、v10.x 等）的构建需求。
• 多场景适配：可直接用于本地开发或集成至 CI/CD 流水线，支持命令行构建和自动化构建。
• 数据卷灵活挂载：支持挂载本地源码目录、构建产物目录，实现源码实时同步和产物持久化。

使用场景和适用范围

• Grafana 开发者本地构建：简化本地开发环境配置，快速编译源码生成可执行文件。
• 自定义版本编译：基于修改后的 Grafana 源码（如添加插件、调整功能）构建自定义版本。
• CI/CD 流程集成：在 Jenkins、GitHub Actions 等平台中作为构建步骤，自动化生成 Grafana 二进制文件。
• 贡献者开发环境统一：为 Grafana 开源项目贡献者提供一致的构建环境，减少“环境不一致导致构建失败”问题。

使用方法和配置说明

docker run 命令示例

通过 docker run 直接启动容器，挂载本地 Grafana 源码目录并执行构建命令：

bash
docker run -it --rm \
  -v /path/to/local/grafana-source:/grafana \  # 挂载本地 Grafana 源码目录至容器内 /grafana
  -v /path/to/build-output:/grafana/bin \      # 挂载构建产物目录（可选，持久化输出）
  -e GRAFANA_BRANCH="main" \                   # 指定构建的源码分支（可选）
  grafana/build-container:latest \             # 镜像名称（示例）
  make build                                   # 执行构建命令

docker-compose 配置示例

创建 docker-compose.yml 文件，定义构建环境：

yaml
version: '3.8'

services:
  grafana-builder:
    image: grafana/build-container:latest
    volumes:
      - ./grafana-source:/grafana          # 本地源码目录挂载
      - ./grafana-bin:/grafana/bin         # 构建产物持久化
      - ~/.ssh:/root/.ssh                  # 挂载 SSH 密钥（如需拉取私有依赖，可选）
    environment:
      - GRAFANA_BRANCH=main                # 源码分支
      - GO_VERSION=1.21                    # 覆盖 Go 版本（可选，默认内置兼容版本）
      - NODE_VERSION=18                    # 覆盖 Node.js 版本（可选，默认内置兼容版本）
    command: make build                    # 启动容器后执行的构建命令

启动命令：

bash
docker-compose up

环境变量说明

数据卷挂载

构建命令示例

容器启动后，可通过以下命令执行构建操作：

• 全量构建（默认，包含前端和后端）：

  bash
  make build
  

• 仅构建后端（跳过前端资源打包）：

  bash
  make server
  

• 构建并生成 Docker 镜像（基于当前源码）：

  bash
  make docker-build
  

• 运行单元测试：

  bash
  make test