Skip to content

Commit

Permalink
docs: update web interface to latest (#4935)
Browse files Browse the repository at this point in the history
  • Loading branch information
okaybase authored Sep 1, 2021
1 parent a062a9c commit b7c1b5e
Show file tree
Hide file tree
Showing 27 changed files with 22 additions and 56 deletions.
Binary file modified docs/assets/images/plugin/basic-auth-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified docs/assets/images/plugin/limit-conn-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/plugin/limit-conn-2.png
Binary file not shown.
Binary file modified docs/assets/images/plugin/limit-count-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/plugin/limit-count-2.png
Binary file not shown.
Binary file modified docs/assets/images/plugin/limit-req-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/plugin/limit-req-2.png
Binary file not shown.
Binary file modified docs/assets/images/plugin/skywalking-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/plugin/skywalking-2.png
Binary file not shown.
Binary file modified docs/assets/images/plugin/zipkin-1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/assets/images/plugin/zipkin-2.png
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/basic-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```

you can visit Dashboard `http://127.0.0.1:9080/apisix/dashboard/` and add a Consumer through the web console:
you also can add a Consumer through the web console:

![auth-1](../../../assets/images/plugin/basic-auth-1.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/key-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```

You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
You also can complete the above operation through the web interface, first add a route:
![](../../../assets/images/plugin/key-auth-1.png)

Then add key-auth plugin:
Expand Down
5 changes: 1 addition & 4 deletions docs/en/latest/plugins/limit-conn.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,12 +77,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```

You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
You also can complete the above operation through the web interface, first add a route, then add limit-conn plugin:
![](../../../assets/images/plugin/limit-conn-1.png)

Then add limit-conn plugin:
![](../../../assets/images/plugin/limit-conn-2.png)

## Test Plugin

The parameters of the plugin enabled above indicate that only one concurrent request is allowed. When more than one concurrent request is received, will return `503` directly.
Expand Down
7 changes: 2 additions & 5 deletions docs/en/latest/plugins/limit-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -80,11 +80,8 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
}'
```

You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
![Add a router.](../../../assets/images/plugin/limit-count-1.png)

Then add limit-count plugin:
![Add limit-count plugin.](../../../assets/images/plugin/limit-count-2.png)
You also can complete the above operation through the web interface, first add a route, then add limit-count plugin:
![Add limit-count plugin.](../../../assets/images/plugin/limit-count-1.png)

If you need a cluster-level precision traffic limit, then we can do it with the redis server. The rate limit of the traffic will be shared between different APISIX nodes to limit the rate of cluster traffic.

Expand Down
9 changes: 2 additions & 7 deletions docs/en/latest/plugins/limit-req.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,8 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```

You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:

![add route](../../../assets/images/plugin/limit-req-1.png)

Then add limit-req plugin:

![add plugin](../../../assets/images/plugin/limit-req-2.png)
You also can complete the above operation through the web interface, first add a route, then add limit-req plugin:
![add plugin](../../../assets/images/plugin/limit-req-1.png)

**Test Plugin**

Expand Down
7 changes: 3 additions & 4 deletions docs/en/latest/plugins/skywalking.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,10 +78,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```

You can open dashboard with a browser:`http://127.0.0.1:9080/apisix/dashboard/`,to complete the above operation through the web interface, first add a route:\
![ ](../../../assets/images/plugin/skywalking-1.png)\
Then add skywalking plugin:\
![ ](../../../assets/images/plugin/skywalking-2.png)
You also can complete the above operation through the web interface, first add a route, then add skywalking plugin:

![ ](../../../assets/images/plugin/skywalking-1.png)

## How to set endpoint

Expand Down
2 changes: 1 addition & 1 deletion docs/en/latest/plugins/wolf-rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f
}'
```

You can visit the dashboard: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operations through the web interface, first add a consumer:
You also can complete the above operations through the web interface, first add a consumer:
![](../../../assets/images/plugin/wolf-rbac-1.png)

Then add the wolf-rbac plugin to the consumer page:
Expand Down
6 changes: 1 addition & 5 deletions docs/en/latest/plugins/zipkin.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,10 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```

