modulepackage
0.0.2
Repository: https://github.com/bfenetworks/api-server.git
Documentation: pkg.go.dev
# README
API Server 是 BFE 控制面核心模块,完成配置的录入、存储和导出。
控制面组件
图1:控制面组件
BFE控制面包含如下组件:
- API Server: 对外提供Open API接口,完成BFE配置的变更、存储和下发
- Dashboard: 管理控制台,用于BFE集群的可视化管理
- 仓库地址在 bfenetwork/dashboard
- Conf Agent: 配置加载组件,完成最新配置的获取和 BFE 热加载的触发
- 仓库地址在 bfenetwork/conf-agent
快速开始
部署
通过查看 部署说明 快速运行 API Server。
升级
如果需要从一个早先的版本升级到最新发布的版本,参考 升级指南 。
快速体验
如果你想不搭建环境而想直接体验,我们也提供了环境:
- 请发邮件给到
[email protected]
, 简单说明你和贵公司的名称。我们将为你创建专门的产品线和产品线管理员账号,你在 控制面公开环境 登陆后即可开始体验 - 你可以在 配置动态生成结果 页面看到你的配置动态生成的配置文件
二次开发
API Sever 提供 OpenAPI 供第三方程序和 API Server 集成,接口定义详见 API 文档。
相关模块
关于BFE
- 官网:https://www.bfe-networks.net
- 书籍:《深入理解BFE》 :介绍网络接入的相关技术原理,说明BFE的设计思想,以及如何基于BFE搭建现代化的网络接入平台。现已开放全文阅读。
- 如果你使用了BFE控制面或者数据面,欢迎登记, 我们会邀请你进入BFE用户微信群。同时,您可获赠一本《深入理解BFE》。