alex-smile
alex-smile
## 变更点(Changes) - 项目由 python2 升级到支持 python3
### Description ## 0. 预准备：values.yaml 1.10.x 新版本增加了 ETCD 依赖，请提前准备。 更新 values： - [必须] 将 etcd 信息配置到 externalEtcd 中； - [必须] 配置 defaultMicroGatewayInstanceId：一个 uuid 字符串，创建后不能修改 - [推荐] 在 bkrepo 中创建名为 `bk_apigateway`...
## 背景 蓝鲸认证信息，是用于标识蓝鲸应用和用户的数据；调用者访问接入蓝鲸 API 网关的云 API 接口时，如果云 API 接口需要认证应用或用户，则请求时需要携带这些认证信息，才能正常发起请求。 目前，API 网关支持 2 种传递认证信息的方案： - 方案一： 认证数据与请求参数放在一起，如放在 querystring、body 中 （不推荐） - 方案二： 认证数据放在请求头 `X-Bkapi-Authorization` 中 （`推荐`） 采用方案一时，API 网关需要处理额外的任务，包括解析 querystring 和多种格式的 body（如...
### Description 目前 API 网关支持的组件中，组件系统 JOB、NODEMAN 等官方组件，以配置类组件方案维护组件配置。系统方如 JOB，维护组件的 yaml 配置，交付给 API 网关管理员，API 网关管理员将其打包发布。 在配置类组件 API 的测试阶段，为了更快地更新、测试组件 API，也可手动更新配置类组件，不需要 API 网关打包发布。 ## 容器化版本 1. 准备待更新的组件 yaml 配置 2. 将 yaml 拷贝到 esb...
### Description 网关管理端 dashboard 模块，需要用到 celery 后台任务，其默认使用 redis 作为 celery broker，但是此方案有一些缺点： - 1. 多个部署实例如果共用了 redis，可能导致 celery 任务被错误调度 - 2. 不太可靠，没有机制保证消息的消费，消费者消费失败时候，消息体丢失 - 3. 无法保证顺序，redis 无法保证任务执行的顺序，可能会导致任务之间的依赖关系出现问题 对于开发环境，可使用默认的 redis，比较简单；但对于生产环境，推荐使用 RabbitMQ。网关在 >= 1.12.1 版本，支持配置外部的...
### Description 本文档介绍，调用 API 后，如何查询请求的日志记录。容器化及二进制版本，网关都提供了对应的 API 请求日志采集功能，开启后，可采集及查询 API 请求日志记录。 ## 容器化版本 ### 网关 API #### 1. 如何启用网关 API 的日志采集 第一步：chart values.yaml 中，通过 apigateway.bkLogConfig 配置是否启用日志采集，及日志上报数据ID；将 enabled 设置为 true，并在日志平台 bklog "管理" ->...
### Description 不同的版本，有不同的处理方案。先获取服务版本号（容器化 chart version，二进制 app version），再根据版本号找对应的方案进行处理。 ## 容器化版本 - 1. chart README.md 常见问题中，`2. 如何导入自定义编码组件` 部分有介绍，请参考，将组件代码添加到容器 - 2. 在网关管理端 -> 组件管理中，新建组件 ## 二进制版本（新版二进制版本，将默认使用旧版 open-paas/esb 服务，请检查链路确认） 在 ESB 项目的 `components/generic/apis` 目录下，将组件代码...