illinois241/grade-viewer

CS 241 Docker镜像文档

!https://github.com/illinois-cs241/docker-tools/workflows/Linting/badge.svg !https://github.com/illinois-cs241/docker-tools/workflows/Test/badge.svg !Python Versions

镜像概述和主要用途

本仓库包含CS 241课程基础设施所需的所有Docker镜像，用于支持课程的自动评分环境、开发部署及持续集成流程，确保教学和评分基础设施的一致性与可靠性。

核心功能和特性

• 评分环境模拟：提供run_grader.py脚本，可模拟Broadway平台的自动评分环境
• 持续集成支持：配置Docker Hub自动构建，代码合并到release分支后自动触发镜像更新
• 版本控制：支持Python 3.6及以上版本，确保环境兼容性
• 可扩展性：提供完整的新镜像添加流程，支持基础设施扩展

使用场景和适用范围

适用于CS 241课程团队进行自动评分系统的开发、测试和部署，确保评分环境与生产环境一致，同时支持课程基础设施的持续迭代和更新。

使用方法和配置说明

运行评分脚本

该脚本用于模拟Broadway中的自动评分环境，使用步骤如下：

1. 环境要求：

   • Python 3.6及以上版本
   • （推荐）创建并激活虚拟环境

2. 安装依赖：

   bash
   pip install docker
   

3. 运行脚本：

   • 必须使用sudo权限运行（注意：sudo环境下Python解释器路径会变为root用户的Python路径）
   • 通过-h标志查看脚本使用帮助

4. 示例命令：

   bash
   sudo venv/bin/python run_grader.py -h
   

持续集成

自动构建流程

所有Docker Hub上的镜像均配置为自动构建，工作流程如下：

• 代码合并到release分支后，Docker Hub会自动触发仓库中所有镜像的构建
• 构建完成后，更新后的镜像会自动推送到Docker Hub
• 所有评分流水线会自动拉取更新后的镜像，实现代码快速部署到生产环境

注意：请勿将向后不兼容的更改合并到release分支，合并操作会在几分钟内将代码部署到生产环境。

添加新Docker镜像

1. 推送镜像到Docker Hub：

   • 使用CS 241的Docker Hub用户（https://hub.docker.com/u/illinois241%EF%BC%89%E6%8E%A8%E9%80%81%E9%95%9C%E5%83%8F%EF%BC%88%E8%AF%B7%E5%90%91%E5%9F%BA%E7%A1%80%E8%AE%BE%E6%96%BD%E8%B4%9F%E8%B4%A3%E4%BA%BA%E7%B4%A2%E5%8F%96%E7%99%BB%E5%BD%95%E5%87%AD%E6%8D%AE%EF%BC%89
   • 每个镜像需放在独立仓库，仓库名称格式遵循Docker Hub标准：illinois241/<repo-name>

2. 配置自动构建：

   • 进入仓库构建页面：https://hub.docker.com/repository/docker/illinois241/<repo-name>/builds
   • 点击"Configure Automated Builds"按钮，设置源仓库为docker-tools
   • 添加源配置：
     • 类型：Branch
     • 源：release
     • Docker标签：latest
     • Dockerfile位置：Dockerfile
     • 构建上下文：<docker-tools中Dockerfile所在目录的路径>
     • 自动构建：开启
     • 构建缓存：开启

3. 更新CI配置：

   • 为新镜像添加linting和测试流程
   • 参考.github/workflows/目录中的现有工作流进行配置