biow0lf/evemonk-sidekiq

EveMonk Sidekiq 镜像文档

概述

EveMonk Sidekiq 是一个基于 Sidekiq 的 Docker 镜像，主要用于 Ruby 应用中的后台作业处理。Sidekiq 是一个高效的 Ruby 后台作业处理器，通过 Redis 实现任务队列管理，EveMonk Sidekiq 镜像则将其打包为 Docker 容器，简化部署流程，便于在各类环境中快速集成和使用。

核心功能与特性

• 基于 Sidekiq：集成 Sidekiq 核心功能，支持 Ruby 应用的异步任务处理
• 容器化部署：通过 Docker 容器封装，简化环境配置与依赖管理
• 安全与质量保障：集成多项代码质量与安全扫描工具（如 Snyk、DeepSource、Hakiri），确保镜像安全性与稳定性
• 持续集成支持：通过 CircleCI 实现自动化构建与测试，保障镜像版本可靠性

使用场景

• Ruby on Rails 或其他 Ruby 应用中需要处理异步任务（如邮件发送、数据处理、定时任务等）的场景
• 需要隔离后台作业环境，避免影响前端应用性能的场景
• 需快速部署和扩展后台任务处理能力的分布式应用架构

使用方法

前提条件

• 已安装 Docker 环境
• 应用需配置 Redis 服务（Sidekiq 依赖 Redis 作为任务队列存储）

基本使用（docker run）

bash
docker run --name evemonk-sidekiq \
  -e REDIS_URL=redis://your-redis-host:6379/0 \
  -v /path/to/your/app:/app \
  docker.xuanyuan.run/evemonk/evemonk-sidekiq

环境变量配置

docker-compose 示例

yaml
version: '3'
services:
  sidekiq:
    image: docker.xuanyuan.run/evemonk/evemonk-sidekiq
    environment:
      - REDIS_URL=redis://redis:6379/0
      - SIDEKIQ_CONCURRENCY=15
      - SIDEKIQ_QUEUES=high default low
    volumes:
      - ./your-app:/app
    depends_on:
      - redis

  redis:
    image: docker.xuanyuan.run/redis:alpine

安全与质量

该镜像通过以下工具保障安全性与代码质量：

• CircleCI：自动化构建与测试流程
• Snyk：漏洞扫描与依赖安全检测
• DeepSource：代码质量与规范检查
• Hakiri：Ruby 应用安全漏洞扫描

注意事项

• 确保 Redis 服务可被容器访问，网络配置需正确映射
• 根据应用任务负载调整 SIDEKIQ_CONCURRENCY 参数，避免资源过度占用
• 任务队列配置需与应用中的 Sidekiq 队列定义保持一致，确保任务能被正确处理