vespaengine/vespa-pipeline

Vespa 应用编译 Docker 镜像技术文档

镜像概述和主要用途

Vespa 应用编译 Docker 镜像是一个最小化镜像，专为 Vespa 应用的编译流程设计。其主要用途是提供经过验证的 Maven 和 JDK 版本，以及集成 Vespa 命令行工具（vespa-cli），支持 Vespa 应用的构建、打包和部署操作。该镜像旨在简化 Vespa 应用的编译环境配置，确保开发、测试和生产环境中工具版本的一致性。

核心功能和特性

• 集成编译工具链：包含 Vespa 应用编译所需的支持版本的 Maven 和 JDK，确保与 Vespa 框架的兼容性。
• 内置 vespa-cli：集成 Vespa 命令行工具，支持应用部署、集群管理等操作，简化从编译到部署的流程。
• 最小化设计：镜像体积精简，仅包含编译和部署必要组件，适合在资源受限的 CI/CD 环境中高效运行。

使用场景和适用范围

适用场景

• 自动化 CI 流水线：用于 Jenkins、GitLab CI、GitHub Actions 等自动化平台，实现 Vespa 应用的自动编译、测试和部署。
• 开发环境标准化：为开发团队提供统一的本地编译环境，避免因工具版本差异导致的构建问题。
• 快速部署验证：在测试或预发布环境中，快速编译并部署 Vespa 应用进行功能验证。

适用范围

• 需要编译和部署 Vespa 应用的开发、测试及运维人员。
• 基于 Maven 构建的 Vespa 应用项目。
• 需通过命令行工具（vespa-cli）管理 Vespa 集群的场景。

详细使用方法和配置说明

镜像拉取

通过 Docker Hub 拉取最新版本镜像：

bash
docker pull vespaengine/vespa-pipeline

如需指定版本，可在镜像标签后添加版本号（例如 vespaengine/vespa-pipeline:8.289.17），具体版本列表可参考 https://hub.docker.com/r/vespaengine/vespa-pipeline%E3%80%82

基本使用（docker run 示例）

1. 本地编译 Vespa 应用

将本地 Vespa 应用代码目录挂载到容器中，执行 Maven 编译命令：

bash
docker run --rm -v $(pwd):/app -w /app vespaengine/vespa-pipeline \
  mvn clean install

• --rm：容器退出后自动删除。
• -v $(pwd):/app：将当前目录（Vespa 应用代码根目录）挂载到容器内 /app 路径。
• -w /app：设置工作目录为 /app，即应用代码目录。
• mvn clean install：执行 Maven 清理并编译打包。

2. 使用 vespa-cli 部署应用

编译完成后，可通过 vespa-cli 部署应用至 Vespa 集群（需提前配置集群访问信息）：

bash
docker run --rm -v $(pwd):/app -w /app \
  -e VESPA_CLI_HOME=/root/.vespa \  # 指定 vespa-cli 配置目录
  -v ~/.vespa:/root/.vespa \        # 挂载本地 vespa-cli 配置（包含集群认证信息）
  vespaengine/vespa-pipeline \
  vespa deploy target/application.zip  # 部署编译后的应用包

CI 流水线集成（docker-compose 示例）

在 CI 环境中，可通过 docker-compose 定义服务，实现编译与部署流程的自动化。以下是 docker-compose.yml 示例：

yaml
version: '3.8'
services:
  vespa-build:
    image: vespaengine/vespa-pipeline
    volumes:
      - ./app:/app:ro  # 挂载应用代码（只读）
      - ./maven-repo:/root/.m2/repository  # 挂载 Maven 本地仓库，加速依赖下载
      - ./vespa-config:/root/.vespa  # 挂载 vespa-cli 配置（包含集群认证）
    working_dir: /app
    command: >
      sh -c "mvn clean install && 
             vespa deploy target/application.zip"

说明：

• ./app：本地 Vespa 应用代码目录。
• ./maven-repo：本地 Maven 仓库目录，避免重复下载依赖。
• ./vespa-config：包含 vespa-cli 配置文件（如 config.yaml），配置集群地址、认证信息等。

配置参数与环境变量

该镜像默认集成以下工具，相关配置可通过环境变量或挂载配置文件调整：

许可信息

本镜像基于 Apache License, Version 2.0 许可。

参考链接

• Vespa 官方文档
• vespa-cli 工具文档
• https://hub.docker.com/r/vespaengine/vespa-pipeline