edfialliance/ods-api-db-sandbox

Ed-Fi Sandbox Databases Docker镜像文档

镜像概述和主要用途

本镜像提供Ed-Fi ODS沙箱数据库的Docker部署方案，包含EdFi_Ods_Sandbox_*系列数据库、最小化模板EdFi_Ods_Minimal_Template及预填充模板EdFi_Ods_Populated_Template，基于PostgreSQL 11实现。这些模板遵循Ed-Fi数据标准，数据库在镜像首次启动时自动安装，默认启用变更查询（change queries）。沙箱数据库初始创建需在Sandbox Admin应用启动时触发。

注意：镜像默认安装Grandbend供应商组件，不推荐用于生产环境。

核心功能和特性

• 多数据库模板支持：包含沙箱数据库（EdFi_Ods_Sandbox_*）、最小化模板（EdFi_Ods_Minimal_Template）和预填充模板（EdFi_Ods_Populated_Template）
• 技术栈：基于Alpine系统和PostgreSQL 11构建，轻量高效
• 自动初始化：首次启动时自动完成数据库安装与配置
• 变更查询：默认启用变更查询功能，支持数据变更追踪
• TPDM表支持：可选启用TPDM（Teacher Preparation Data Model）表结构
• 环境变量配置：支持通过环境变量自定义数据库用户、密码等关键参数

使用场景和适用范围

• 开发环境：Ed-Fi ODS/API应用的本地开发与调试
• 测试环境：验证Ed-Fi数据标准兼容性及应用功能
• 沙箱管理：配合Sandbox Admin应用创建和管理沙箱数据库实例
• 培训与演示：快速搭建Ed-Fi数据模型演示环境

不适用场景：生产环境部署（因默认包含非生产组件）

镜像版本与变体

支持的镜像变体

当前仅支持基于Alpine系统的PostgreSQL 11实现：
edfialliance/ods-api-db-sandbox:<version>

可用版本链接

• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.7/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.6/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.5/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.4/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.3/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.2/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.1/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.1.0/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v2.0.0/DB-Sandbox/Alpine/pgsql/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v1.1.0/DB-Sandbox/Dockerfile
• https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/v1.0.0/DB-Sandbox/Dockerfile

环境变量配置

使用方法和部署示例

Docker Run命令部署

bash
docker run -d \
  --name edfi-sandbox-db \
  -p 5432:5432 \
  -e POSTGRES_USER=edfi_admin \
  -e POSTGRES_PASSWORD=SecurePass123! \
  -e TPDM_ENABLED=true \
  -v edfi-db-data:/var/lib/postgresql/data \
  edfialliance/ods-api-db-sandbox:2.1.7

参数说明：

• -p 5432:5432：映射容器PostgreSQL端口到主机
• -v edfi-db-data:/var/lib/postgresql/data：挂载卷以持久化数据库数据
• 环境变量配置数据库用户、密码及TPDM启用状态

Docker Compose部署

创建docker-compose.yml文件：

yaml
version: '3.8'

services:
  edfi-sandbox-db:
    image: edfialliance/ods-api-db-sandbox:2.1.7
    container_name: edfi-sandbox-db
    ports:
      - "5432:5432"
    environment:
      POSTGRES_USER: edfi_admin
      POSTGRES_PASSWORD: SecurePass123!
      TPDM_ENABLED: "true"
    volumes:
      - edfi-db-data:/var/lib/postgresql/data
    restart: unless-stopped

volumes:
  edfi-db-data:

启动服务：

bash
docker-compose up -d

许可证信息

本镜像包含软件的许可证信息参见https://github.com/Ed-Fi-Alliance-OSS/Ed-Fi-ODS-Docker/blob/main/LICENSE%E3%80%82

与所有Docker镜像一样，本镜像可能包含其他软件（如基础系统的Bash等），这些软件可能受其他许可证约束。镜像用户需自行确保其使用符合所有包含软件的相关许可证要求。