Diun容器镜像更新工具从v2升级到v3的迁移指南

Diun容器镜像更新工具从v2升级到v3的迁移指南

diun crazy-max/diun: Diun 是一个用于自动更新 Docker 镜像的 Python 库，可以用于自动化更新 Docker 镜像和容器，支持多种 Docker 镜像仓库和容器运行时，可以用于自动化部署和更新 Docker 应用程序。 项目地址: https://gitcode.com/gh_mirrors/di/diun

前言

Diun是一款优秀的容器镜像更新监控工具，它能够持续监控Docker镜像仓库中的更新情况并及时通知用户。随着Diun从v2版本升级到v3，一些重要的配置变更需要用户注意。本文将详细介绍这些变更，帮助用户顺利完成版本迁移。

文件提供者(File Provider)的变更

在v2版本中，静态配置被称为"static"提供者，而在v3中已更名为"file"提供者。这一变更不仅仅是名称上的改变，更重要的是带来了功能上的增强。

主要改进

1. 配置分离：现在可以将静态配置声明在一个或多个独立的文件中，避免主配置文件过于臃肿
2. 动态更新：支持配置文件的动态更新，无需重启服务即可应用变更

配置示例对比

v2版本配置方式：

providers:
  static:
    - name: docker.io/crazymax/diun
      watch_repo: true
      max_tags: 10

v3版本推荐配置方式：

providers:
  file:
    filename: /path/to/config.yml  # 从指定文件加载配置
    # 或
    directory: /path/to/config/folder  # 从目录加载多个配置文件

独立配置文件内容：

# /path/to/config.yml
- name: docker.io/crazymax/diun
  watch_repo: true
  max_tags: 10

Docker和Swarm提供者的限制变更

由于Docker引擎本身的限制，v3版本对Docker和Swarm提供者的配置方式进行了简化。

变更说明

1. 单实例限制：现在每个Diun实例只能声明一个Docker提供者和/或一个Swarm提供者
2. 简化配置：移除了提供者命名机制，配置更加简洁

配置示例对比

v2版本多实例配置：

providers:
  docker:
    mydocker:
      watch_stopped: true
  swarm:
    myswarm:
      watch_by_default: true

v3版本简化配置：

providers:
  docker:
    watch_stopped: true
  swarm:
    watch_by_default: true

通知器(Notifiers)配置的简化

v3版本对通知器配置进行了精简，移除了冗余的"enable"设置。

变更要点

1. 移除enable标志：不再需要显式启用或禁用通知器
2. 隐式启用机制：只要配置了通知器参数，该通知器就会自动启用
3. 禁用方式变更：要禁用通知器，需要完全移除或注释掉其配置节

配置示例对比

v2版本配置方式：

notif:
  amqp:
    enable: false  # 显式禁用
    host: localhost
    port: 5672
  gotify:
    enable: true  # 显式启用
    endpoint: http://gotify.foo.com
    token: Token123456
    priority: 1
    timeout: 10

v3版本简化配置：

notif:
  gotify:  # 仅保留需要启用的通知器
    endpoint: http://gotify.foo.com
    token: Token123456
    priority: 1
    timeout: 10

迁移建议

1. 逐步迁移：建议先在测试环境中验证v3配置，确认无误后再应用到生产环境
2. 配置文件备份：在修改前备份现有的v2配置文件
3. 关注日志输出：迁移后密切监控Diun的日志输出，确保所有功能正常工作
4. 通知测试：完成迁移后，建议手动触发测试通知，验证通知系统是否正常

通过以上变更，Diun v3在保持核心功能不变的同时，提供了更加简洁和灵活的配置方式，使系统维护变得更加高效。希望本指南能帮助您顺利完成版本升级。

diun crazy-max/diun: Diun 是一个用于自动更新 Docker 镜像的 Python 库，可以用于自动化更新 Docker 镜像和容器，支持多种 Docker 镜像仓库和容器运行时，可以用于自动化部署和更新 Docker 应用程序。 项目地址: https://gitcode.com/gh_mirrors/di/diun