Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

release: new version 2.1.1 #959

Merged
merged 11 commits into from
Dec 11, 2020
36 changes: 32 additions & 4 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,42 @@

# Table of Contents

- [2.1.1](#211)
- [2.1.0](#210)
- [2.0.0](#200)
- [1.5.0](#150)
- [1.0.0](#100)


# 2.1.1

This release mainly adds test cases and bugfix for `Manager API`.

`Manager API` 2.1.1 should be used with APISIX 2.1. It is not recommended to use with other APISIX versions.

### Core

**The default port of `Manager API` is changed from 8080 to 9000.** [#931](https://github.com/apache/apisix-dashboard/pull/931)

### Test case

Add e2e test cases for route, upstream, consumer, SSL, and plugins.

## Bugfix

- Fix: when created route by `Admin API`, upstream can not be modified by dashboard. [#847](https://github.com/apache/apisix-dashboard/pull/847)
- Fix: create route with jwt-auth will display an error. [#878](https://github.com/apache/apisix-dashboard/pull/878)
- Fix: create route with error format remote_addrs `Manager API` will return 200, but should return 400. [#899](https://github.com/apache/apisix-dashboard/pull/899)
- Fix: make field ID compatible with both string and int. [#902](https://github.com/apache/apisix-dashboard/pull/902)
- Fix: can't run `Manager API` in intranet env. [#947](https://github.com/apache/apisix-dashboard/pull/947)
- Fix: create a route through the dashboard, without filling in the client address, APISIX reports errors. [#948](https://github.com/apache/apisix-dashboard/pull/948)
membphis marked this conversation as resolved.
Show resolved Hide resolved
- Fix: creates a route and enables redirect HTTPS on dashboard, and the browser reports an error when submitting. [#957](https://github.com/apache/apisix-dashboard/pull/957)

For more changes, please refer to [Milestone](https://github.com/apache/apisix-dashboard/milestone/8).

# 2.1.0

This release mainly adds test cases for manager-api.
This release mainly adds test cases for `Manager API`.

### Core

Expand All @@ -41,8 +69,8 @@ This release mainly refactors the dashboard, omitting MySQL, improve test cases.

### Core

- Refactor frontend with Admin-API.
- Manager-API removes dependency on MySQL.
- Refactor frontend with `Admin API`.
- `Manager API` removes dependency on MySQL.
- Support plugin orchestration.
- Setting standards for frontend internationalization.
- New deployment pattern.
Expand All @@ -65,7 +93,7 @@ This release mainly refactors the dashboard.
### Core

- Integrate with Ant Design Pro. [#263](https://github.com/apache/apisix-dashboard/pull/263)
- Added Manager API support to process logics between APISIX and Dashboard.
- Added `Manager API` support to process logics between APISIX and Dashboard.
- Added Metrics/Route/SSL/Upstream/Consumer module.

## 1.0.0
Expand Down
31 changes: 29 additions & 2 deletions CHANGELOG.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,14 +18,41 @@
-->

# 目录
- [2.1.1](#211)
- [2.1.0](#210)
- [2.0.0](#200)
- [1.5.0](#150)
- [1.0.0](#100)


# 2.1.1

该版本主要增加了对 `Manager API` 和 APISIX 间的 E2E 测试,以及 bug 修复。

`Manager API` 2.1.1 应该与 APISIX 2.1 配合使用,不推荐与其它 APISIX 版本使用。

### 核心

**`Manager API` 默认端口由 8080 变更为 9000** [#931](https://github.com/apache/apisix-dashboard/pull/931)

### 测试

为 route, upstream, consumer, SSL, 以及 plugins 增加 E2E 测试。

## Bugfix

- 修复通过 `Admin API` 创建路由后,在 dashboard 上无法修改上游信息。[#847](https://github.com/apache/apisix-dashboard/pull/847)
- 修复创建路由并开启 jwt-auth 插件,提交时会报错。[#878](https://github.com/apache/apisix-dashboard/pull/878)
- 修复创建路由时,`remote_addrs` 字段使用错误的数据格式,应该返回 400 而不是 200 。[#899](https://github.com/apache/apisix-dashboard/pull/899)
- 修复 ID 字段不能同时兼容 int 类型和 string 类型的问题。[#902](https://github.com/apache/apisix-dashboard/pull/902)
- 修复在内网环境下不能启动 `Manager API` 的问题。[#947](https://github.com/apache/apisix-dashboard/pull/947)
- 修复通过 dashboard 创建路由, 不填写客户端地址,APISIX 报错的问题。[#948](https://github.com/apache/apisix-dashboard/pull/948)
- 修复 dashboard 创建路由并开启强制跳转 HTTPS 功能,提交时浏览器报错。 [#957](https://github.com/apache/apisix-dashboard/pull/957)


# 2.1.0

该版本主要提升了 manager-api 的 E2E 测试。
该版本主要提升了 `Manager API` 的 E2E 测试。

### 核心

Expand Down Expand Up @@ -65,7 +92,7 @@
### 核心

- 使用 Ant Design Pro 作为项目脚手架 [#263](https://github.com/apache/apisix-dashboard/pull/263)。
- 增加了 manager-api 用于处理 APISIX 与 Dashboard 之间的逻辑。
- 增加了 `Manager API` 用于处理 APISIX 与 Dashboard 之间的逻辑。
- 增加了监控、路由、证书、上游、Consumer 模块。

## 1.0.0
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@ English | [简体中文](./README.zh-CN.md)

# Apache APISIX Dashboard (Currently considered experimental)

The latest version is 2.1.1 and should be used with APISIX 2.1. It is not recommended to use with other APISIX versions.

## What's Apache APISIX Dashboard

The Apache APISIX Dashboard is designed to make it as easy as possible for users to operate [Apache APISIX](https://github.com/apache/apisix) through a frontend interface.

The Dashboard is the control plane and performs all parameter checks; Apache APISIX mixes data and control planes and will evolve to a pure data plane.

This project includes `manager-api`, which will gradually replace `admin-api` in Apache APISIX.
This project includes `Manager API`, which will gradually replace `Admin API` in Apache APISIX.

Note: Currently the Dashboard does not have complete coverage of Apache APISIX features, [visit here](https://github.com/apache/apisix-dashboard/milestones) to view the milestones.

Expand All @@ -53,7 +55,7 @@ Note: Currently the Dashboard does not have complete coverage of Apache APISIX f
└── web
```

1. The `api` directory is used to store the `manager-api` source codes, which is used to manage `etcd` and provide APIs to the frontend interface.
1. The `api` directory is used to store the `Manager API` source codes, which is used to manage `etcd` and provide APIs to the frontend interface.
2. The `web` directory is used to store the frontend source codes.

## Build then launch
Expand Down
6 changes: 4 additions & 2 deletions README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,13 +21,15 @@

# Apache APISIX Dashboard

当前最新版本为 2.1.1 ,应该与 APISIX 2.1 配合使用,不推荐与其它 APISIX 版本使用。

## 介绍

Apache APISIX Dashboard 旨在通过前端界面,让用户尽可能更方便地操作 [Apache APISIX](https://github.com/apache/apisix)。

Dashboard 为控制平面,完成所有参数的校验;Apache APISIX 混合了数据平面与控制平面,会逐渐演进为纯粹的数据平面。

本项目包含了 `manager-api` 与前端界面,前者将逐渐替代 Apache APISIX 中的 `admin-api`,我们正在积极地迁移相关逻辑。
本项目包含了 `Manager API` 与前端界面,前者将逐渐替代 Apache APISIX 中的 `Admin API`,我们正在积极地迁移相关逻辑。

注意:目前 Dashboard 尚未完整覆盖 Apache APISIX 的功能,[访问此处](https://github.com/apache/apisix-dashboard/milestones)以查看里程碑。

Expand All @@ -53,7 +55,7 @@ Dashboard 为控制平面,完成所有参数的校验;Apache APISIX 混合
└── web
```

1. `api` 目录用于存放 `manager-api` 源码,它用于管理 `etcd` 并为前端界面提供接口。
1. `api` 目录用于存放 `Manager API` 源码,它用于管理 `etcd` 并为前端界面提供接口。
2. `web` 目录用于存放前端源码。

## 构建并启动
Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ Since the Dashboard caches the jsonschema data of the plugins in Apache APISIX,
2. Execute the following commands.

```sh
# `$version` is the version number of Apache APISIX, e.g. master or 2.0.
# `$version` is the version number of Apache APISIX, e.g. master or 2.1.1.
juzhiyuan marked this conversation as resolved.
Show resolved Hide resolved
$ api/build-tools/schema-sync.sh $version
```

Expand Down
2 changes: 1 addition & 1 deletion docs/FAQ.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
2. 执行如下命令:

```sh
# `$version` 为 `master` 或者 Apache APISIX 的版本号,如 2.0
# `$version` 为 `master` 或者 Apache APISIX 的版本号,如 2.1.1
$ api/build-tools/schema-sync.sh $version
```

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-with-docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ $ docker build -t apisix-dashboard:$tag .
$ docker build -t apisix-dashboard:$tag . --build-arg ENABLE_PROXY=true

# If you want to use the latest codes to build, you can specify the `APISIX_DASHBOARD_VERSION` parameter to `master`.
# This parameter can also be specified as branch name of a specific version, such as `v2.0`.
# This parameter can also be specified as branch name of a specific version, such as `v2.1.1`.
$ docker build -t apisix-dashboard:$tag . --build-arg APISIX_DASHBOARD_VERSION=master
```

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy-with-docker.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ $ docker build -t apisix-dashboard:$tag .
# 对于中国大陆的用户,可启用 `ENABLE_PROXY` 参数加快模块下载速度。
$ docker build -t apisix-dashboard:$tag . --build-arg ENABLE_PROXY=true

# 如果需要使用最新代码构建,可启用 `APISIX_DASHBOARD_VERSION` 参数指定为 `master` ,此参数也可以指定为其他版本的分支名,如 `v2.0` 。
# 如果需要使用最新代码构建,可启用 `APISIX_DASHBOARD_VERSION` 参数指定为 `master` ,此参数也可以指定为其他版本的分支名,如 `v2.1.1` 。
$ docker build -t apisix-dashboard:$tag . --build-arg APISIX_DASHBOARD_VERSION=master
```

Expand Down
2 changes: 1 addition & 1 deletion docs/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ $ go env -w GOPROXY=https://goproxy.cn,direct
## Clone the project

```sh
$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
$ git clone -b v2.1.1 https://github.com/apache/apisix-dashboard.git
```

## Build
Expand Down
2 changes: 1 addition & 1 deletion docs/deploy.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ $ go env -w GOPROXY=https://goproxy.cn,direct
## 克隆项目

```sh
$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
$ git clone -b v2.1.1 https://github.com/apache/apisix-dashboard.git
```

## 构建
Expand Down
2 changes: 1 addition & 1 deletion docs/develop.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Before development, refer to this [guide](./deploy.md) to install dependencies.
## Clone the project

```sh
$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
$ git clone -b v2.1.1 https://github.com/apache/apisix-dashboard.git
```

## Start developing
Expand Down
2 changes: 1 addition & 1 deletion docs/develop.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Dashboard 包含了 `manager-api` 与 `web` 两部分,因此需要分别启动
## 克隆项目

```sh
$ git clone -b v2.0 https://github.com/apache/apisix-dashboard.git
$ git clone -b v2.1.1 https://github.com/apache/apisix-dashboard.git
```

## 开始开发
Expand Down
2 changes: 1 addition & 1 deletion web/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "apisix-dashboard",
"version": "2.0.2",
"version": "2.1.1",
"private": true,
"description": "Dashboard for Apache APISIX",
"scripts": {
Expand Down