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
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,13 +27,15 @@
<a href="https://twitter.com/apacheapisix">Twitter</a>
</p>

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 @@ -57,7 +59,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
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.
$ 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.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/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 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