Merge pull request #6 from clarinette9/develop

add changelog and upgrade.md for v0.0.2

CHANGELOG.md

@@ -0,0 +1,32 @@
+<!--
+This changelog should always be read on `master` branch. Its contents on other branches
+does not necessarily reflect the changes.
+-->
+
+# 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

docs/zh_cn/README.md

@@ -14,24 +14,30 @@ BFE控制面包含如下组件：
 
 
 # 快速开始
+## 部署
+
 通过查看 [部署说明](/docs/zh_cn/deploy.md) 快速运行 API Server。
 
+## 升级
+
+如果需要从一个早先的版本升级到最新发布的版本，参考 [升级指南](/docs/zh_cn/upgrade.md) 。
+
 ## 快速体验
 如果你想不搭建环境而想直接体验,我们也提供了环境:
 - 请发邮件给到 `bfe-osc@baidu.com`， 简单说明你和贵公司的名称。我们将为你创建专门的产品线和产品线管理员账号，你在 [控制面公开环境](http://180.76.139.37:8183) 登陆后即可开始体验
 - 你可以在 [配置动态生成结果](http://180.76.139.37:8420/conf/) 页面看到你的配置动态生成的配置文件
 
 
 # 二次开发
-API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义详见 [API 文档](docs/zh_cn/open_api/SUMMARY.md)。
+API Sever 提供 OpenAPI 供第三方程序和 API Server 集成，接口定义详见 [API 文档](/docs/zh_cn/open_api/SUMMARY.md)。
 
 # 相关模块
 - [BFE数据面：负载均衡器](https://github.com/bfenetworks/bfe)
 - [BFE控制面：控制台](https://github.com/bfenetworks/dashboard)
 - [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》。

changelog/v0.0.2.md → docs/zh_cn/upgrade.md

@@ -1,10 +1,21 @@
-# Change
-- add open api document
-- enhance auth feature
+# 升级指南
 
-# Upgrade Step
+本文档描述如何从一个已经部署的较早版本进行升级。
+
+## v0.0.2
+
+### 升级路径
+
+可以从如下版本升级至v0.0.2:
+
+- v0.0.1
+
+### 升级步骤
+
+1. 获取 API Server 可执行程序，参考 [部署说明](./deploy.md) 
+2. 替换 Api-Server 的可执行程序
+3. 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 +32,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
+3. Dashboard 版本升级
+
+请升级 Dashboard 到 v0.0.2 版本。
+
+4. Conf-Agent 版本升级
+
+需要 v0.0.1 或更新版本的 Conf-Agent 。
 
-# conf-agent version
-MUST >= v0.0.1.
+如果准备继续使用 v0.0.1 版本的 Conf-Agent , 请按如下方式编辑 `conf/conf-agent.toml`:
 
-NOTICE: if you use conf-agent v0.0.1 already, please edit `conf/conf-agent.toml`, the Authorization Header has NOT Previously compatible modify:
 ```
 # old:
 {"Authorization" = "Session {Token}"}