Skip to content

DEVELOPMENT.md

Latest commit

 

History

History
103 lines (71 loc) · 3.2 KB

DEVELOPMENT.md

File metadata and controls

103 lines (71 loc) · 3.2 KB
Raw

JumpServer V3.10 LTS Skills 开发指南

本仓库是 JumpServer V3.10 LTS 专用 skills 工具集，支持开源版与企业版（XPack）。

目标版本

  • 目标标签：V3.10 LTS
  • 参考分支：v3.10.21-lts
  • 版本事实文件：jumpserver-api/jms_version.py
  • API 参考：references/api-reference.md

架构

.
├── SKILL.md                         # 总路由
├── jumpserver-api/                  # 共享运行时
│   ├── jms_version.py               # 端点与版本 profile
│   ├── jms_query.py / jms_diagnose.py / jms_report.py
│   └── ...
├── jumpserver-<intent>/             # 7 个子模块
│   ├── SKILL.md
│   └── scripts/*.py                 # 薄入口，加载 jumpserver-api
└── references/                      # 规则与 capability 元数据

原则：

  • 子模块只承载场景边界和本地 CLI 入口
  • 共享逻辑只放 jumpserver-api/
  • 不生成临时 HTTP/SDK 脚本绕过正式入口

开发工作流

1. 确认 API 事实

在 JumpServer/jumpserver 仓库对照 v3 分支：

git show origin/v3.10.21-lts:apps/assets/urls/api_urls.py

企业版 XPack 接口对照 JumpServer-Xpack/core-xpack。

2. 修改共享层

  1. jms_version.py：端点、XPack 路径、不支持能力列表
  2. jms_discovery.py：端点 inventory
  3. jms_query.py / jms_diagnose.py / jms_analytics.py：业务逻辑
  4. references/metadata/capabilities.json：能力元数据

3. 更新子模块文档

  • jumpserver-<intent>/SKILL.md
  • 根目录 SKILL.md、README.md

新增子模块遵循 ADD-SUBSKILL-GUIDE.md。

4. 本地验证

python jumpserver-runtime-setup/scripts/jms_diagnose.py config-status --json
python jumpserver-governance-inspection/scripts/jms_diagnose.py license-detail
python jumpserver-object-query/scripts/jms_query.py object-list --resource domain

企业版 XPack

已内置支持：

  • /api/v1/xpack/license/detail → license-detail
  • 云同步、界面定制等路径已在 jms_version.py 的 XPACK_ENDPOINTS 中登记，可按需扩展 capability

已完成适配

项 状态
端点集中管理 jms_version.py 完成
网域路径 domains 完成
作业日志 job-logs 完成
账号自动化 capability 完成
XPack 许可证查询 完成
内置报表应用降级阻塞 完成

注册与接入

整体注册：将本仓库作为 skill 根目录。

单模块注册：直接注册某个子目录，例如 jumpserver-object-query/，使用其 SKILL.md 与 scripts/ 入口。

常见问题

Q: 用户说“网域”但参数写 zone？
A: CLI 同时接受 --resource domain 和 --resource zone，最终走 /api/v1/assets/domains/。

Q: 报表 capability 报错？
A: V3.10 LTS 无内置 reports 应用，请改用 inspect 或 audit 能力。

Q: 如何确认 XPack 是否可用？
A: 执行 license-detail 或 endpoint-verify --path /api/v1/xpack/license/detail。

Q: 如何确认当前面向哪个版本？
A: 查看 jms_version.py 的 TARGET_VERSION_LABEL 与各 SKILL.md 描述。