From 245b48776b96938143e9b04c24b614cdccefd496 Mon Sep 17 00:00:00 2001 From: clarinette9 Date: Tue, 7 Dec 2021 15:47:18 +0800 Subject: [PATCH 1/5] add changelog and upgrade.md for v0.0.2 Signed-off-by: clarinette9 --- CHANGELOG.md | 32 ++++++++++++++++++++ changelog/v0.0.2.md => docs/zh_cn/upgrade.md | 28 +++++++++++------ 2 files changed, 51 insertions(+), 9 deletions(-) create mode 100644 CHANGELOG.md rename changelog/v0.0.2.md => docs/zh_cn/upgrade.md (67%) diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..7ac4e1a --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,32 @@ + + +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/). + + +## [v0.0.2] - 2021-12-07 + +### Added +- Add document for Open API + +### Changed +- enhance authentication and authorization + +### Fixed + +- Fix mysql DDL issue due to NO_ZERO_DATE limitation (Issue #3) + + +## [v0.0.1] - 2021-10-19 + +### Added +- Initial released version + +[v0.0.2]: https://github.com/bfenetworks/api-server/compare/v0.0.1...v0.0.2 +[v0.0.1]: https://github.com/bfenetworks/api-server/releases/tag/v0.0.1 diff --git a/changelog/v0.0.2.md b/docs/zh_cn/upgrade.md similarity index 67% rename from changelog/v0.0.2.md rename to docs/zh_cn/upgrade.md index 5bb8e09..d5548e5 100644 --- a/changelog/v0.0.2.md +++ b/docs/zh_cn/upgrade.md @@ -1,10 +1,17 @@ -# Change -- add open api document -- enhance auth feature +# 升级指南 -# Upgrade Step +本文档描述如何从一个已经部署的早先的版本进行升级 + +## v0.0.2 + +### 升级路径 + +可以从如下版本升级至v0.0.2: + +- v0.0.1 + +### mysql 数据库表更新 -### mysql upgrade ``` ALTER TABLE users ADD COLUMN `type` tinyint(1) NOT NULL DEFAULT '0' AFTER name; ALTER TABLE users ADD COLUMN `scopes` varchar(2048) NOT NULL DEFAULT '' AFTER `type`; @@ -21,13 +28,16 @@ ALTER TABLE users DROP INDEX name_uni; ALTER TABLE users ADD UNIQUE KEY `name_uni` (`name`, `type`); ``` -# dashboard version -MUST > v0.0.1, please upgrade dashboard at the same time +### dashboard 版本升级 +请升级 Dashboard 到v0.02或更新的版本 -# conf-agent version -MUST >= v0.0.1. +### Conf-Agent 版本升级 +需要v0.0.1或更新版本的Conf-Agent. NOTICE: if you use conf-agent v0.0.1 already, please edit `conf/conf-agent.toml`, the Authorization Header has NOT Previously compatible modify: + +注意: 如果你使用v0.0.1版本的Conf-Agent, 请按如下方式编辑 `conf/conf-agent.toml`: + ``` # old: {"Authorization" = "Session {Token}"} From 4af24d40e635612a0c8c18f0a85c318a20331dd4 Mon Sep 17 00:00:00 2001 From: clarinette9 Date: Tue, 7 Dec 2021 15:51:30 +0800 Subject: [PATCH 2/5] add upgrade.md link to README.md Signed-off-by: clarinette9 --- docs/zh_cn/README.md | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/zh_cn/README.md b/docs/zh_cn/README.md index f7f4253..3bc5d8a 100644 --- a/docs/zh_cn/README.md +++ b/docs/zh_cn/README.md @@ -14,8 +14,14 @@ BFE控制面包含如下组件： # 快速开始 +## 部署 + 通过查看 [部署说明](/docs/zh_cn/deploy.md) 快速运行 API Server。 +## 升级 + +如果您需要从一个早先的版本升级到最新发布的版本，参考 [升级指南](/docs/zh_cn/upgrade.md) 。 + ## 快速体验 如果你想不搭建环境而想直接体验,我们也提供了环境: - 请发邮件给到 `bfe-osc@baidu.com`， 简单说明你和贵公司的名称。我们将为你创建专门的产品线和产品线管理员账号，你在 [控制面公开环境](http://180.76.139.37:8183) 登陆后即可开始体验 @@ -31,7 +37,7 @@ API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义 - [BFE控制面：Conf Agent](https://github.com/bfenetworks/conf-agent) -## 关于BFE +# 关于BFE - 官网：https://www.bfe-networks.net - 书籍：[《深入理解BFE》](https://github.com/baidu/bfe-book) ：介绍网络接入的相关技术原理，说明BFE的设计思想，以及如何基于BFE搭建现代化的网络接入平台。现已开放全文阅读。 - 如果你使用了BFE控制面或者数据面,欢迎[登记](https://github.com/bfenetworks/bfe/issues/748), 我们会邀请你进入BFE用户微信群。同时，您可获赠一本《深入理解BFE》。 From a30c4f63c4c1e0c27d5b702811eab5c2b87288a4 Mon Sep 17 00:00:00 2001 From: clarinette9 Date: Tue, 7 Dec 2021 15:54:50 +0800 Subject: [PATCH 3/5] minor document wording improve Signed-off-by: clarinette9 --- docs/zh_cn/upgrade.md | 12 +++++------- 1 file changed, 5 insertions(+), 7 deletions(-) diff --git a/docs/zh_cn/upgrade.md b/docs/zh_cn/upgrade.md index d5548e5..6e32c3d 100644 --- a/docs/zh_cn/upgrade.md +++ b/docs/zh_cn/upgrade.md @@ -1,6 +1,6 @@ # 升级指南 -本文档描述如何从一个已经部署的早先的版本进行升级 +本文档描述如何从一个已经部署的较早版本进行升级。 ## v0.0.2 @@ -28,15 +28,13 @@ ALTER TABLE users DROP INDEX name_uni; ALTER TABLE users ADD UNIQUE KEY `name_uni` (`name`, `type`); ``` -### dashboard 版本升级 -请升级 Dashboard 到v0.02或更新的版本 +### Dashboard 版本升级 +请升级 Dashboard 到 v0.02 或更新的版本。 ### Conf-Agent 版本升级 -需要v0.0.1或更新版本的Conf-Agent. +需要 v0.0.1 或更新版本的 Conf-Agent 。 -NOTICE: if you use conf-agent v0.0.1 already, please edit `conf/conf-agent.toml`, the Authorization Header has NOT Previously compatible modify: - -注意: 如果你使用v0.0.1版本的Conf-Agent, 请按如下方式编辑 `conf/conf-agent.toml`: +注意: 如果你使用 v0.0.1 版本的 Conf-Agent , 请按如下方式编辑 `conf/conf-agent.toml`: ``` # old: From 330585b71f4135f4aca11727a91015d3ccb555cb Mon Sep 17 00:00:00 2001 From: clarinette9 Date: Tue, 7 Dec 2021 16:41:45 +0800 Subject: [PATCH 4/5] improve upgrade.md Signed-off-by: clarinette9 --- docs/zh_cn/README.md | 8 ++++---- docs/zh_cn/upgrade.md | 16 +++++++++++----- 2 files changed, 15 insertions(+), 9 deletions(-) diff --git a/docs/zh_cn/README.md b/docs/zh_cn/README.md index 3bc5d8a..707d96c 100644 --- a/docs/zh_cn/README.md +++ b/docs/zh_cn/README.md @@ -1,7 +1,7 @@ API Server 是 BFE 控制面核心模块，完成配置的录入、存储和导出。 # 控制面组件 -![架构](/docs/zh_cn/assert/deploy_architecture.png) +![架构](./assert/deploy_architecture.png) 图1：控制面组件 @@ -16,11 +16,11 @@ BFE控制面包含如下组件： # 快速开始 ## 部署 -通过查看 [部署说明](/docs/zh_cn/deploy.md) 快速运行 API Server。 +通过查看 [部署说明](./deploy.md) 快速运行 API Server。 ## 升级 -如果您需要从一个早先的版本升级到最新发布的版本，参考 [升级指南](/docs/zh_cn/upgrade.md) 。 +如果需要从一个早先的版本升级到最新发布的版本，参考 [升级指南](./upgrade.md) 。 ## 快速体验 如果你想不搭建环境而想直接体验,我们也提供了环境: @@ -29,7 +29,7 @@ BFE控制面包含如下组件： # 二次开发 -API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义详见 [API 文档](docs/zh_cn/open_api/SUMMARY.md)。 +API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义详见 [API 文档](./open_api/SUMMARY.md)。 # 相关模块 - [BFE数据面：负载均衡器](https://github.com/bfenetworks/bfe) diff --git a/docs/zh_cn/upgrade.md b/docs/zh_cn/upgrade.md index 6e32c3d..65871e6 100644 --- a/docs/zh_cn/upgrade.md +++ b/docs/zh_cn/upgrade.md @@ -10,7 +10,11 @@ - v0.0.1 -### mysql 数据库表更新 +### 升级步骤 + +1. 获取 API Server 可执行程序，参考 [部署说明](./deploy.md) +2. 替换 Api-Server 的可执行程序 +3. mysql 数据库表结构更新 ``` ALTER TABLE users ADD COLUMN `type` tinyint(1) NOT NULL DEFAULT '0' AFTER name; @@ -28,13 +32,15 @@ ALTER TABLE users DROP INDEX name_uni; ALTER TABLE users ADD UNIQUE KEY `name_uni` (`name`, `type`); ``` -### Dashboard 版本升级 -请升级 Dashboard 到 v0.02 或更新的版本。 +3. Dashboard 版本升级 + +请升级 Dashboard 到 v0.0.2 版本。 + +4. Conf-Agent 版本升级 -### Conf-Agent 版本升级 需要 v0.0.1 或更新版本的 Conf-Agent 。 -注意: 如果你使用 v0.0.1 版本的 Conf-Agent , 请按如下方式编辑 `conf/conf-agent.toml`: +如果准备继续使用 v0.0.1 版本的 Conf-Agent , 请按如下方式编辑 `conf/conf-agent.toml`: ``` # old: From 05d6480736c4d4ad3b9b1b88bb59fba55b1a99ba Mon Sep 17 00:00:00 2001 From: clarinette9 <83874119+clarinette9@users.noreply.github.com> Date: Tue, 7 Dec 2021 17:48:41 +0800 Subject: [PATCH 5/5] fix links Signed-off-by: clarinette9 --- docs/zh_cn/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/zh_cn/README.md b/docs/zh_cn/README.md index 707d96c..3324f11 100644 --- a/docs/zh_cn/README.md +++ b/docs/zh_cn/README.md @@ -1,7 +1,7 @@ API Server 是 BFE 控制面核心模块，完成配置的录入、存储和导出。 # 控制面组件 -![架构](./assert/deploy_architecture.png) +![架构](/docs/zh_cn/assert/deploy_architecture.png) 图1：控制面组件 @@ -16,11 +16,11 @@ BFE控制面包含如下组件： # 快速开始 ## 部署 -通过查看 [部署说明](./deploy.md) 快速运行 API Server。 +通过查看 [部署说明](/docs/zh_cn/deploy.md) 快速运行 API Server。 ## 升级 -如果需要从一个早先的版本升级到最新发布的版本，参考 [升级指南](./upgrade.md) 。 +如果需要从一个早先的版本升级到最新发布的版本，参考 [升级指南](/docs/zh_cn/upgrade.md) 。 ## 快速体验 如果你想不搭建环境而想直接体验,我们也提供了环境: @@ -29,7 +29,7 @@ BFE控制面包含如下组件： # 二次开发 -API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义详见 [API 文档](./open_api/SUMMARY.md)。 +API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义详见 [API 文档](/docs/zh_cn/open_api/SUMMARY.md)。 # 相关模块 - [BFE数据面：负载均衡器](https://github.com/bfenetworks/bfe)