openhpc_webui

openhpc_webui 是面向高校、科研机构和企业智算中心的轻量级中文管理门户。安装时可选择本机 Linux 用户/PAM 或 OpenLDAP 作为身份后端，并将 Slurm 账户与关联、分区和节点配置、作业状态及输出查看集中到同一个 Web 界面，适合内网和离线环境。

当前版本：0.4.0

功能概览

页面资源随项目提供，不依赖外部 CDN。列表采用固定表头、对齐的数字和状态列，并在内容溢出时提供横向滚动。

权限模型

管理员由 ADMIN_USERS 配置，也可以在权限管理页面在线维护。普通用户访问管理员页面时会被重定向到作业页面。

界面预览

登录

系统总览

用户管理

作业管理

技术栈

• Python 3.9+
• FastAPI、Jinja2 和 Uvicorn
• Linux NSS/PAM 或 ldap3 / OpenLDAP
• Slurm CLI：sinfo、squeue、sacct、scontrol、sacctmgr、scancel
• uv 依赖与环境管理
• Tailwind CSS CLI 4.x（仅在修改模板或前端脚本中的工具类后重新构建）

项目结构

仓库目录使用 openhpc-webui，生产安装目录统一为 /srv/openhpc-webui；Python 包和命令行入口使用 openhpc_webui。Supervisor 配置与完整步骤见生产部署指南。

openhpc-webui/
├── openhpc_webui/
│   ├── application.py      # FastAPI 路由与接口
│   ├── cli.py              # 命令行入口
│   ├── core/               # 配置、认证和公共能力
│   ├── models/             # 请求与响应模型
│   └── services/           # 系统身份、Slurm 和其他集成
├── templates/              # Jinja2 页面模板
├── static/                 # 离线 CSS、JavaScript 和图标
├── tests/                  # 自动化测试
├── docs/                   # 使用、部署和运维文档
├── env.example             # 环境变量示例
└── pyproject.toml          # 项目元数据与依赖

环境要求

运行门户的主机需要：

• 使用系统账户后端时，本机已配置 PAM login 服务以及 useradd、usermod、userdel、groupadd 等账户工具；使用 LDAP 后端时，主机能够访问 OpenLDAP；
• 安装 Slurm 客户端命令，并能连接 Slurm 控制端；
• 对节点和分区配置文件具有业务所需的读写权限；
• 使用 NFS 配额时安装并配置 quota / setquota；
• 生产环境具备 Nginx、Supervisor 或等效的进程管理能力。

Web 管理员身份不会绕过 Linux 文件权限或 Slurm 权限。

快速开始

从 PyPI 安装固定版本：

python3 -m venv .venv
.venv/bin/python -m pip install "openhpc-webui==0.4.0"

PyPI 安装不包含仓库级 env.example 和部署示例，完整配置及 systemd、升级、离线 安装方法见PyPI 安装与使用指南。

从源码启动开发环境：

uv sync
uv run uvicorn openhpc_webui.application:app --reload --port 6827

浏览器访问 http://127.0.0.1:6827，首次启动会自动进入安装向导，选择系统账户或 LDAP、 配置 Slurm 和首位管理员，并自动生成 Session 密钥。也可以使用项目命令启动监听在 0.0.0.0:6827 的服务：

uv run openhpc_webui

系统配置

安装后的日常配置在管理员「系统设置」页面维护，并以权限 0600 原子写入 .env。 敏感值只显示“已配置”状态，不会回传浏览器。管理员列表、终端 AI 和终端公告分别由 现有的权限管理及系统设置卡片维护。

以下配置均可通过安装向导或系统设置页面管理：

.env 仍作为持久化与无人值守部署的兼容入口；已经提供有效 SECRET_KEY 的旧部署会被 自动视为已安装，不会跳转到安装向导。认证模式、Session 密钥和 HTTPS Cookie 设置修改后 需要重启服务。

应用以启动目录的 .env 为统一读写配置文件，也可通过绝对路径 OPENHPC_WEBUI_ENV_FILE 指定位置；权限管理、终端设置和安装向导会写入同一个文件。删除身份用户会使其现有登录会话失效。

无人值守部署还可在 .env 中设置 SYSTEM_ACCOUNT_COMMAND_TIMEOUT_SECONDS（默认 30 秒）、 SLURM_COMMAND_TIMEOUT_SECONDS （默认 15 秒）和 SSH_KEYGEN_TIMEOUT_SECONDS（默认 30 秒）。这些值限制在 1–300 秒， 用于防止后端服务或 CLI 卡住请求线程；修改后需要重启服务。

完整配置说明见技术指南。

生产部署

生产环境建议由 Supervisor 管理 Uvicorn，并仅监听 127.0.0.1:6827；由 Nginx 提供 HTTPS 和反向代理。不要直接将开发服务器暴露到公网。

部署步骤、自签发证书、服务管理和升级方法见生产部署指南。

文档

• 版本调整与发布：版本同步脚本、发布检查、GitHub Release 和 PyPI 流程
• PyPI 安装与使用指南：虚拟环境、配置、systemd、升级和离线安装
• 用户使用手册：管理员和普通用户的页面操作说明
• 技术指南：配置、运行、架构、测试与故障排查
• 生产部署指南：Supervisor、Nginx、HTTPS 和升级
• 磁盘配额指南：XFS /home 配额启用、验证和 Web UI 配置
• 核时统计与额度拨付：统计口径、Slurm 命令、拨付算法和登录提示脚本
• Rocky Linux 9 LDAP 部署：OpenLDAP 安装与初始化
• Rocky Linux 9 SSSD 接入：计算节点接入 LDAP 身份

验证与开发

./scripts/build_tailwind.sh
uv run python -m unittest discover -s tests
uv run python -m compileall -q openhpc_webui

Tailwind 构建入口为 tailwind.css，只扫描 templates/ 和 static/*.js 中实际使用的类，并将压缩后的离线样式写入 static/all-tailwind-classes-full-min.css。

提交界面变更前，还应手动检查登录、用户、组、账户、Slurm 用户关联、分区、节点、作业和权限页面，并附上桌面与窄屏截图。

安全建议

• 仅在受控内网开放门户，并使用防火墙限制来源。
• 生产环境启用 HTTPS，并将 SESSION_HTTPS_ONLY 设为 True。
• 不要提交 .env、Session 密钥、历史 LDAP 凭据或真实用户数据。
• 单节点系统账户管理需要 root；只在受控主机运行，并限制门户网络入口和管理员名单。
• 定期审计管理员列表、Slurm 操作和应用日志。

本项目是集群管理辅助工具，不替代 Slurm、Linux 身份系统、监控平台或审计系统本身。