You can open dashboard with a browser: `http://127.0.0.1:9080/apisix/dashboard/`, to complete the above operation through the web interface, first add a route:
You also can complete the above operation through the web interface, first add a route, then add zipkin plugin:

![](../../../assets/images/plugin/zipkin-1.png)

Then add zipkin plugin:

![](../../../assets/images/plugin/zipkin-2.png)

## Test Plugin

### run the Zipkin instance
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/plugins/basic-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 consumer:
你也可以通过 web 界面来完成上面的操作,先增加一个 consumer:

![auth-1](../../../assets/images/plugin/basic-auth-1.png)

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/plugins/key-auth.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f1
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 consumer:
你也可以通过 web 界面来完成上面的操作,先增加一个 consumer:
![](../../../assets/images/plugin/key-auth-1.png)

然后在 consumer 页面中添加 key-auth 插件:
Expand Down
5 changes: 1 addition & 4 deletions docs/zh/latest/plugins/limit-conn.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 route:
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 limit-conn 插件
![](../../../assets/images/plugin/limit-conn-1.png)

然后在 route 页面中添加 limit-conn 插件:
![](../../../assets/images/plugin/limit-conn-2.png)

#### test plugin

上面启用的插件的参数表示只允许一个并发请求。 当收到多个并发请求时,将直接返回 503 拒绝请求。
Expand Down
7 changes: 2 additions & 5 deletions docs/zh/latest/plugins/limit-count.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,11 +85,8 @@ curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 route:
![添加路由](../../../assets/images/plugin/limit-count-1.png)

然后在 route 页面中添加 limit-count 插件:
![添加插件](../../../assets/images/plugin/limit-count-2.png)
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 limit-count 插件:
![添加插件](../../../assets/images/plugin/limit-count-1.png)

如果你需要一个集群级别的流量控制,我们可以借助 redis server 来完成。不同的 APISIX 节点之间将共享流量限速结果,实现集群流量限速。

Expand Down
8 changes: 2 additions & 6 deletions docs/zh/latest/plugins/limit-req.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,13 +76,9 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 route:
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 limit-req 插件

![添加路由](../../../assets/images/plugin/limit-req-1.png)

然后在 route 页面中添加 limit-req 插件:

![添加插件](../../../assets/images/plugin/limit-req-2.png)
![添加插件](../../../assets/images/plugin/limit-req-1.png)

**测试插件**

Expand Down
6 changes: 1 addition & 5 deletions docs/zh/latest/plugins/skywalking.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,14 +79,10 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 route:
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 skywalking 插件

![plugin_skywalking](../../../assets/images/plugin/skywalking-1.png)

然后在 route 页面中添加 skywalking 插件:

![plugin_skywalking](../../../assets/images/plugin/skywalking-2.png)

## 如何设置 endpoint

我们可以通过指定 `conf/config.yaml` 中的配置来指定 endpoint:
Expand Down
2 changes: 1 addition & 1 deletion docs/zh/latest/plugins/wolf-rbac.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,7 +81,7 @@ curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 consumer:
你也可以通过 web 界面来完成上面的操作,先增加一个 consumer:
![](../../../assets/images/plugin/wolf-rbac-1.png)

然后在 consumer 页面中添加 wolf-rbac 插件:
Expand Down
6 changes: 1 addition & 5 deletions docs/zh/latest/plugins/zipkin.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,14 +93,10 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f1
}'
```

你可以使用浏览器打开 dashboard:`http://127.0.0.1:9080/apisix/dashboard/`,通过 web 界面来完成上面的操作,先增加一个 route:
你也可以通过 web 界面来完成上面的操作,先增加一个 route,然后在插件页面中添加 zipkin 插件

![](../../../assets/images/plugin/zipkin-1.png)

然后在 route 页面中添加 zipkin 插件:

![](../../../assets/images/plugin/zipkin-2.png)

## 测试插件

### 运行 Zipkin 实例
Expand Down

0 comments on commit b7c1b5e

Please sign in to comment.