docs: 移除开发过程文档,开源版文档统一见文档站

- docs/agent-role-template.md(代理角色模板与机构权限上限,内部业务规则)
- docs/agent-role-template-deployment.md(代理模板上线配置,含各环境角色 ID 核对)
- docs/角色权限异步同步.md(RabbitMQ 多级权限同步设计与失败重试语义)
- docs/普通角色与模板校验边界.md(普通角色维护边界与校验规则)

文档站:https://git.5iot.com/iotlcm-public/iotlcm-docs
This commit is contained in:
MiFaZhan
2026-10-30 11:40:42 +08:00
parent af3988a738
commit 0e8b596bf6
4 changed files with 0 additions and 94 deletions
-14
View File
@@ -1,14 +0,0 @@
# 代理模板上线配置
本次无需数据库结构迁移,不执行来源字段、索引或 outbox 建表脚本。没有新增菜单或手动定时任务。
1. 开发环境保持 sys_config:tenant_id=000000,config_key=agent.role.template.role_id,config_value=82。其他环境核对真实模板 ID,不能直接复制开发环境 ID。
2. 模板为平台企业100的代理商角色82,在企业管理的角色管理维护。启用且数据范围为本机构及下级,按钮采用角色默认范围。
3. 核对直属企业 sys_dept.dept_role 与管理员 sys_user_role:对应角色存在、未删除、属于该企业,并确认账号绑定。不要将所有企业绑定到角色82。
4. 部署新版后端,通过页面保存参数或模板触发同步。无需执行来源字段修复脚本。
已查到需核对的关联:企业117原角色67、147原角色91、175原角色88、187原角色94、188原角色95、190原角色96、191原角色98,均为失效关联。现存候选分别为101、58、102、103、104、105、106;核对账号绑定后才可修复,不盲目替换。
保存后直接同步各直属企业。某个企业失败不影响其他企业,接口报告失败,日志查看 agent template sync child failed 或 agent role sync child failed。修复后重新保存模板重试。模板已提交但同步失败时不会撤销已成功同步的企业;进程异常导致未完成同步,需要人工重新保存。
上线验收包括:三级企业、上级撤权、下级自建角色、旧登录账号、直接接口调用、单家关联异常、模板切换和重复同步。真实页面和多实例并发需另行验收。本次不修改实际数据库或运行服务。
-38
View File
@@ -1,38 +0,0 @@
# 代理角色模板与机构权限上限
## 业务规则
使用现有 sys_config、sys_role、sys_role_menu、sys_dept、sys_user_role 表,不新增表、字段或前端“角色用途”。
平台在默认租户的系统参数 agent.role.template.role_id 中指定模板角色 ID。模板身份由参数决定,不再依赖隐藏的 is_pass=1。角色必须启用、属于有效机构、不是上级继承角色,角色数据范围为本机构及下级(4),按钮不能配置全部或自定义数据范围。
## 创建代理与维护普通角色
- 平台创建一级代理时,从参数模板复制权限,为新机构创建独立默认角色和管理员绑定,不共用平台角色 ID。
- 各级代理创建下级时,从本机构有效默认角色复制权限,与上级链和平台模板取交集,不要求本机构再创建一个下发模板。
- 各级机构可新增多个普通角色。保存不再强制 is_pass=1,也不强制覆盖普通角色数据范围。
- 普通角色授权必须同时在本机构有效权限上限和当前操作账号有效角色的菜单范围内。停用角色不能提供授权依据。
- 参数模板、机构默认继承角色、普通角色分别承担平台权限来源、机构权限上限、人员实际授权,不混用。
- 未配置平台参数时,保留原有本级唯一 is_pass=1 角色的下发流程;配置平台参数后,历史本地下发标记不再触发权限覆盖。
## 多级异步同步
后端保存成功提交后,通过 RabbitMQ 发布任务,由独立 Worker 执行。平台模板变更按父先子后的顺序遍历各级企业,仅更新 sys_dept.dept_role 指定、归属本机构且来源为直属上级的有效继承角色。角色 ID、人员绑定和下级自建角色勾选保持不变。
新增权限扩展各级继承默认角色的权限范围;普通角色需下级自己勾选。绑定默认继承角色的管理员随默认角色取得新增权限,需要与普通角色区分。
撤销权限时,运行时逐级交集立即限制有效权限,不等待 Worker;Worker 随后更新继承角色记录。普通角色的历史勾选不主动删除,平台未来重新开放权限后,仍保留勾选的普通角色可能恢复该权限。这是现有授权记录保留语义,不表示“新权限自动勾选”。
每机构独立事务。父机构失败时,该分支下级计入失败而不越过父级放权;其他分支继续。重试只处理失败机构及被阻断的下级,失去当前模板从属关系的重试目标明确失败。旧模板任务和历史本地下发任务不能覆盖当前参数模板的继承链。
## 安全边界及历史数据
平台有效超级管理员的登录权限加载不依赖代理模板是否有效,普通账号仍严格校验模板与机构权限。不能只凭旧令牌中的管理员标记绕过检查。
默认角色缺失、停用、归属错误明确返回可处理错误,不再静默变成空菜单 404。角色列表查询不会自动建角色、绑定当前访问者或为历史账号扩权。历史 dept_role=0 数据需要平台管理员核实后修复,代码不会猜测哪个角色应是管理员。
## 可靠性限制
本分支不使用数据库任务表。保存与 MQ 发布不是原子操作;入队失败会明确提示“角色已保存”,需修复消息队列后重新保存补偿。进程若在数据库提交后、发布前退出,也需重新保存。消费者有限重试后进入死信队列,不承诺永不丢任务或 exactly-once。
后台与 Worker 必须成套更新。仅重启后台不会加载新的 Worker 多级同步逻辑。
-12
View File
@@ -1,12 +0,0 @@
# 普通角色维护与代理模板校验边界
- 平台模板由系统参数 agent.role.template.role_id 指定,与普通角色的隐藏 is_pass 标记分离。
- 普通角色可以创建多个,保存不再强制变成下发角色。配置模板后,历史下发标记不限制普通角色数量、不触发继承链覆盖。
- 普通角色的编辑、菜单、删除和数据权限维护只识别目标是否为配置模板;无关模板失效不应锁死平台超级管理员。
- 模板停用、归属异常或记录缺失时仍保留身份及删除保护;仅平台超级管理员可修改模板,模板按钮不能授予全部或自定义数据范围。
- 非超级管理员授予菜单时,同时核对机构及平台上限与操作员当前有效角色;禁止用已停用角色、旧管理员声明扩大授权。
- 有效平台超级管理员的登录权限加载先核对数据库角色,跳过无关模板有效性校验;普通账号继续严格校验。
- 缺失默认角色返回明确错误,不隐式创建角色或把访问角色列表的用户绑定成管理员。历史数据修复需核实后显式操作。
- 多级同步仅更新默认继承角色,普通角色不自动勾选;完整流程与可靠性限制见 agent-role-template.md 和角色权限异步同步.md。
验证使用 SQLite 隔离数据库,密码修改测试固定使用独立内存库和合成用户,不使用实际配置的数据库。未执行真实账号登录及真实消息队列端到端验证时,不以接口公开健康检查代替登录或同步成功。
-30
View File
@@ -1,30 +0,0 @@
# 角色权限异步同步
当前 v1.0.4 实现采用现有 RabbitMQ 队列 iotlcm.agent.role.sync,不新增任务表或权限版本表。业务规则以《代理角色模板与机构权限上限》为准。
## 保存与消费
1. 后台在数据库事务中保存角色及菜单,事务内禁止发布消息。
2. 提交后识别系统参数指定模板;模板不要求 is_pass=1。配置模板时,非模板角色不发布覆盖下级权限的任务。
3. 消息含任务标识、来源角色、来源机构、租户、操作者及模板标记,不携带菜单旧快照。
4. 后台使用发布确认;发布失败返回明确的“角色已保存、下发失败”错误,重新保存可补偿。
提交后的入队使用保留身份上下文但不继承请求取消的独立超时,最长十五秒,发布确认仍最多等待十秒;错误附带任务 ID,便于排查。此处理不等同于事务发件箱,进程退出仍可能造成提交与发布之间的消息丢失。
5. 独立 Worker 消费时读取当前模板、菜单和机构关系。配置已切换的模板任务,以及配置模板后的历史本地下发任务标记为 superseded,不按普通角色继续传播。
6. 平台模板按父先子后同步整棵企业下级树;每家企业独立事务,锁定目标机构、默认角色、模板参数及模板角色并再次校验。
7. 只更新有效的默认继承角色;不改用户角色绑定,不替下级普通角色增加勾选,不自动补齐缺失默认角色。
## 失败与重试
单家失败不阻塞其他分支;失败父机构的下级也计入失败,不能绕过父级。消息保存失败机构 ID 和统计,重试只处理失败目标。目标离开模板机构树后不能被静默算作成功。
消费者失败后延迟重试,最多重试五次,之后发布死信。重试或死信发布失败不能确认原消息。无效 JSON 和无效来源消息隔离到死信队列,隔离发布失败则原消息不能确认。
幂等同步保留角色 ID,重复消息读取当前配置,不恢复旧快照。但没有数据库任务表、事务发件箱或分布式租约,不能保证提交与发布原子性,也不保证任务持久化查询及人工重试页面。需要通过日志、消息队列与重新保存进行排查补偿。
## 本地验证
后台回归使用 SQLite 隔离数据库,覆盖模板异常与管理员登录、普通角色保存、操作员授权边界、默认角色异常、各级代理创建权限来源及提交后入队。
Worker 回归覆盖多层新增、撤权、模板切换、普通角色和账号绑定保留、失败父子分支重试、跨租户隔离、机构循环及重试目标迁出。
不应直接运行连接实际数据库的写入测试。密码修改回归已改为独立 SQLite 内存数据库及合成用户,不使用全局默认数据库、不读写真实账号,也不再提供环境变量开启真实库写入的入口。此前被修改账号的密码仍须管理员主动重置,测试隔离不能恢复原密码。