Skip to content

feat: 优化管理员用户名随机化配置,支持多租户模式 #9999 - #1036

Merged
dengyh merged 1 commit into
TencentBlueKing:masterfrom
steven-changs:feature/admin-randomization
Nov 19, 2026
Merged

dengyh merged 1 commit into
TencentBlueKing:masterfrom
steven-changs:feature/admin-randomization

Conversation

@steven-changs

Copy link
Copy Markdown
Collaborator

基于 SOPS 改动思路的增量修复:

核心改进:

  • env.py: 根据 ENABLE_MULTI_TENANT_MODE 动态设置默认值
    • 多租户模式:默认 bk_admin
    • 单租户模式:默认 admin
    • 移动 BK_ADMIN_USERNAME 定义到 ENABLE_MULTI_TENANT_MODE 之后,避免未定义错误
  • config/default.py: 新增 SYSTEM_USE_API_ACCOUNT 配置
  • module_settings.py: 新增 SYSTEM_USE_API_ACCOUNT 配置

使用情况:

  • BK_ADMIN_USERNAME: 11处使用(2处配置 + 9处业务代码通过 get_admin_username())
    • INIT_SUPERUSER: 初始化超级用户
    • BK_APIGW_MANAGER_MAINTAINERS: API网关维护者
    • migrate_itsm_workflow: ITSM租户初始化
    • plugin_schema_service: 插件Schema查询(4处)
    • plugin_resolver: A2Flow流程解析(3处)
    • open_plugin_catalog: 开放插件目录同步
  • SYSTEM_USE_API_ACCOUNT: 0处使用(预留配置,参考SOPS标准)

测试验证:

  • ✅ 单租户 + 未配置 → admin
  • ✅ 多租户 + 未配置 → bk_admin
  • ✅ 单租户 + 配置随机化 → 使用配置值
  • ✅ 多租户 + 已配置 → 使用配置值
  • ✅ 环境变量优先级测试通过(BK_ADMIN_USERNAME > bkAdminUsername > 默认值)

@tencentblueking-adm

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


gys_stevenchangs_pmc seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions

github-actions Bot commented Nov 19, 2026 •

Copy link
Copy Markdown

🔎 AI 代码审查

📌 5a73c67ae379 · 🧪 未执行测试

Warning

⚠️ 有 2 项问题需要处理或确认

请优先查看下方待处理问题。

🆕 新增 🔴 仍存在 ✅ 已修复 ❔ 待确认
1 1 0 0

🚩 待处理问题

🔴 P1 · 删除 BK_ADMIN_USERNAME 大写环境变量支持,管理员/超级用户/网关维护人身份被静默替换

📍 env.py:378 · 🏷️ F-eee6e371ebd4 · 🆕 新增

本次改动删除了对 `BK_ADMIN_USERNAME`(大写 UPPER_SNAKE_CASE)环境变量的读取。旧实现 `os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin")` 将其作为最高优先级兼容配置(原注释明确写着『同时支持 BK_ADMIN_USERNAME(优先级更高)』),且 `bkflow/utils/admin.py` 的 `get_admin_username` 文档仍把 `BK_ADMIN_USERNAME` 列为优先级 1。新实现 `os.getenv("bkAdminUsername", ...)` 只读取 `bkAdminUsername`。触发条件:部署通过 `BK_ADMIN_USERNAME` 指定系统管理员而不同时设置 `bkAdminUsername`。调用链:env.py:378 → config/default.py:421 `INIT_SUPERUSER = [env.BK_ADMIN_USERNAME]` 初始超级用户回退为默认 `admin`/`bk_admin`;env.py:381 `BK_APIGW_MANAGER_MAINTAINERS` 回退到错误维护人;`bkflow/utils/admin.py` 的 `get_admin_username()` 返回错误值,并被 `plugin_schema_service.py`、`open_plugin_catalog.py`、`plugin_resolver.py` 用作创建插件记录时的操作者 `username`。影响:管理员/初始超级用户/网关维护人/插件操作者身份被静默替换,与运维配置不一致,且 admin.py 文档与实现矛盾,属于破坏性兼容回归。最小修复:恢复大写变量并保留优先级,如 `os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "bk_admin" if ENABLE_MULTI_TENANT_MODE else "admin")`,并同步保持 admin.py 文档一致。

🔴 仍存在 · BK_ADMIN_USERNAME 空字符串不再回退,可能产生空管理员用户名

📍 env.py:378 · 🏷️ F-4c61b79bff14 · P2

复核当前快照 env.py:378。原问题的空串回退路径(`os.getenv("BK_ADMIN_USERNAME", ...)`)已不存在,因为该行现在完全不读取 `BK_ADMIN_USERNAME` 环境变量,只读取 `bkAdminUsername`。但这不是真正的修复:管理员用户名解析仍会出错——依赖大写 `BK_ADMIN_USERNAME`(旧实现最高优先级、admin.py 文档仍列为优先级 1)的部署现在被静默忽略并回退到 `admin`/`bk_admin`,属于更严重的回归;同时 `os.getenv("bkAdminUsername", ...)` 对空串仍不回退。因此该问题仍存在(形态变为完全丢弃大写变量),维持 open。

