dserio83/velero-ui

Velero-UI Docker镜像文档

一、镜像概述和主要用途

Velero-UI 是一个为 Velero（Kubernetes 备份工具）提供用户界面的 Docker 镜像，旨在通过可视化界面简化 Velero 的备份操作流程。该镜像封装了 Velero 的 Web 管理界面，允许用户通过图形化方式执行备份、恢复、监控等操作，降低命令行操作的复杂度。

二、核心功能和特性

• 简化备份操作：通过直观的用户界面替代 Velero 命令行操作，支持备份任务的创建、编辑和删除。
• 备份状态监控：实时展示备份任务的运行状态（如运行中、成功、失败）、进度及历史记录。
• 恢复流程可视化：提供恢复任务的配置向导，支持从备份记录中选择目标数据进行恢复。
• 集成 Velero 核心能力：与 Velero API 深度集成，支持备份存储位置管理、备份策略配置等核心功能。

三、使用场景和适用范围

• Kubernetes 管理员：需要通过可视化方式管理集群备份策略的运维人员。
• DevOps 团队：在日常工作中需频繁执行备份/恢复操作，追求高效操作流程的团队。
• 中小型集群环境：缺乏专职命令行运维人员，需要简化管理复杂度的场景。
• 备份审计需求：需通过界面记录和追溯备份操作历史的场景。

四、详细的使用方法和配置说明

4.1 基本使用条件

• 已部署 Velero 服务的 Kubernetes 集群（需确保 Velero API 可被 Velero-UI 访问）。
• Docker 环境（或 Kubernetes 环境，用于容器化部署）。

4.2 快速启动（docker run）

bash
docker run -d \
  --name velero-ui \
  -p 8080:8080 \  # 映射容器端口到宿主机（默认容器内端口为 8080，可根据实际镜像配置调整）
  -e VELERO_API_URL=http://velero-api-service:8085 \  # Velero API 服务地址（需替换为实际地址）
  seriohub/velero-ui:latest

说明：VELERO_API_URL 为必填环境变量，用于指定 Velero API 的访问地址，确保 Velero-UI 能与 Velero 服务通信。

4.3 Docker Compose 部署示例

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  velero-ui:
    image: docker.xuanyuan.run/seriohub/velero-ui:latest
    container_name: velero-ui
    ports:
      - "8080:8080"
    environment:
      - VELERO_API_URL=http://velero-api-service:8085  # 替换为实际 Velero API 地址
    restart: unless-stopped

启动服务：

bash
docker-compose up -d

4.4 访问界面

容器启动后，通过浏览器访问 http://<宿主机IP>:8080 即可打开 Velero-UI 界面，根据提示完成登录或配置（具体登录方式需参考镜像内置逻辑或 GitHub 文档）。

五、配置说明

5.1 环境变量

Velero-UI 主要通过环境变量进行配置，常见参数如下（具体以 GitHub 源码为准）：

• VELERO_API_URL：Velero API 服务的访问地址（必填，如 http://velero-service:8085）。
• PORT：容器内 Web 服务端口（默认 8080，可自定义）。
• LOG_LEVEL：日志级别（如 info、debug，默认 info）。

5.2 配置文件挂载

如需自定义更复杂的配置（如 TLS 证书、认证策略），可通过挂载配置文件到容器内指定路径（具体路径需参考 GitHub 文档）：

bash
docker run -d \
  --name velero-ui \
  -p 8080:8080 \
  -e VELERO_API_URL=http://velero-api-service:8085 \
  -v /path/to/custom/config:/app/config \  # 挂载宿主机配置文件到容器内
  seriohub/velero-ui:latest

六、参考链接

• 项目源码与详细文档：https://github.com/seriohub/velero-ui
• Velero 官方文档：https://velero.io/docs/