inseefrlab/onyxia-base

Onyxia 服务基础镜像

镜像概述和主要用途

本镜像作为 Onyxia 系列服务的基础镜像，旨在为 Onyxia 生态系统中的各类服务提供统一、标准化的运行时环境。通过预配置核心依赖和基础组件，简化 Onyxia 服务的构建、部署和维护流程，确保不同服务间的环境一致性，降低跨环境部署的兼容性风险。

核心功能和特性

核心功能

• 提供最小化且稳定的操作系统层（基于 Debian/Ubuntu 精简版）
• 预安装 Onyxia 服务通用依赖（如 Java 运行时、Python 环境、基础工具链等）
• 集成服务健康检查基础框架，支持自定义健康检查脚本
• 内置日志标准化工具，统一日志格式输出

关键特性

• 环境一致性：统一基础环境配置，避免"开发环境正常、生产环境异常"的问题
• 安全加固：默认启用非 root 用户运行，禁用不必要的系统调用，减少***面
• 轻量级：通过镜像分层优化和冗余清理，控制镜像体积（基础版本约 200-300MB）
• 可扩展性：预留服务配置接口，支持通过环境变量或配置文件自定义服务参数
• 多平台支持：提供 amd64 和 arm64 架构镜像，适配不同硬件环境

使用场景和适用范围

目标用户

Onyxia 服务开发团队、需要构建基于 Onyxia 生态的第三方服务开发者

适用场景

• Onyxia 官方服务镜像构建（如 Onyxia API 服务、数据处理服务等）
• 第三方基于 Onyxia 生态开发的扩展服务
• 开发/测试环境中 Onyxia 服务的本地验证和调试
• 生产环境 Onyxia 服务的容器化部署

适用环境

• 开发环境：本地开发、CI/CD 流水线构建阶段
• 测试环境：功能测试、集成测试、性能测试
• 生产环境：Kubernetes 集群、Docker Swarm 或单机容器部署

使用方法和配置说明

镜像拉取

通过 Docker Hub 或私有镜像仓库拉取镜像：

bash
docker pull onyxia/base-image:latest
# 指定版本（推荐生产环境使用固定版本）
docker pull onyxia/base-image:1.0.0

基础使用示例

1. 验证镜像可用性

bash
# 运行基础镜像并验证环境
docker run --rm onyxia/base-image:latest /bin/sh -c "echo 'Base image running'; java -version"

2. 作为基础镜像构建服务镜像

在服务 Dockerfile 中通过 FROM 指令引用本镜像：

dockerfile
# 基于 Onyxia 基础镜像构建服务
FROM onyxia/base-image:1.0.0

# 设置工作目录
WORKDIR /app

# 复制服务代码/二进制文件
COPY ./target/service.jar ./app.jar

# 暴露服务端口（示例）
EXPOSE 8080

# 启动命令（根据服务类型调整）
CMD ["java", "-jar", "app.jar"]

配置说明

环境变量

支持通过环境变量自定义基础环境配置，常用变量如下：

卷挂载

如需持久化日志或临时数据，可挂载以下路径：

Docker 部署方案示例

1. docker run 命令示例

bash
# 启动基础镜像并覆盖时区配置
docker run -d \
  --name onyxia-base-demo \
  -e TZ="Asia/Shanghai" \
  -e LOG_LEVEL="DEBUG" \
  -v /host/logs:/var/log/onyxia \
  onyxia/base-image:1.0.0

2. docker-compose 配置示例

yaml
version: '3.8'

services:
  onyxia-service-base:
    image: onyxia/base-image:1.0.0
    container_name: onyxia-base-service
    environment:
      - TZ=Asia/Shanghai
      - LOG_LEVEL=INFO
      - MAX_OPEN_FILES=131072
    volumes:
      - ./local-logs:/var/log/onyxia
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "/usr/local/bin/healthcheck.sh"]
      interval: 30s
      timeout: 10s
      retries: 3

3. 作为服务基础镜像的 Dockerfile + docker-compose 组合示例

服务 Dockerfile:

dockerfile
FROM onyxia/base-image:1.0.0

WORKDIR /app
COPY ./service /app/service
EXPOSE 8080
CMD ["/app/service", "--config", "/app/config.yaml"]

docker-compose.yml:

yaml
version: '3.8'

services:
  onyxia-custom-service:
    build: .  # 基于上述 Dockerfile 构建
    image: my-onyxia-service:1.0.0
    environment:
      - TZ=Asia/Shanghai
      - LOG_LEVEL=INFO
    volumes:
      - ./config:/app/config
      - ./logs:/var/log/onyxia
    ports:
      - "8080:8080"
    restart: always

注：实际使用时需根据具体服务需求调整启动命令、端口映射及配置参数。生产环境建议使用固定镜像版本（如 1.0.0）而非 latest，避免版本变更导致不可预期问题。