docs:update docs

pull/15/head
SkyeBeFreeman 3 years ago
parent 6138b094c2
commit 105887d0c4

@ -15,7 +15,7 @@ Spring Cloud Tencent包含了分布式应用微服务开发过程中所需的组
* **服务注册与发现**:基于 Spring Cloud Common的标准进行微服务的注册与发现。 * **服务注册与发现**:基于 Spring Cloud Common的标准进行微服务的注册与发现。
* **服务路由与负载均衡**:基于 Ribbon 的接口标准,提供场景更丰富的动态路由以及负载均衡的能力。 * **服务路由与负载均衡**:基于 Ribbon 的接口标准,提供场景更丰富的动态路由以及负载均衡的能力。
* **故障节点熔断**:提供故障节点的熔断剔除以及主/被动探测恢复的能力,保证分布式服务的可靠性。 * **故障节点熔断**:提供故障节点的熔断剔除以及主/被动探测恢复的能力,保证分布式服务的可靠性。
* **服务限流**:支持工作于微服务被调接入层的限流功能,保证后台微服务稳定性,可通过控制台动态配置规则,及查看流量监控数据。 * **服务限流**:支持微服务被调接入层和网关主动调用的限流功能,保证后台微服务稳定性,可通过控制台动态配置规则,及查看流量监控数据。
* **元数据传递**:支持网关和微服务之间的元数据传递。 * **元数据传递**:支持网关和微服务之间的元数据传递。
## 组件 ## 组件

@ -15,8 +15,8 @@ Based on Spring Cloud Tencent, you only need a small configuration to launch Spr
* **Service Registration and Discovery**: Based on Spring Cloud's discovery and registration standard. * **Service Registration and Discovery**: Based on Spring Cloud's discovery and registration standard.
* **Service Routing and LoadBalancer**: Based on ribbon's API port, provide dynamic routing and load balancing use cases. * **Service Routing and LoadBalancer**: Based on ribbon's API port, provide dynamic routing and load balancing use cases.
* **CircuitBreaker Node**: Support circuitbreak's auto-reset ability, ensure the reliability of distributed server * **CircuitBreaker Node**: Support circuitbreaker auto-reset ability, ensure the reliability of distributed server
* **Rate Limiter**: Support rate limit between microservice and access layer, ensure the stability of backend, one can configure policies and traffic data from the control panel * **Rate Limiter**: Support rate limit of microservice and gateway, ensure the stability of backend, one can configure policies and traffic data from the control panel
* **Metadata Delivery**: Support metadata delivery between gateways and microservices. * **Metadata Delivery**: Support metadata delivery between gateways and microservices.
## Components ## Components

@ -11,6 +11,10 @@
支持网关和微服务之间的元数据传递。 支持网关和微服务之间的元数据传递。
### 网关限流
支持网关转发对应微服务过程的服务限流。
## 快速入门 ## 快速入门
本章节将介绍如何最简单地在Spring Cloud项目中使用Spring Cloud Tencent Polaris Gateway的功能。 本章节将介绍如何最简单地在Spring Cloud项目中使用Spring Cloud Tencent Polaris Gateway的功能。
@ -33,3 +37,7 @@
### 元数据传递 ### 元数据传递
其依赖的是```spring-cloud-tencent-metadata```模块的功能,因此使用上参考[Spring Cloud Tencent Metadata](spring-cloud-tencent-metadata.md)即可。 其依赖的是```spring-cloud-tencent-metadata```模块的功能,因此使用上参考[Spring Cloud Tencent Metadata](spring-cloud-tencent-metadata.md)即可。
### 网关限流
其依赖的是```spring-cloud-starter-tencent-polaris-ratelimit```模块的功能,因此使用上参考[Polaris RateLimit](spring-cloud-tencent-polaris-ratelimit.md)即可。

@ -12,6 +12,10 @@ You can use Polaris's extension microservice gateway features by importing depen
Support metadata delivery between gateways and microservices. Support metadata delivery between gateways and microservices.
### Gateway RateLimit
Support rate limit of gateway routing to the corresponding micro-service.
## User Guide ## User Guide
This chapter will explain how to use Spring Cloud Tencent Polaris Gateway's features in the Spring Cloud project. This chapter will explain how to use Spring Cloud Tencent Polaris Gateway's features in the Spring Cloud project.
@ -29,4 +33,15 @@ For example, in Maven's project, add listed configurations in pom:
</dependency> </dependency>
``` ```
2. For further instructions, please refer to [Polaris Gateway Example](../../../../spring-cloud-tencent-examples/polaris-gateway-example/README.md)。. 2. For further instructions, please refer to [Polaris Gateway Example](../../../../spring-cloud-tencent-examples/polaris-gateway-example/README.md).
## Feature Usage
### Metadata Delivery
Because making use of ```spring-cloud-tencent-metadata```, please refer to [Spring Cloud Tencent Metadata](spring-cloud-tencent-metadata.md).
### Gateway RateLimit
Because making use of ```spring-cloud-starter-tencent-polaris-ratelimit```, please refer to [Spring Cloud Tencent Metadata](spring-cloud-tencent-polaris-ratelimit.md).

@ -75,3 +75,6 @@ curl -L -X GET 'http://localhost:48083/GatewayCalleeService/gateway/example/call
{"a":"1","b":2} {"a":"1","b":2}
``` ```
#### 网关限流
参考[Polaris RateLimit Example](../polaris-ratelimit-example/README-zh.md)

@ -75,3 +75,7 @@ Expected return rate
{"a":"1","b":2} {"a":"1","b":2}
``` ```
#### Gateway Rate Limit
See [Polaris RateLimit Example](../polaris-ratelimit-example/README.md)

Loading…
Cancel
Save