🧩 当前代码证据

env.py:378

BK_ADMIN_USERNAME = os.getenv("bkAdminUsername", "bk_admin" if ENABLE_MULTI_TENANT_MODE else "admin")

📎 审查边界

1) 本轮仅做静态审查,未运行任何测试/构建/迁移;`frontend/package-lock.json`、`flow.js`、`api-resources.yml`、`apigw-docs.zip` 等文件被过滤,无法核对前端/网关资源同步。2) 新增的 `SYSTEM_USE_API_ACCOUNT` 在 config/default.py:427 与 module_settings.py:142 定义,但全仓 grep 未发现任何消费方,疑似为后续功能预留的空配置;因无触发条件与运行时影响,未单列为 P1/P2 finding,请确认配套消费代码是否在后续提交。3) 未执行 MySQL 事务、真实引擎、网关身份等外部验收,身份与权限影响结论基于静态调用链。4) 本 PR 未改动测试,`tests/utils/test_admin.py` 仍用 override_settings 直接设置 settings.BK_ADMIN_USERNAME,未覆盖 env.py 的环境变量解析逻辑,现有单测无法发现上述回归。

📋 审查范围与验证说明

仅辅助人工审查;未执行测试,也不代表已满足合入或发布条件。

快照过滤了 13 个大文件、链接或工具配置文件;diff 仍包含其修改。


💡 本报告辅助人工审查,结论绑定上述提交。

基于 SOPS 改动思路的增量修复:

核心改进:
- env.py: 根据 ENABLE_MULTI_TENANT_MODE 动态设置默认值
  * 多租户模式:默认 bk_admin
  * 单租户模式:默认 admin
  * 移动 BK_ADMIN_USERNAME 定义到 ENABLE_MULTI_TENANT_MODE 之后,避免未定义错误
- config/default.py: 新增 SYSTEM_USE_API_ACCOUNT 配置
- module_settings.py: 新增 SYSTEM_USE_API_ACCOUNT 配置

使用情况:
- BK_ADMIN_USERNAME: 11处使用(2处配置 + 9处业务代码通过 get_admin_username())
  * INIT_SUPERUSER: 初始化超级用户
  * BK_APIGW_MANAGER_MAINTAINERS: API网关维护者
  * migrate_itsm_workflow: ITSM租户初始化
  * plugin_schema_service: 插件Schema查询(4处)
  * plugin_resolver: A2Flow流程解析(3处)
  * open_plugin_catalog: 开放插件目录同步
- SYSTEM_USE_API_ACCOUNT: 0处使用(预留配置,参考SOPS标准)

测试验证:
- ✅ 单租户 + 未配置 → admin
- ✅ 多租户 + 未配置 → bk_admin
- ✅ 单租户 + 配置随机化 → 使用配置值
- ✅ 多租户 + 已配置 → 使用配置值
- ✅ 环境变量优先级测试通过(BK_ADMIN_USERNAME > bkAdminUsername > 默认值)
@steven-changs
steven-changs force-pushed the feature/admin-randomization branch from 11aa73f to 5a73c67 Compare November 19, 2026 07:13
@github-actions

Copy link
Copy Markdown

🔁 AI 代码审查复核

📌 5a73c67ae379 · 🧪 未执行测试

对上轮审查的逐项回复:

🔴 仍存在 · BK_ADMIN_USERNAME 空字符串不再回退,可能产生空管理员用户名

📍 env.py:378 · 🏷️ F-4c61b79bff14 · P2

复核当前快照 env.py:378。原问题的空串回退路径(`os.getenv("BK_ADMIN_USERNAME", ...)`)已不存在,因为该行现在完全不读取 `BK_ADMIN_USERNAME` 环境变量,只读取 `bkAdminUsername`。但这不是真正的修复:管理员用户名解析仍会出错——依赖大写 `BK_ADMIN_USERNAME`(旧实现最高优先级、admin.py 文档仍列为优先级 1)的部署现在被静默忽略并回退到 `admin`/`bk_admin`,属于更严重的回归;同时 `os.getenv("bkAdminUsername", ...)` 对空串仍不回退。因此该问题仍存在(形态变为完全丢弃大写变量),维持 open。

🧩 当前代码证据

env.py:378

BK_ADMIN_USERNAME = os.getenv("bkAdminUsername", "bk_admin" if ENABLE_MULTI_TENANT_MODE else "admin")

以上为静态代码复核,未运行测试;无法确认项继续保留,不自动关闭讨论。

@dengyh
dengyh merged commit f50a0f9 into TencentBlueKing:master Nov 19, 2026
9 of 10 checks passed
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.62%. Comparing base (a50bac4) to head (5a73c67).
⚠️ Report is 11 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1036      +/-   ##
==========================================
- Coverage   86.62%   86.62%   -0.01%     
==========================================
  Files         374      374              
  Lines       25211    25213       +2     
==========================================
+ Hits        21839    21840       +1     
- Misses       3372     3373       +1     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants