Ed-Fi ODS Database Docker镜像文档

1. 镜像概述和主要用途

本镜像提供Ed-Fi ODS数据库的"填充模板"（populated template），即"最小模板"（minimal template），包含少量样本学校和学生数据，运行于PostgreSQL 13数据库引擎之上。

注意 本镜像推荐用于生产环境。

2. 核心功能和特性

• 基于PostgreSQL 13：采用官方PostgreSQL 13镜像作为基础，确保数据库服务的稳定性与兼容性
• Alpine优化：使用Alpine Linux构建，具备镜像体积小、资源占用低的特点
• 内置样本数据：包含预设的模拟学校和学生数据，支持快速功能验证
• TPDM表支持：可配置是否启用TPDM（Teacher Preparation Data Model）相关数据表，默认启用
• 灵活配置：通过环境变量自定义数据库用户、密码及数据库名称等关键参数

3. 使用场景和适用范围

本镜像适用于需要快速部署包含基础样本数据的Ed-Fi ODS数据库场景，主要包括：

• 生产环境中Ed-Fi教育数据系统的数据库服务部署
• 开发测试环境下的应用程序集成验证
• 教育数据系统原型搭建与功能演示
• 第三方系统对接Ed-Fi API的兼容性测试

4. 使用方法和配置说明

4.1 镜像变体

当前仅提供基于Alpine Linux的单一实现版本，使用PostgreSQL 13作为数据库引擎。镜像标签格式如下：

edfialliance/ods-api-db-ods-minimal:<version>

其中 <version> 需替换为具体版本号（如 5.3.0）。

4.2 环境变量配置

4.3 部署示例

4.3.1 使用docker run命令部署

docker run -d \
  --name edfi-ods-db \
  -p 5432:5432 \
  -e POSTGRES_USER=edfiadmin \
  -e POSTGRES_PASSWORD=SecurePass123! \
  -e ODS_DB=edfiods_minimal \
  -e TPDM_ENABLED=true \
  edfialliance/ods-api-db-ods-minimal:<version>

4.3.2 使用Docker Compose部署

创建docker-compose.yml文件：

version: '3.8'
services:
  edfi-ods-db:
    image: edfialliance/ods-api-db-ods-minimal:<version>
    container_name: edfi-ods-db
    ports:
      - "5432:5432"
    environment:
      POSTGRES_USER: edfiadmin
      POSTGRES_PASSWORD: SecurePass123!
      ODS_DB: edfiods_minimal
      TPDM_ENABLED: "true"
    restart: unless-stopped
    volumes:
      - ods-data:/var/lib/postgresql/data

volumes:
  ods-data:

启动服务：

docker-compose up -d

5. 相关文档

• 行为准则
• 贡献指南
• 贡献者列表
• 版权和许可声明
• 安全信息
• 许可协议

6. 法律信息

6.1 版权声明

Copyright (c) 2023 Ed-Fi Alliance, LLC and contributors.

6.2 许可协议

本软件基于Apache License, Version 2.0（"许可协议"）授权。除非适用法律要求或书面同意，根据许可协议分发的软件按"原样"提供，不附带任何明示或暗示的担保或条件。有关许可协议下权限和限制的具体规定，请参见许可协议文本。

6.3 Docker基础镜像说明

与所有Docker镜像一样，本镜像可能包含其他软件组件，这些组件可能受不同许可协议约束（如基础操作系统中的Bash等工具，以及主程序的直接或间接依赖项）。对于预构建镜像的使用，镜像用户有责任确保其使用行为符合所有包含软件的相关许可协议要求。