logger-config-wizard 镜像文档

一、镜像概述与主要用途

概述

logger-config-wizard 是一个日志配置向导工具镜像，旨在帮助用户快速配置和扩展日志记录端点。该镜像支持多架构部署（包括 linux/arm64、linux/amd64、linux/arm/v7），但当前多架构自动构建（Autobuild）功能存在异常，需通过手动方式构建和推送。

主要用途

• 提供日志配置管理界面，支持自定义日志端点配置
• 允许用户通过扩展路由和模板文件，灵活添加新的日志处理端点
• 适配多架构环境，满足不同硬件平台的部署需求

二、核心功能与特性

核心功能

1. 多架构支持：兼容 arm64、amd64、arm/v7 架构，可在多种硬件平台部署
2. 端点扩展机制：通过修改路由配置文件和添加模板文件，快速扩展日志端点功能
3. 手动构建流程：提供手动构建和推送多架构镜像的命令，规避自动构建异常问题

特性

• 轻量级设计，部署资源占用低
• 模块化架构，支持用户自定义端点逻辑与界面
• 跨架构兼容性，适用于异构计算环境

三、使用场景与适用范围

使用场景

• 开发者需要为日志系统添加自定义处理端点（如日志转发、存储、展示等）
• 系统管理员在多架构集群（如混合 x86/ARM 服务器）中部署日志配置工具
• 需要快速迭代日志端点功能，通过修改代码和模板实现功能扩展

适用范围

• 支持架构：linux/arm64、linux/amd64、linux/arm/v7
• 目标用户：日志系统开发者、系统管理员、需要自定义日志流程的技术团队

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

4.1 手动构建与推送多架构镜像

由于多架构自动构建（Autobuild）功能异常，需通过以下手动方式构建并推送镜像至 Docker Hub。

前提条件

• 已安装 Docker（版本 ≥ 20.10，支持 buildx）
• 已登录 Docker Hub（docker login）
• 本地已配置 buildx 多架构构建能力（docker buildx create --use）

4.1.1 直接使用 buildx 命令构建推送

执行以下命令手动构建多架构镜像并推送至 Docker Hub：

bash
docker buildx build -f Dockerfile --push --tag avaasiaadmin/logger-config-wizard --platform=linux/arm64,linux/amd64,linux/arm/v7 .

参数说明：

• --push：构建完成后直接推送至镜像仓库
• --tag：指定镜像标签（格式为 仓库名/镜像名）
• --platform：指定目标架构，支持 arm64、amd64、arm/v7

4.1.2 使用部署脚本构建推送

通过执行部署脚本简化构建流程：

bash
sh deploy.sh

注：需确保 deploy.sh 脚本中包含上述 buildx 构建命令，且脚本具有可执行权限（chmod +x deploy.sh）。

4.2 添加新端点

如需扩展日志配置的端点（如新增日志接收或展示页面），需通过以下步骤修改镜像源码并重新构建：

1. 添加路由配置
   导航至源码中的 view.py 文件，在其中添加新的路由规则，示例：

   python
   # view.py 示例片段
   from flask import render_template
   
   def register_routes(app):
       @app.route('/new-endpoint')  # 新端点路径
       def new_endpoint_handler():
           return render_template('new_endpoint.html')  # 关联模板文件
   

2. 添加 HTML 模板
   在 templates/ 目录下创建与新端点对应的 HTML 模板文件（如 new_endpoint.html），定义页面结构和交互逻辑。

3. 重新构建镜像
   修改完成后，执行 4.1 节中的构建命令，推送更新后的镜像至仓库。

五、Docker 部署方案示例

5.1 手动构建并推送多架构镜像（完整命令）

bash
# 登录 Docker Hub（如未登录）
docker login -u avaasiaadmin

# 构建并推送多架构镜像
docker buildx build -f Dockerfile --push --tag avaasiaadmin/logger-config-wizard:latest --platform=linux/arm64,linux/amd64,linux/arm/v7 .

5.2 使用部署脚本自动化构建

bash
# 下载或准备 deploy.sh 脚本
curl -O [***]  # 假设脚本来源于此URL
chmod +x deploy.sh

# 执行脚本部署
./deploy.sh

六、已知问题

• 多架构自动构建异常：当前镜像的 Autobuild 功能（如 Docker Hub 自动构建）无法正常支持多架构镜像构建，需通过 4.1 节中的手动方式构建。

七、注意事项

1. 架构兼容性：构建时需确保 Dockerfile 中基础镜像支持目标架构（arm64、amd64、arm/v7），避免出现运行时兼容性问题。
2. 模板文件路径：新增端点时，模板文件必须放置于 templates/ 根目录下，否则可能导致模板加载失败。
3. 权限配置：执行 deploy.sh 前需确保脚本具有可执行权限，且构建用户拥有 Docker 守护进程操作权限。