megabytelabs/updater

Docker Updater 镜像文档

概述

持续集成（CI）工具能显著提高开发效率，可实现代码扫描、自动部署等功能。本镜像作为CI流程的重要组成部分，提供了构建CI/CD管道所需的各类程序。与使用公共镜像不同，该镜像为内部构建，确保代码透明可控，同时保持最小化设计，使CI环境能快速下载并执行特定任务。基于此镜像，用户可轻松创建自定义的内部CI管道容器。

核心功能和特性

• 通用性：适用于各类CI/CD流程，提供多种必要工具
• 紧凑设计：优化镜像大小，减少下载时间和存储空间
• 透明可控：内部构建确保无未知代码，提升安全性
• 开发友好：包含丰富的开发配置文件，支持团队协作和标准化开发

要求

基本要求

• Docker：用于运行和管理容器

开发要求

• DockerSlim：用于生成紧凑、安全的镜像
• jq：用于JSON数据处理
• Node.js (>=14.18)：提供开发功能，如预提交钩子和维护任务
• Bodega：自定义的go-task/task分支，用于动态安装依赖和执行任务

开发环境可通过运行bash start.sh或npm i自动配置，脚本会将缺失的依赖安装到~/.local/bin目录，并生成文档及执行其他维护任务。

使用场景和适用范围

• 本地CI工具测试和运行
• GitLab CI等CI/CD平台集成
• 自定义CI管道镜像构建
• 团队标准化CI环境配置

使用方法和配置说明

本地运行

通过以下命令在本地测试镜像功能：

shell
docker run -v ${PWD}:/work -w /work docker.xuanyuan.run/megabytelabs/updater:preferred_tag docker_command

添加Bash别名

将以下内容添加到~/.bashrc（Linux）或~/.bash_profile（macOS），以便随时使用镜像中的命令：

shell
docker_command_alias() {
    docker run -v ${PWD}:/work -w /work docker.xuanyuan.run/megabytelabs/updater:preferred_tag "$@"
}

注意：部分CLI工具无需参数即可运行，默认情况下镜像会显示版本信息。如需运行无参数命令，可使用类似ansible-lint .的方式。

集成GitLab CI

在GitLab项目根目录创建.gitlab-ci.yml文件，内容如下：

yaml
---
stages:
  - lint

include:
  - remote: https://gitlab.com/megabyte-space/gitlab-ci-templates/-/raw/master/updater.gitlab-ci.yml

建议：生产环境中，应将远程模板代码复制到本地，避免依赖外部变更。

构建自定义Docker容器

修改Dockerfile后，通过以下命令将自定义镜像上传到Docker Hub：

shell
export DOCKERHUB_USERNAME=你的DockerHub用户名
export DOCKERHUB_PASSWORD=你的DockerHub密码
docker login -u "$DOCKERHUB_USERNAME" -p "$DOCKERHUB_PASSWORD" docker.io
docker build --pull -t "$DOCKERHUB_USERNAME/updater:latest" .
docker push "$DOCKERHUB_USERNAME/updater:latest"

构建精简容器

可使用DockerSlim进一步减小镜像体积并提升安全性。目前本仓库暂未配置精简构建，如需实现，可参考以下步骤：

1. 在.blueprint.json中添加"dockerslim_command"配置
2. 运行bash .start.sh生成相关构建命令
3. 执行精简构建命令

DockerSlim可将镜像大小减少最高448.76倍，例如700MB的镜像可减小至1.56MB。

开发构建工具

项目包含丰富的开发工具，可通过以下步骤使用：

1. 安装Node.js（或直接运行bash start.sh）
2. 执行npm i安装依赖
3. 运行task --list查看可用命令，或task --menu打开交互式菜单

注意：项目使用自定义版本的go-task/task（Bodega），如已安装原版task，需替换或使用不同命令名称。

贡献指南

如需贡献代码，请参考项目的https://gitlab.com/megabyte-labs/docker/ci-pipeline/updater/-/blob/master/CONTRIBUTING.md文档。

许可证

本项目采用MIT许可证，详情参见https://github.com/ProfessorManhattan/docker-updater/blob/master/LICENSE文件。