Skip to content

feat(apigw-manager): emit is_official in gateway definitions - #311

Draft
wklken wants to merge 3 commits into
TencentBlueKing:masterfrom
wklken:feat/apigw-manager-is-official-sync
Draft

wklken wants to merge 3 commits into
TencentBlueKing:masterfrom
wklken:feat/apigw-manager-is-official-sync

Conversation

@wklken

@wklken wklken commented Sep 23, 2026 •

Copy link
Copy Markdown
Collaborator

变更

  • apigw-manager 生成的 definition.yaml 使用布尔字段 apigateway.is_official。
  • 内置模板兼容现有 BK_APIGW_IS_OFFICIAL 数值设置(1/10)及布尔设置(True/False);新配置文档只示范布尔值。
  • 更新同步文档和示例,并修正 FAQ。
  • 模板测试覆盖四种设置值到 YAML 布尔值的映射。

依赖及顺序

  • 依赖 Dashboard 先支持新字段:Dashboard PR #3332。部署 Dashboard 兼容版本后再使用 SDK 新模板。
  • Dashboard 仍兼容旧 api_type;新字段优先。

验证

  • test_generate_definition_yaml.py:13 passed。
  • ruff format --check 与 git diff --check:通过。
  • ruff check:该测试文件有 10 条既有问题;在 master 原版文件上复现同样的 10 条,新增代码未增加告警。

本地镜像验证与适用范围

  • 从本 PR 提交 69dded9 构建基础镜像,安装后的 definition.yaml 与源码 SHA256 一致;镜像内渲染 1/10/True/False 均符合预期。
  • 基础镜像默认脚本读取外部 /data/definition.yaml,不调用该内置模板;demo 镜像也未注册 generate_definition_yaml 命令。自定义镜像示例仍继承 apigw-manager:3.1.1;如需设置官方网关,该示例需在提供的定义文件中声明 is_official。
  • 以上验证仅针对本地构建镜像,不代表已发布镜像。

@wklken
wklken marked this pull request as draft September 23, 2026 06:23
@wklken

wklken commented Sep 23, 2026

Copy link
Copy Markdown
Collaborator Author

网关 1.25 发布到全部环境后,再合并出新的 apigw-manager sdk

@wklken
wklken requested a review from cszmzh September 23, 2026 06:24
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.

1 participant