WillemJiang closed pull request #84: replace 'cse' to 'servicecomb' URL: https://github.com/apache/incubator-servicecomb-website/pull/84
This is a PR merged from a forked repository. As GitHub hides the original diff on merge, it is displayed below for the sake of provenance: As this is a foreign pull request (from a fork), the diff is supplied below (as it won't show otherwise due to GitHub magic): diff --git a/_docs/cn/distributed-tracing.md b/_docs/cn/distributed-tracing.md index 3ecec28..20281b9 100644 --- a/_docs/cn/distributed-tracing.md +++ b/_docs/cn/distributed-tracing.md @@ -28,7 +28,7 @@ last_modified_at: 2017-09-03T10:01:43-04:00 2. 在 *体质指数计算器* 的 `microservice.yaml` 文件中添加分布式追踪的处理链: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_docs/cn/flow-control.md b/_docs/cn/flow-control.md index d607b6a..d19c60c 100644 --- a/_docs/cn/flow-control.md +++ b/_docs/cn/flow-control.md @@ -28,7 +28,7 @@ last_modified_at: 2017-09-03T10:01:43-04:00 2. 在 *体质指数计算器* 的 `microservice.yaml` 文件中指明使用流量控制的处理链及指定流控策略: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_docs/cn/quick-start-bmi.md b/_docs/cn/quick-start-bmi.md index 594e192..1882ee5 100644 --- a/_docs/cn/quick-start-bmi.md +++ b/_docs/cn/quick-start-bmi.md @@ -116,7 +116,7 @@ APPLICATION_ID: bmi service_description: name: calculator version: 0.0.1 -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 @@ -189,7 +189,7 @@ APPLICATION_ID: bmi service_description: name: gateway version: 0.0.1 -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 diff --git a/_docs/cn/quick-start-dataconsistency.md b/_docs/cn/quick-start-dataconsistency.md index d333859..c378ec6 100644 --- a/_docs/cn/quick-start-dataconsistency.md +++ b/_docs/cn/quick-start-dataconsistency.md @@ -41,7 +41,7 @@ last_modified_at: 2017-09-19T11:50:10-04:00 service_description: name: flight-booking-service version: 0.0.1 - cse: + servicecomb: service: registry: address: http://sc.servicecomb.io:30100 #此处选择使用ServiceComb的Service Center diff --git a/_docs/cn/service-management.md b/_docs/cn/service-management.md index 236e94e..10abc17 100644 --- a/_docs/cn/service-management.md +++ b/_docs/cn/service-management.md @@ -28,7 +28,7 @@ last_modified_at: 2017-09-03T10:01:43-04:00 2. 在 *体质指数计算器* 的 `microservice.yaml` 文件中指明使用服务治理的处理链及指定熔断和容错策略: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_docs/distributed-tracing.md b/_docs/distributed-tracing.md index 92d7b98..e11d2d7 100644 --- a/_docs/distributed-tracing.md +++ b/_docs/distributed-tracing.md @@ -28,7 +28,7 @@ Walk through [Develop microservice application in minutes](/docs/quick-start-bmi 2. Add handler chain of distributed tracing in `microservice.yaml` of *BMI calculator service*: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_docs/flow-control.md b/_docs/flow-control.md index 155537f..eeef9ce 100644 --- a/_docs/flow-control.md +++ b/_docs/flow-control.md @@ -28,7 +28,7 @@ Walk through [Develop microservice application in minutes](/docs/quick-start-bmi 2. Add handler chain and configurations of flow control in `microservice.yaml` of *BMI calculator service*: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_docs/quick-start-bmi.md b/_docs/quick-start-bmi.md index fe62f12..37695d3 100644 --- a/_docs/quick-start-bmi.md +++ b/_docs/quick-start-bmi.md @@ -116,7 +116,7 @@ APPLICATION_ID: bmi service_description: name: calculator version: 0.0.1 -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 @@ -189,7 +189,7 @@ APPLICATION_ID: bmi service_description: name: gateway version: 0.0.1 -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 diff --git a/_docs/quick-start-dataconsistency.md b/_docs/quick-start-dataconsistency.md index adc6397..76b0fe9 100644 --- a/_docs/quick-start-dataconsistency.md +++ b/_docs/quick-start-dataconsistency.md @@ -40,7 +40,7 @@ Note, demo is in the [ServiceComb-Saga](https://github.com/apache/incubator-serv service_description: name: flight-booking-service version: 0.0.1 - cse: + servicecomb: service: registry: address: http://sc.servicecomb.io:30100 #choose Service Center provided by ServiceComb diff --git a/_docs/service-management.md b/_docs/service-management.md index 3462ce9..8e237ec 100644 --- a/_docs/service-management.md +++ b/_docs/service-management.md @@ -28,7 +28,7 @@ Walk through [Develop microservice application in minutes](/docs/quick-start-bmi 2. Configure handler chain of service management and fallback strategy: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_faqs/cn/faq.md b/_faqs/cn/faq.md index b862864..f14a6a8 100755 --- a/_faqs/cn/faq.md +++ b/_faqs/cn/faq.md @@ -402,7 +402,7 @@ redirect_from: A: 在微服务描述文件(microservice.yaml)中添加如下配置: ```yaml - cse: + servicecomb: request: timeout: 30000 ``` diff --git a/_faqs/cn/huawei-cloud-faq.md b/_faqs/cn/huawei-cloud-faq.md index e5cb02b..09fda26 100644 --- a/_faqs/cn/huawei-cloud-faq.md +++ b/_faqs/cn/huawei-cloud-faq.md @@ -22,7 +22,7 @@ redirect_from: * **Q: 华为公有云运行时报错:WARN com.huawei.paas.monitor.DataFactory: Upload monitor data error. 使用的配置为:** ```yaml - cse: + servicecomb: monitor: handler: chain: @@ -33,7 +33,7 @@ redirect_from: A: 这个是配置文件的错误,handler应该是在cse的下一级而不是monitor的下一级,正确的配置是: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_faqs/huawei-cloud-faq.md b/_faqs/huawei-cloud-faq.md index d93d971..5521b0d 100644 --- a/_faqs/huawei-cloud-faq.md +++ b/_faqs/huawei-cloud-faq.md @@ -22,7 +22,7 @@ redirect_from: 2. **Q: We encountered this error when using Huawei Public Cloud: *WARN com.huaewi.paas.monitor.DataFactory: Upload monitor data error.* The configuration we use is as follows:** ```yaml - cse: + servicecomb: monitor: handler: chain: @@ -30,10 +30,10 @@ redirect_from: default: bizkeeper-provider ``` - A: There are mistakes in your configuration files. `handler` should be the child of `cse` instead of `monitor`. The right configuration should be as follows: + A: There are mistakes in your configuration files. `handler` should be the child of `servicecomb` instead of `monitor`. The right configuration should be as follows: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_posts/2017-06-15-linuxcon-workshop-demo.md b/_posts/2017-06-15-linuxcon-workshop-demo.md index 7eb63ef..cfef778 100644 --- a/_posts/2017-06-15-linuxcon-workshop-demo.md +++ b/_posts/2017-06-15-linuxcon-workshop-demo.md @@ -152,7 +152,7 @@ service_description: name: worker version: 0.0.1 # service center address -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 @@ -321,7 +321,7 @@ service_description: # name of the declaring microservice name: beekeeper version: 0.0.1 -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 @@ -337,7 +337,7 @@ cse: version-rule: 0.0.1 ``` -这里我们需要定义 `cse.references.worker.version-rule` ,让配置名称中指向**技工**服务名 `worker` ,并匹配其版本号。 +这里我们需要定义 `servicecomb.references.worker.version-rule` ,让配置名称中指向**技工**服务名 `worker` ,并匹配其版本号。 最后定义养蜂人服务应用入口: @@ -458,7 +458,7 @@ service_description: # name of the declaring microservice name: doorman version: 0.0.1 -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 @@ -681,7 +681,7 @@ APPLICATION_ID: company service_description: name: manager version: 0.0.1 -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 diff --git a/_posts/2017-07-17-tracing-with-servicecomb.md b/_posts/2017-07-17-tracing-with-servicecomb.md index f7a5a65..cbe3623 100644 --- a/_posts/2017-07-17-tracing-with-servicecomb.md +++ b/_posts/2017-07-17-tracing-with-servicecomb.md @@ -54,7 +54,7 @@ dependency has to be included. ### Configuring Tracing Handlers And Collector In the configuration file `microservice.yaml` , apply tracing handlers and add tracing collector address. ```yaml -cse: +servicecomb: handler: chain: Consumer: diff --git a/_posts/2017-08-21-company-on-kubernetes.md b/_posts/2017-08-21-company-on-kubernetes.md index 106e3a0..d2158e3 100644 --- a/_posts/2017-08-21-company-on-kubernetes.md +++ b/_posts/2017-08-21-company-on-kubernetes.md @@ -110,7 +110,7 @@ spec: restartPolicy: Always status: {} ``` -The yaml defines a pod with one replica (replicas: 1), which can be modified to control the number of replicas of the pod(Anyway, the flexibility of the K8S scalability to achieve on-demand dynamic horizontal expansion to reach the purpose, material of K8S scalability will be provided later in the website). We mentioned that the company-bulletin-board is a DNS name, it is used as the value of cse.service.registry.address and passed to the service within the pod, such as: -Dcse.service. Registry.address = http: // company-bulletin-board: 30100, [kube-dns](https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md) Automatically resolve the servicename. +The yaml defines a pod with one replica (replicas: 1), which can be modified to control the number of replicas of the pod(Anyway, the flexibility of the K8S scalability to achieve on-demand dynamic horizontal expansion to reach the purpose, material of K8S scalability will be provided later in the website). We mentioned that the company-bulletin-board is a DNS name, it is used as the value of servicecomb.service.registry.address and passed to the service within the pod, such as: -Dcse.service. Registry.address = http: // company-bulletin-board: 30100, [kube-dns](https://github.com/kubernetes/kubernetes/blob/master/cluster/addons/dns/README.md) Automatically resolve the servicename. Read [connect-applications-service](https://kubernetes.io/docs/concepts/services-networking/connect-applications-service/) to understanding the communication of services in K8S cluster. diff --git a/_posts/cn/2017-06-15-linuxcon-workshop-demo.md b/_posts/cn/2017-06-15-linuxcon-workshop-demo.md index 90ac858..4714790 100644 --- a/_posts/cn/2017-06-15-linuxcon-workshop-demo.md +++ b/_posts/cn/2017-06-15-linuxcon-workshop-demo.md @@ -152,7 +152,7 @@ service_description: name: worker version: 0.0.1 # service center address -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 @@ -321,7 +321,7 @@ service_description: # name of the declaring microservice name: beekeeper version: 0.0.1 -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 @@ -337,7 +337,7 @@ cse: version-rule: 0.0.1 ``` -这里我们需要定义 `cse.references.worker.version-rule` ,让配置名称中指向**技工**服务名 `worker` ,并匹配其版本号。 +这里我们需要定义 `servicecomb.references.worker.version-rule` ,让配置名称中指向**技工**服务名 `worker` ,并匹配其版本号。 最后定义养蜂人服务应用入口: @@ -458,7 +458,7 @@ service_description: # name of the declaring microservice name: doorman version: 0.0.1 -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 @@ -681,7 +681,7 @@ APPLICATION_ID: company service_description: name: manager version: 0.0.1 -cse: +servicecomb: service: registry: address: http://sc.servicecomb.io:30100 diff --git a/_posts/cn/2017-07-17-tracing-with-servicecomb.md b/_posts/cn/2017-07-17-tracing-with-servicecomb.md index d63b55f..ab5fd86 100644 --- a/_posts/cn/2017-07-17-tracing-with-servicecomb.md +++ b/_posts/cn/2017-07-17-tracing-with-servicecomb.md @@ -48,7 +48,7 @@ ServiceComb 集成了 Zipkin 提供自动调用链追踪能力,如此一来用 ### 配置追踪处理和数据收集 在微服务的 `microservice.yaml` 配置文件中,设置追踪处理器和数据收集服务地址。 ```yaml -cse: +servicecomb: handler: chain: Consumer: diff --git a/_posts/cn/2017-09-14-maven-dependency-management.md b/_posts/cn/2017-09-14-maven-dependency-management.md index 23e0b0e..e5d27ee 100644 --- a/_posts/cn/2017-09-14-maven-dependency-management.md +++ b/_posts/cn/2017-09-14-maven-dependency-management.md @@ -108,13 +108,6 @@ redirect_from: <type>pom</type> <scope>import</scope> </dependency> - <dependency> - <groupId>com.huawei.paas.cse</groupId> - <artifactId>cse-dependency</artifactId> - <version>2.1.1</version> - <type>pom</type> - <scope>import</scope> - </dependency> </dependencies> </dependencyManagement> ``` diff --git a/_users/cn/communicate-protocol.md b/_users/cn/communicate-protocol.md index 2d813c0..7014dd5 100644 --- a/_users/cn/communicate-protocol.md +++ b/_users/cn/communicate-protocol.md @@ -46,7 +46,7 @@ ServiceComb微服务的完整线程模型如下图所示: 在microservice.yaml中添加executors配置,为schemaId:operation配置单独的业务线程池: ```yaml -cse: +servicecomb: executors: Provider: [schemaId].[operation] @@ -118,18 +118,18 @@ REST over Servlet在microservice.yaml文件中的配置项见下表: | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.rest.address | 0.0.0.0:8080 | - | 否 | 服务监听地址 | - | -| cse.rest.timeout | 3000 | - | 否 | 超时时间 | 单位为毫秒 | -| cse.request.timeout | 30000 | - | 否 | 请求超时时间 | 同REST over Vertx的配置 | -| cse.references.\[服务名\].transport | rest | | 否 | 访问的transport类型 | 同REST over Vertx的配置 | -| cse.references.\[服务名\].version-rule | latest | - | 否 | 访问实例的版本号 | 同REST over Vertx的配置 | +| servicecomb.rest.address | 0.0.0.0:8080 | - | 否 | 服务监听地址 | - | +| servicecomb.rest.timeout | 3000 | - | 否 | 超时时间 | 单位为毫秒 | +| servicecomb.request.timeout | 30000 | - | 否 | 请求超时时间 | 同REST over Vertx的配置 | +| servicecomb.references.\[服务名\].transport | rest | | 否 | 访问的transport类型 | 同REST over Vertx的配置 | +| servicecomb.references.\[服务名\].version-rule | latest | - | 否 | 访问实例的版本号 | 同REST over Vertx的配置 | ### 示例代码 microservice.yaml文件中的配置示例如下: ```yaml -cse: +servicecomb: rest: address: 0.0.0.0:8080 timeout: 3000 @@ -167,20 +167,20 @@ REST over Vertx通道在microservice.yaml文件中有以下配置项: | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.rest.address | 0.0.0.0:8080 | - | 否 | 服务监听地址 | 仅服务提供者需要配置 | -| cse.rest.server.thread-count | 1 | - | 否 | 服务端线程数 | 仅服务提供者需要配置 | -| cse.rest.client.thread-count | 1 | - | 否 | 客户端网络线程数 | 仅服务消费者需要配置 | -| cse.rest.client.connection-pool-per-thread | 1 | - | 否 | 客户端每个网络线程中的连接池的个数 | 仅服务消费者需要配置 | -| cse.request.timeout | 30000 | - | 否 | 请求超时时间 | | -| cse.references.\[服务名\].transport | rest | | 否 | 访问的transport类型 | 仅服务消费者需要配置 | -| cse.references.\[服务名\].version-rule | latest | - | 否 | 访问实例的版本号 | 仅服务消费者需要配置支持latest,1.0.0+,1.0.0-2.0.2,精确版本。详细参考服务中心的接口描述。 | +| servicecomb.rest.address | 0.0.0.0:8080 | - | 否 | 服务监听地址 | 仅服务提供者需要配置 | +| servicecomb.rest.server.thread-count | 1 | - | 否 | 服务端线程数 | 仅服务提供者需要配置 | +| servicecomb.rest.client.thread-count | 1 | - | 否 | 客户端网络线程数 | 仅服务消费者需要配置 | +| servicecomb.rest.client.connection-pool-per-thread | 1 | - | 否 | 客户端每个网络线程中的连接池的个数 | 仅服务消费者需要配置 | +| servicecomb.request.timeout | 30000 | - | 否 | 请求超时时间 | | +| servicecomb.references.\[服务名\].transport | rest | | 否 | 访问的transport类型 | 仅服务消费者需要配置 | +| servicecomb.references.\[服务名\].version-rule | latest | - | 否 | 访问实例的版本号 | 仅服务消费者需要配置支持latest,1.0.0+,1.0.0-2.0.2,精确版本。详细参考服务中心的接口描述。 | ### 示例代码 microservice.yaml文件中的配置示例: ```yaml -cse: +servicecomb: rest: address: 0.0.0.0:8080 thread-count: 1 @@ -212,20 +212,20 @@ Highway通道在microservice.yaml文件中的配置项如下表所示: | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.highway.address | 0.0.0.0:7070 | - | 否 | 服务监听地址 | - | -| cse.highway.server.thread-count | 1 | - | 否 | 服务端网络线程个数 | - | -| cse.highway.client.thread-count | 1 | - | 否 | 客户端网络线程个数 | - | -| cse.highway.client.connection-pool-per-thread | 1 | - | 否 | 客户端每个网络线程的连接池个数 | - | -| cse.request.timeout | 30000 | - | 否 | 请求超时时间 | 同REST over Vertx的配置 | -| cse.references.\[服务名\].transport | rest | | 否 | 访问的transport类型 | 同REST over Vertx的配置 | -| cse.references.\[服务名\].version-rule | latest | - | 否 | 访问实例的版本号 | 同REST over Vertx的配置 | +| servicecomb.highway.address | 0.0.0.0:7070 | - | 否 | 服务监听地址 | - | +| servicecomb.highway.server.thread-count | 1 | - | 否 | 服务端网络线程个数 | - | +| servicecomb.highway.client.thread-count | 1 | - | 否 | 客户端网络线程个数 | - | +| servicecomb.highway.client.connection-pool-per-thread | 1 | - | 否 | 客户端每个网络线程的连接池个数 | - | +| servicecomb.request.timeout | 30000 | - | 否 | 请求超时时间 | 同REST over Vertx的配置 | +| servicecomb.references.\[服务名\].transport | rest | | 否 | 访问的transport类型 | 同REST over Vertx的配置 | +| servicecomb.references.\[服务名\].version-rule | latest | - | 否 | 访问实例的版本号 | 同REST over Vertx的配置 | ### 示例代码 microservice.yaml文件中的配置示例: ```yaml -cse: +servicecomb: highway: address: 0.0.0.0:7070 ``` diff --git a/_users/cn/distributed-tracing.md b/_users/cn/distributed-tracing.md index 8a4160a..f894a1c 100644 --- a/_users/cn/distributed-tracing.md +++ b/_users/cn/distributed-tracing.md @@ -53,14 +53,13 @@ ServiceComb 集成了 Zipkin 提供自动调用链追踪能力,如此一来用 在microservice.yaml文件中设置追踪处理器和数据收集服务地址 ```yaml -cse: +servicecomb: handler: chain: Consumer: default: tracing-consumer Provider: default: tracing-provider -servicecomb: tracing: collector: address: http://zipkin.servicecomb.io:9411 diff --git a/_users/cn/invoke-control.md b/_users/cn/invoke-control.md index e93e006..5e5efa7 100644 --- a/_users/cn/invoke-control.md +++ b/_users/cn/invoke-control.md @@ -22,10 +22,10 @@ redirect_from: | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.loadbalance.isolation.enabled | false | Boolean | 否 | 是否开启故障实例隔离功能 | - | -| cse.loadbalance.isolation.enableRequestThreshold | 20 | Integer | 否 | 当实例的调用总次数达到该值时开始进入隔离逻辑门槛 | - | -| cse.loadbalance.isolation.errorThresholdPercentage | 20 | Integer,区间为\(0,100\] | 否 | 实例故障隔离错误百分比 | - | -| cse.loadbalance.isolation.singleTestTime | 10000 | Integer | 否 | 故障实例单点测试时间 | | +| servicecomb.loadbalance.isolation.enabled | false | Boolean | 否 | 是否开启故障实例隔离功能 | - | +| servicecomb.loadbalance.isolation.enableRequestThreshold | 20 | Integer | 否 | 当实例的调用总次数达到该值时开始进入隔离逻辑门槛 | - | +| servicecomb.loadbalance.isolation.errorThresholdPercentage | 20 | Integer,区间为\(0,100\] | 否 | 实例故障隔离错误百分比 | - | +| servicecomb.loadbalance.isolation.singleTestTime | 10000 | Integer | 否 | 故障实例单点测试时间 | | ## 熔断策略 ### 场景描述 @@ -50,7 +50,7 @@ redirect_from: 限流策略配置在microservice.yaml文件中,相关配置项见下表。要开启服务消费者端的限流策略,还需要在处理链中配置消费端限流handler,配置示例如下: ```yaml -cse: +servicecomb: handler: chain: Consumer: @@ -61,5 +61,5 @@ QPS流控配置项说明 | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.flowcontrol.Consumer.qps.enabled | true | Boolean | 否 | 是否启用Consumer流控 | - | -| cse.flowcontrol.Consumer.qps.limit.[ServiceName].[Schema].[operation] | 2147483647 (max int) | (0,2147483647],整形 | 否 | 每秒钟允许的请求数 | 支持microservice、schema、operation三个级别的配置 | +| servicecomb.flowcontrol.Consumer.qps.enabled | true | Boolean | 否 | 是否启用Consumer流控 | - | +| servicecomb.flowcontrol.Consumer.qps.limit.[ServiceName].[Schema].[operation] | 2147483647 (max int) | (0,2147483647],整形 | 否 | 每秒钟允许的请求数 | 支持microservice、schema、operation三个级别的配置 | diff --git a/_users/cn/local-develop-test.md b/_users/cn/local-develop-test.md index 81ef893..552c92a 100644 --- a/_users/cn/local-develop-test.md +++ b/_users/cn/local-develop-test.md @@ -29,7 +29,7 @@ redirect_from: * **步骤 2** 启动本地轻量服务中心后,在服务提供/消费者的microservice.yaml文件中配置ServerCenter的地址和端口,示例代码: ```yaml - cse: + servicecomb: service: registry: address: http://127.0.0.1:30100 #服务中心地址及端口 diff --git a/_users/cn/manage_springcloud_application_using_sc_and_gs.md b/_users/cn/manage_springcloud_application_using_sc_and_gs.md index 70806be..fc607b9 100644 --- a/_users/cn/manage_springcloud_application_using_sc_and_gs.md +++ b/_users/cn/manage_springcloud_application_using_sc_and_gs.md @@ -88,7 +88,7 @@ redirect_from: service_description: name: discoveryServer version: 0.0.2 - cse: + servicecomb: service: registry: address: http://127.0.0.1:30100 #服务注册中心地址 diff --git a/_users/cn/metrics-in-0.5.0.md b/_users/cn/metrics-in-0.5.0.md index 68a1ce2..a81006a 100644 --- a/_users/cn/metrics-in-0.5.0.md +++ b/_users/cn/metrics-in-0.5.0.md @@ -81,7 +81,7 @@ APPLICATION_ID: demo service_description: name: demoService version: 0.0.1 -cse: +servicecomb: handler: chain: Provider: diff --git a/_users/cn/metrics-in-1.0.0-m1.md b/_users/cn/metrics-in-1.0.0-m1.md index dcbbf1e..a50097c 100644 --- a/_users/cn/metrics-in-1.0.0-m1.md +++ b/_users/cn/metrics-in-1.0.0-m1.md @@ -112,6 +112,7 @@ name包括: ## 如何配置 ### 全局配置 请在microservice.yaml中添加如下配置项: + ```yaml APPLICATION_ID: demo service_description: @@ -123,6 +124,7 @@ servicecomb: #时间窗间隔,单位毫秒,默认为5000(5秒) window_time: 5000 ``` + **为了降低Metrics理解和使用难度,我们暂时不支持多周期** ### 依赖配置 @@ -155,7 +157,7 @@ public class MetricsPublisher { ``` 因此,如果你在microservice.yaml中配置了rest provider,例如: ```yaml -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 diff --git a/_users/cn/service-configurations.md b/_users/cn/service-configurations.md index 5ceceb6..62904ff 100644 --- a/_users/cn/service-configurations.md +++ b/_users/cn/service-configurations.md @@ -17,24 +17,24 @@ redirect_from: ### 配置说明 - 负载均衡策略在microservice.yaml文件中配置,配置项为`cse.loadbalance.[MicroServiceName].[property name]`,其中若省略MicroServiceName,则为全局配置;若指定MicroServiceName,则为针对特定微服务的配置。 + 负载均衡策略在microservice.yaml文件中配置,配置项为`servicecomb.loadbalance.[MicroServiceName].[property name]`,其中若省略MicroServiceName,则为全局配置;若指定MicroServiceName,则为针对特定微服务的配置。 **表1 配置项说明** | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.loadbalance.NFLoadBalancerRuleClassName | com.netflix.loadbalancer.RoundRobinRule | com.netflix.loadbalancer.RoundRobinRule(轮询)com.netflix.loadbalancer.RandomRule(随机)com.netflix.loadbalancer.WeightedResponseTimeRule(服务器响应时间权值)org.apache.servicecomb.loadbalance.SessionStickinessRule(会话保持) | 否 | 负载均衡路由策略 | - | -| cse.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds | 30 | Integer | 否 | 客户端闲置时间,超过限制后选择后面的服务器。 | 暂不支持微服务配置。e.g. cse.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds,不能配置为cse.loadbalance.DemoService.SessionStickinessRule.sessionTimeoutInSeconds | -| cse.loadbalance.SessionStickinessRule.successiveFailedTimes | 5 | Integer | 否 | 客户端失败次数,超过后会切换服务器 | 暂不支持微服务配置 | -| cse.loadbalance.retryEnabled | FALSE | Boolean | 否 | 负载均衡捕获到服务调用异常,是否进行重试 | - | -| cse.loadbalance.retryOnNext | 0 | Integer | 否 | 尝试新的服务器的次数 | - | -| cse.loadbalance.retryOnSame | 0 | Integer | 否 | 同一个服务器尝试的次数 | - | -| cse.loadbalance.isolation.enabled | FALSE | Boolean | 否 | 是否开启故障实例隔离功能 | - | -| cse.loadbalance.isolation.enableRequestThreshold | 20 | Integer | 否 | 当实例的调用总次数达到该值时开始进入隔离逻辑门槛 | - | -| cse.loadbalance.isolation.errorThresholdPercentage | 20 | Integer,区间为\(0,100\] | 否 | 实例故障隔离错误百分比 | - | -| cse.loadbalance.isolation.singleTestTime | 10000 | Integer | 否 | 故障实例单点测试时间 | 单位为ms | -| cse.loadbalance.transactionControl.policy | org.apache.servicecomb.loadbalance.filter.SimpleTransactionControlFilter | - | 否 | 动态路由分流策略 | 框架提供了简单的分流机制,开发者也可以实现自定义的分流过滤策略 | -| cse.loadbalance.transactionControl.options | - | key/value pairs | 否 | 针对SimpleTransactionControlFilter分流策略的配置项,可添加任意项过滤标签 | - | +| servicecomb.loadbalance.NFLoadBalancerRuleClassName | com.netflix.loadbalancer.RoundRobinRule | com.netflix.loadbalancer.RoundRobinRule(轮询)com.netflix.loadbalancer.RandomRule(随机)com.netflix.loadbalancer.WeightedResponseTimeRule(服务器响应时间权值)org.apache.servicecomb.loadbalance.SessionStickinessRule(会话保持) | 否 | 负载均衡路由策略 | - | +| servicecomb.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds | 30 | Integer | 否 | 客户端闲置时间,超过限制后选择后面的服务器。 | 暂不支持微服务配置。e.g. servicecomb.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds,不能配置为cse.loadbalance.DemoService.SessionStickinessRule.sessionTimeoutInSeconds | +| servicecomb.loadbalance.SessionStickinessRule.successiveFailedTimes | 5 | Integer | 否 | 客户端失败次数,超过后会切换服务器 | 暂不支持微服务配置 | +| servicecomb.loadbalance.retryEnabled | FALSE | Boolean | 否 | 负载均衡捕获到服务调用异常,是否进行重试 | - | +| servicecomb.loadbalance.retryOnNext | 0 | Integer | 否 | 尝试新的服务器的次数 | - | +| servicecomb.loadbalance.retryOnSame | 0 | Integer | 否 | 同一个服务器尝试的次数 | - | +| servicecomb.loadbalance.isolation.enabled | FALSE | Boolean | 否 | 是否开启故障实例隔离功能 | - | +| servicecomb.loadbalance.isolation.enableRequestThreshold | 20 | Integer | 否 | 当实例的调用总次数达到该值时开始进入隔离逻辑门槛 | - | +| servicecomb.loadbalance.isolation.errorThresholdPercentage | 20 | Integer,区间为\(0,100\] | 否 | 实例故障隔离错误百分比 | - | +| servicecomb.loadbalance.isolation.singleTestTime | 10000 | Integer | 否 | 故障实例单点测试时间 | 单位为ms | +| servicecomb.loadbalance.transactionControl.policy | org.apache.servicecomb.loadbalance.filter.SimpleTransactionControlFilter | - | 否 | 动态路由分流策略 | 框架提供了简单的分流机制,开发者也可以实现自定义的分流过滤策略 | +| servicecomb.loadbalance.transactionControl.options | - | key/value pairs | 否 | 针对SimpleTransactionControlFilter分流策略的配置项,可添加任意项过滤标签 | - | ### 示例代码 @@ -43,7 +43,7 @@ redirect_from: 配置处理链: ```yaml -cse: +servicecomb: # other configurations omitted handler: chain: @@ -55,7 +55,7 @@ cse: 增加路由策略: ```yaml -cse: +servicecomb: # other configurations omitted loadbalance: NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule @@ -71,7 +71,7 @@ cse: * 编译开发的策略,保证生成的class在classpath下。 -* 通过SDK配置该路由策略,假如是`AbcRule`。则配置如下: `cse.loadbalance.NFLoadBalancerRuleClassName=org.apache.servicecomb.ribbon.rule.AbcRule` +* 通过SDK配置该路由策略,假如是`AbcRule`。则配置如下: `servicecomb.loadbalance.NFLoadBalancerRuleClassName=org.apache.servicecomb.ribbon.rule.AbcRule` ## 限流策略 ### 场景描述 @@ -89,7 +89,7 @@ cse: 限流策略配置在microservice.yaml文件中,相关配置项见下表。要开启服务提供者端的限流策略,还需要在处理链中配置服务端限流handler,配置示例如下: ```yaml -cse: +servicecomb: handler: chain: Consumer: @@ -100,9 +100,9 @@ cse: | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.flowcontrol.Provider.qps.enabled | true | true/false | 否 | 是否启用Provider流控 | - | -| cse.flowcontrol.Provider.qps.limit.\[ServiceName\] | 2147483647(max int) | \(0,2147483647\],整形 | 否 | 每秒钟允许的请求数 | 仅支持microservice一个级别的配置 | -| cse.flowcontrol.Provider.qps.global.limit | 2147483647(max int) | (0,2147483647\],整形 | 否 | provider接受请求流量的全局配置 | 没有具体到微服务的配置时,此配置生效 | +| servicecomb.flowcontrol.Provider.qps.enabled | true | true/false | 否 | 是否启用Provider流控 | - | +| servicecomb.flowcontrol.Provider.qps.limit.\[ServiceName\] | 2147483647(max int) | \(0,2147483647\],整形 | 否 | 每秒钟允许的请求数 | 仅支持microservice一个级别的配置 | +| servicecomb.flowcontrol.Provider.qps.global.limit | 2147483647(max int) | (0,2147483647\],整形 | 否 | provider接受请求流量的全局配置 | 没有具体到微服务的配置时,此配置生效 | ## 降级策略 ### 概念阐述 @@ -128,18 +128,18 @@ cse: | 配置项 | 默认值 | 取值范围 | 是否必选 | 含义 | 注意 | | :--- | :--- | :--- | :--- | :--- | :--- | -| cse.isolation.timeout.enabled | FALSE | - | 否 | 是否启用超时检测 | | -| cse.isolation.timeoutInMilliseconds | 30000 | - | 否 | 超时时间阈值 | | -| cse.isolation.maxConcurrentRequests | 10 | - | 否 | 最大并发数阈值 | | -| cse.circuitBreaker.enabled | TRUE | - | 否 | 是否启用熔断措施 | | -| cse.circuitBreaker.forceOpen | FALSE | - | 否 | 不管失败次数,都进行熔断 | | -| cse.circuitBreaker.forceClosed | FALSE | - | 否 | 任何时候都不熔断 | 当与forceOpen同时配置时,forceOpen优先。 | -| cse.circuitBreaker.sleepWindowInMilliseconds | 15000 | - | 否 | 熔断后,多长时间恢复 | 恢复后,会重新计算失败情况。注意:如果恢复后的调用立即失败,那么会立即重新进入熔断。 | -| cse.circuitBreaker.requestVolumeThreshold | 20 | - | 否 | 10s内统计错误发生次数阈值,超过阈值则触发熔断 | 由于10秒还会被划分为10个1秒的统计周期,经过1s中后才会开始计算错误率,因此从调用开始至少经过1s,才会发生熔断。 | -| cse.circuitBreaker.errorThresholdPercentage | 50 | - | 否 | 错误率阈值,达到阈值则触发熔断 | | -| cse.fallback.enabled | TRUE | - | 否 | 是否启用出错后的故障处理措施 | | -| cse.fallback.maxConcurrentRequests | 10 | - | 否 | 并发调用容错处理措施(cse.fallbackpolicy.policy)的请求数,超过这个值则不再调用处理措施,直接返回异常 | | -| cse.fallbackpolicy.policy | throwexception | returnnulll \| throwexception | 否 | 出错后的处理策略 | | +| servicecomb.isolation.timeout.enabled | FALSE | - | 否 | 是否启用超时检测 | | +| servicecomb.isolation.timeoutInMilliseconds | 30000 | - | 否 | 超时时间阈值 | | +| servicecomb.isolation.maxConcurrentRequests | 10 | - | 否 | 最大并发数阈值 | | +| servicecomb.circuitBreaker.enabled | TRUE | - | 否 | 是否启用熔断措施 | | +| servicecomb.circuitBreaker.forceOpen | FALSE | - | 否 | 不管失败次数,都进行熔断 | | +| servicecomb.circuitBreaker.forceClosed | FALSE | - | 否 | 任何时候都不熔断 | 当与forceOpen同时配置时,forceOpen优先。 | +| servicecomb.circuitBreaker.sleepWindowInMilliseconds | 15000 | - | 否 | 熔断后,多长时间恢复 | 恢复后,会重新计算失败情况。注意:如果恢复后的调用立即失败,那么会立即重新进入熔断。 | +| servicecomb.circuitBreaker.requestVolumeThreshold | 20 | - | 否 | 10s内统计错误发生次数阈值,超过阈值则触发熔断 | 由于10秒还会被划分为10个1秒的统计周期,经过1s中后才会开始计算错误率,因此从调用开始至少经过1s,才会发生熔断。 | +| servicecomb.circuitBreaker.errorThresholdPercentage | 50 | - | 否 | 错误率阈值,达到阈值则触发熔断 | | +| servicecomb.fallback.enabled | TRUE | - | 否 | 是否启用出错后的故障处理措施 | | +| servicecomb.fallback.maxConcurrentRequests | 10 | - | 否 | 并发调用容错处理措施(servicecomb.fallbackpolicy.policy)的请求数,超过这个值则不再调用处理措施,直接返回异常 | | +| servicecomb.fallbackpolicy.policy | throwexception | returnnulll \| throwexception | 否 | 出错后的处理策略 | | **注意:** 谨慎使用cse.isolation.timeout.enabled=true。因为系统处理链都是异步执行,中间处理链的返回,会导致后面处理链的逻辑处理效果丢失。尽可能将cse.isolation.timeout.enabled保持默认值false,并且正确设置网络层超时时间cse.request.timeout=30000。 {: .notice--warning} @@ -147,7 +147,7 @@ cse: ## 示例代码 ```yaml -cse: +servicecomb: handler: chain: Consumer: diff --git a/_users/cn/setup-environment.md b/_users/cn/setup-environment.md index 08f04ef..030751f 100644 --- a/_users/cn/setup-environment.md +++ b/_users/cn/setup-environment.md @@ -182,7 +182,7 @@ curl http://10.12.0.1:30101/v4/default/registry/health 在你的microservice.yaml中你可以填写一个或多个Service Center实例,如果[Java-Chassis SDK](https://github.com/apache/incubator-servicecomb-java-chassis)发现配置的第一个地址(实例)失败,它将会自动使用下一个地址(实例): ```yaml -cse: +servicecomb: service: registry: address: "http://10.12.0.1:30100,http://10.12.0.2:30100" diff --git a/_users/cn/use-service-contract.md b/_users/cn/use-service-contract.md index 346aa12..b10f017 100644 --- a/_users/cn/use-service-contract.md +++ b/_users/cn/use-service-contract.md @@ -23,7 +23,7 @@ redirect_from: 服务消费者需要在microservice.yaml文件中配置依赖的provider,示例配置如下: ```yaml -cse: +servicecomb: # other configurations omitted references: springmvc: diff --git a/_users/cn/use-tls.md b/_users/cn/use-tls.md index 1df8fab..91db626 100644 --- a/_users/cn/use-tls.md +++ b/_users/cn/use-tls.md @@ -21,7 +21,7 @@ redirect_from: 微服务与服务中心的连接可以通过将http改为https启用TLS通信,配置示例如下: ```yaml - cse: + servicecomb: service: registry: address: https://127.0.0.1:30100 @@ -31,7 +31,7 @@ redirect_from: 服务提供者在配置服务监听地址时,可以通过在地址后面追加`?sslEnabled=true`开启TLS通信,示例如下: ```yaml - cse: + servicecomb: rest: address: 0.0.0.0:8080?sslEnabled=true highway: @@ -116,7 +116,7 @@ ssl.[tag].[property] microservice.yaml文件中启用TLS通信的配置示例如下: ```yaml -cse: +servicecomb: service: registry: address: https://127.0.0.1:30100 diff --git a/_users/cn/zuul.md b/_users/cn/zuul.md index 140097a..bee3e35 100644 --- a/_users/cn/zuul.md +++ b/_users/cn/zuul.md @@ -97,7 +97,7 @@ Zuul做API Gateway,即建立一个Zuul Proxy应用,在该Proxy应用中统 service_description: name: discoveryGateway #服务名称 version: 0.0.2 #服务版本号 - cse: + servicecomb: service: registry: address: http://127.0.0.1:30100 #服务注册中心地址 @@ -126,7 +126,7 @@ APPLICATION_ID: discoverytest #与zuul proxy一致 service_description: name: discoveryServer #服务名称,与zuul.routers对应 version: 0.0.2 -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 #服务注册中心地址 diff --git a/_users/communicate-protocol.md b/_users/communicate-protocol.md index 23f394a..ccb597c 100644 --- a/_users/communicate-protocol.md +++ b/_users/communicate-protocol.md @@ -46,7 +46,7 @@ The complete thread model of CSE is shown in the following figure. Add the executors in the microservice.yaml file and configure an independent service thread pool for schemaId: operation: ```yaml -cse: +servicecomb: executors: Provider: [schemaId].[operation] @@ -118,18 +118,18 @@ Table 1 Configuration items of REST over Servlet | Configuration Item | Default Value | Value Range | Mandatory | Description | Remark | | :---------------------------------- | :------------ | :---------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.rest.address | 0.0.0.0:8080 | - | No | Specifies the server listening IP address. | - | -| cse.rest.timeout | 3000 | - | No | Specifies the timeout duration | The unit is ms. | -| cse.request.timeout | 30000 | - | No | Specifies the request timeout duration. | The configuration of this parameter for REST over Servlet is the same as that for REST over Vertx. | -| cse.references.\[服务名\].transport | rest | | No | Specifies the accessed transport type. | The configuration of this parameter for REST over Servlet is the same as that for REST over Vertx. | -| cse.references.\[服务名\].version-rule | latest | - | No | Specifies the version of the accessed instance. | The configuration of this parameter for REST over Servlet is the same as that for REST over Vertx. | +| servicecomb.rest.address | 0.0.0.0:8080 | - | No | Specifies the server listening IP address. | - | +| servicecomb.rest.timeout | 3000 | - | No | Specifies the timeout duration | The unit is ms. | +| servicecomb.request.timeout | 30000 | - | No | Specifies the request timeout duration. | The configuration of this parameter for REST over Servlet is the same as that for REST over Vertx. | +| servicecomb.references.\[服务名\].transport | rest | | No | Specifies the accessed transport type. | The configuration of this parameter for REST over Servlet is the same as that for REST over Vertx. | +| servicecomb.references.\[服务名\].version-rule | latest | - | No | Specifies the version of the accessed instance. | The configuration of this parameter for REST over Servlet is the same as that for REST over Vertx. | ### Sample Code The following is an example of the configuration in the microservice.yaml file for REST over Servlet: ```yaml -cse: +servicecomb: rest: address: 0.0.0.0:8080 timeout: 3000 @@ -167,20 +167,20 @@ Table 2 Configuration items of REST over Vertx | Configuration Item | Default Value | Value Range | Mandatory | Description | Remark | | :--------------------------------------- | :------------ | :---------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.rest.address | 0.0.0.0:8080 | - | No | Specifies the server listening IP address. | Only service providers require this parameter. | -| cse.rest.server.thread-count | 1 | - | No | Specifies the number of server threads. | Only service providers require this parameter. | -| cse.rest.client.thread-count | 1 | - | No | Specifies the number of client network threads. | Only service consumers require this parameter. | -| cse.rest.client.connection-pool-per-thread | 1 | - | No | Specifies the number of connection pools in each client thread. | Only service consumers require this parameter. | -| cse.request.timeout | 30000 | - | No | Specifies the request timeout duration. | | -| cse.references.\[服务名\].transport | rest | | No | Specifies the accessed transport type. | Only service consumers require this parameter. | -| cse.references.\[服务名\].version-rule | latest | - | No | Specifies the version of the accessed instance. | Only service consumers require this parameter. You can set it to latest, a version range such as 1.0.0+ or 1.0.0-2.0.2, or a specific version number. For details, see the API description of the service center. | +| servicecomb.rest.address | 0.0.0.0:8080 | - | No | Specifies the server listening IP address. | Only service providers require this parameter. | +| servicecomb.rest.server.thread-count | 1 | - | No | Specifies the number of server threads. | Only service providers require this parameter. | +| servicecomb.rest.client.thread-count | 1 | - | No | Specifies the number of client network threads. | Only service consumers require this parameter. | +| servicecomb.rest.client.connection-pool-per-thread | 1 | - | No | Specifies the number of connection pools in each client thread. | Only service consumers require this parameter. | +| servicecomb.request.timeout | 30000 | - | No | Specifies the request timeout duration. | | +| servicecomb.references.\[服务名\].transport | rest | | No | Specifies the accessed transport type. | Only service consumers require this parameter. | +| servicecomb.references.\[服务名\].version-rule | latest | - | No | Specifies the version of the accessed instance. | Only service consumers require this parameter. You can set it to latest, a version range such as 1.0.0+ or 1.0.0-2.0.2, or a specific version number. For details, see the API description of the service center. | ### Sample Code An example of the configuration in the microservice.yaml file for REST over Vertx is as follows: ```yaml -cse: +servicecomb: rest: address: 0.0.0.0:8080 thread-count: 1 @@ -212,20 +212,20 @@ Table 3 Configuration items of Highway | Configuration Item | Default Value | Value Range | Mandatory | Description | Remark | | :--------------------------------------- | :------------ | :---------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.highway.address | 0.0.0.0:7070 | - | No | Specifies the server listening IP address. | - | -| cse.highway.server.thread-count | 1 | - | No | Specifies the number of server network threads. | - | -| cse.highway.client.thread-count | 1 | - | No | Specifies the number of client network threads. | - | -| cse.highway.client.connection-pool-per-thread | 1 | - | No | Specifies the number of connection pools in each client thread. | - | -| cse.request.timeout | 30000 | - | No | Specifies the request timeout duration. | The configuration of this parameter for Highway is the same as that for REST over Vertx. | -| cse.references.\[服务名\].transport | rest | | No | Specifies the accessed transport type. | The configuration of this parameter for Highway is the same as that for REST over Vertx. | -| cse.references.\[服务名\].version-rule | latest | - | No | Specifies the version of the accessed instance. | The configuration of this parameter for Highway is the same as that for REST over Vertx. | +| servicecomb.highway.address | 0.0.0.0:7070 | - | No | Specifies the server listening IP address. | - | +| servicecomb.highway.server.thread-count | 1 | - | No | Specifies the number of server network threads. | - | +| servicecomb.highway.client.thread-count | 1 | - | No | Specifies the number of client network threads. | - | +| servicecomb.highway.client.connection-pool-per-thread | 1 | - | No | Specifies the number of connection pools in each client thread. | - | +| servicecomb.request.timeout | 30000 | - | No | Specifies the request timeout duration. | The configuration of this parameter for Highway is the same as that for REST over Vertx. | +| servicecomb.references.\[服务名\].transport | rest | | No | Specifies the accessed transport type. | The configuration of this parameter for Highway is the same as that for REST over Vertx. | +| servicecomb.references.\[服务名\].version-rule | latest | - | No | Specifies the version of the accessed instance. | The configuration of this parameter for Highway is the same as that for REST over Vertx. | ### An example of the configuration in the microservice.yaml file for Highway is as follows: ```yaml -cse: +servicecomb: highway: address: 0.0.0.0:7070 ``` diff --git a/_users/distributed-tracing.md b/_users/distributed-tracing.md index 7ce39f6..40fecea 100644 --- a/_users/distributed-tracing.md +++ b/_users/distributed-tracing.md @@ -53,14 +53,13 @@ If the microservice is based on the API of Spring Cloud Zuul, such as the manage Set addresses for the tracing processor and data collection in the microservice.yaml file. ```yaml -cse: +servicecomb: handler: chain: Consumer: default: tracing-consumer Provider: default: tracing-provider -servicecomb: tracing: collector: address: http://zipkin.servicecomb.io:9411 diff --git a/_users/huawei-cloud-faq.md b/_users/huawei-cloud-faq.md index 11add9b..df3cd02 100644 --- a/_users/huawei-cloud-faq.md +++ b/_users/huawei-cloud-faq.md @@ -22,7 +22,7 @@ redirect_from: 2. **Q: We encountered this error when using Huawei Public Cloud: *WARN com.huaewi.paas.monitor.DataFactory: Upload monitor data error.* The configuration we use is as follows:** ```yaml - cse: + servicecomb: monitor: handler: chain: @@ -30,10 +30,10 @@ redirect_from: default: bizkeeper-provider ``` - A: There are mistakes in your configuration files. `handler` should be the child of `cse` instead of `monitor`. The right configuration should be as follows: + A: There are mistakes in your configuration files. `handler` should be the child of `servicecomb` instead of `monitor`. The right configuration should be as follows: ```yaml - cse: + servicecomb: handler: chain: Provider: diff --git a/_users/invoke-control.md b/_users/invoke-control.md index e7716a1..6e81283 100644 --- a/_users/invoke-control.md +++ b/_users/invoke-control.md @@ -22,10 +22,10 @@ This instance-level fault isolation function is integrated into the load balanci | Configuration Item | Default Value | Value Range | Mandatory | Description | Remark | | :--------------------------------------- | :------------ | :----------------- | :-------- | :--------------------------------------- | :----- | -| cse.loadbalance.isolation.enabled | false | Boolean | No | Specifies whether to enable faulty instance isolation. | - | -| cse.loadbalance.isolation.enableRequestThreshold | 20 | Integer | No | Specifies the threshold number of instance calls. If this value is reached, isolation is enabled. | - | -| cse.loadbalance.isolation.errorThresholdPercentage | 20 | Integer, \(0,100\] | No | Specifies the error percentage. Instance fault isolation is enabled when the set value is reached. | - | -| cse.loadbalance.isolation.singleTestTime | 10000 | Integer | No | Specifies the duration of a faulty instance test on a single node. | | +| servicecomb.loadbalance.isolation.enabled | false | Boolean | No | Specifies whether to enable faulty instance isolation. | - | +| servicecomb.loadbalance.isolation.enableRequestThreshold | 20 | Integer | No | Specifies the threshold number of instance calls. If this value is reached, isolation is enabled. | - | +| servicecomb.loadbalance.isolation.errorThresholdPercentage | 20 | Integer, \(0,100\] | No | Specifies the error percentage. Instance fault isolation is enabled when the set value is reached. | - | +| servicecomb.loadbalance.isolation.singleTestTime | 10000 | Integer | No | Specifies the duration of a faulty instance test on a single node. | | ## Circuit Break Policy ### Scenario @@ -50,7 +50,7 @@ See detail info at [Service Configurations](/users/service-configurations/#限 Flow control policy configuration is in microservice.yaml file. You need to configure consumer handler in chain of service. See example blow: ```yaml -cse: +servicecomb: handler: chain: Consumer: @@ -61,6 +61,6 @@ Configuration items of QPS: | Configuration Item | Default Value | Value Range | Mandatory | Description | Remark | | :--------------------------------------- | :-------------------- | :---------------------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.flowcontrol.Consumer.qps.enabled | true | Boolean | No | Specifies whether consumers flowcontrol enables. | - | -| cse.flowcontrol.Consumer.qps.limit.[ServiceName].[Schema].[operation] | 2147483647 (max int) | (0,2147483647], Integer | No | Specifies number of requests per second. | Support three level configurations: microservice、schema、operation. | +| servicecomb.flowcontrol.Consumer.qps.enabled | true | Boolean | No | Specifies whether consumers flowcontrol enables. | - | +| servicecomb.flowcontrol.Consumer.qps.limit.[ServiceName].[Schema].[operation] | 2147483647 (max int) | (0,2147483647], Integer | No | Specifies number of requests per second. | Support three level configurations: microservice、schema、operation. | diff --git a/_users/local-develop-test.md b/_users/local-develop-test.md index 178cb66..8e06d27 100644 --- a/_users/local-develop-test.md +++ b/_users/local-develop-test.md @@ -29,7 +29,7 @@ Service center is an important component in the microservice architecture, and i * **Step 2** After local service center is started, configure the service center address in the microservice.yaml file that stores SDK configuration information, as shown in the following example: ```yaml - cse: + servicecomb: service: registry: address: http://127.0.0.1:30100 #Indicates the service center address and port number diff --git a/_users/manage_springcloud_application_using_sc_and_gs.md b/_users/manage_springcloud_application_using_sc_and_gs.md index 0d4f65e..131659f 100644 --- a/_users/manage_springcloud_application_using_sc_and_gs.md +++ b/_users/manage_springcloud_application_using_sc_and_gs.md @@ -88,7 +88,7 @@ NOTE, If your java chassis version is or below 0.5.0, please use the io.servic service_description: name: discoveryServer version: 0.0.2 - cse: + servicecomb: service: registry: address: http://127.0.0.1:30100 #Service Center registration diff --git a/_users/metrics-in-1.0.0-m1.md b/_users/metrics-in-1.0.0-m1.md index f591706..b39fc4c 100644 --- a/_users/metrics-in-1.0.0-m1.md +++ b/_users/metrics-in-1.0.0-m1.md @@ -155,7 +155,7 @@ public class MetricsPublisher { ``` So,if you had config rest provider in microservice.yaml,like: ```yaml -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 diff --git a/_users/service-configurations.md b/_users/service-configurations.md index 9aa9a97..833447f 100644 --- a/_users/service-configurations.md +++ b/_users/service-configurations.md @@ -17,24 +17,24 @@ redirect_from: ### Configuration - Load balancing policies are configured by setting the parameter `cse.loadbalance.[MicroServiceName].[property name]` in the microservice.yaml fiel. If MicroServiceName is not set, the configuration is set for all microservices. Otherwise, the configuration is set for a specific microservice. + Load balancing policies are configured by setting the parameter `servicecomb.loadbalance.[MicroServiceName].[property name]` in the microservice.yaml fiel. If MicroServiceName is not set, the configuration is set for all microservices. Otherwise, the configuration is set for a specific microservice. **Table 1 Configuration items of load balancing policy** | Configuration Items | Default Value | Value Range | Mandatory | Description | Remarks | | :--------------------------------------- | :--------------------------------------- | :--------------------------------------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.loadbalance.NFLoadBalancerRuleClassName | com.netflix.loadbalancer.RoundRobinRule | com.netflix.loadbalancer.RoundRobinRule(polling)com.netflix.loadbalancer.RandomRule(random)com.netflix.loadbalancer.WeightedResponseTimeRule(server response time weight)org.apache.servicecomb.loadbalance.SessionStickinessRule(session stickiness) | No | Specifiles the load balancing policy | - | -| cse.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds | 30 | Integer | No | Specifies the idle time of a client. If the idle time exceeds the set value, ServiceComb will select another server. | Currently, this parameter cannot be set for a certain microservice. For example, cse.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds cannot be set to cse.loadbalance.DemoService.SessionStickinessRule.sessionTimeoutInSeconds | -| cse.loadbalance.SessionStickinessRule.successiveFailedTimes | 5 | Integer | No | Specifies the number of failed requests from the client. If the number exceeds the set value, ServiceComb will switch to another server | Currently, this parameter cannot be set for a certain microservice. | -| cse.loadbalance.retryEnabled | FALSE | Boolean | No | Specifies whether to call a service again when a exception is captured by the load balance. | - | -| cse.loadbalance.retryOnNext | 0 | Integer | No | Specifies the number of attempts to connect to another server. | - | -| cse.loadbalance.retryOnSame | 0 | Integer | No | Specifies the number of attempts to connect to the same server. | - | -| cse.loadbalance.isolation.enabled | FALSE | Boolean | No | Specifies whether to enable faulty instance isolation. | - | -| cse.loadbalance.isolation.enableRequestThreshold | 20 | Integer | No | Specifies the threshold number of instance calls. If this value is reached, isolation is enabled. | - | -| cse.loadbalance.isolation.errorThresholdPercentage | 20 | Integer,\(0,100\] | No | Specifies the error percentage. Instance fault isolation is enabled when the set value is reached. | - | -| cse.loadbalance.isolation.singleTestTime | 10000 | Integer | No | Specifies the duration of a faulty instance test on a single node. | This unit is ms. | -| cse.loadbalance.transactionControl.policy | org.apache.servicecomb.loadbalance.filter.SimpleTransactionControlFilter | - | No | Specifies the offload policies for dynamic routing. | The framework provides simple offload mechanisms. You can also customize offload policies. | -| cse.loadbalance.transactionControl.options | - | key/value pairs | No | Specifies the parameter configured for the SimpleTransactionControlFilter offload policy. You can add any filtration tag for this item. | - | +| servicecomb.loadbalance.NFLoadBalancerRuleClassName | com.netflix.loadbalancer.RoundRobinRule | com.netflix.loadbalancer.RoundRobinRule(polling)com.netflix.loadbalancer.RandomRule(random)com.netflix.loadbalancer.WeightedResponseTimeRule(server response time weight)org.apache.servicecomb.loadbalance.SessionStickinessRule(session stickiness) | No | Specifiles the load balancing policy | - | +| servicecomb.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds | 30 | Integer | No | Specifies the idle time of a client. If the idle time exceeds the set value, ServiceComb will select another server. | Currently, this parameter cannot be set for a certain microservice. For example, servicecomb.loadbalance.SessionStickinessRule.sessionTimeoutInSeconds cannot be set to servicecomb.loadbalance.DemoService.SessionStickinessRule.sessionTimeoutInSeconds | +| servicecomb.loadbalance.SessionStickinessRule.successiveFailedTimes | 5 | Integer | No | Specifies the number of failed requests from the client. If the number exceeds the set value, ServiceComb will switch to another server | Currently, this parameter cannot be set for a certain microservice. | +| servicecomb.loadbalance.retryEnabled | FALSE | Boolean | No | Specifies whether to call a service again when a exception is captured by the load balance. | - | +| servicecomb.loadbalance.retryOnNext | 0 | Integer | No | Specifies the number of attempts to connect to another server. | - | +| servicecomb.loadbalance.retryOnSame | 0 | Integer | No | Specifies the number of attempts to connect to the same server. | - | +| servicecomb.loadbalance.isolation.enabled | FALSE | Boolean | No | Specifies whether to enable faulty instance isolation. | - | +| servicecomb.loadbalance.isolation.enableRequestThreshold | 20 | Integer | No | Specifies the threshold number of instance calls. If this value is reached, isolation is enabled. | - | +| servicecomb.loadbalance.isolation.errorThresholdPercentage | 20 | Integer,\(0,100\] | No | Specifies the error percentage. Instance fault isolation is enabled when the set value is reached. | - | +| servicecomb.loadbalance.isolation.singleTestTime | 10000 | Integer | No | Specifies the duration of a faulty instance test on a single node. | This unit is ms. | +| servicecomb.loadbalance.transactionControl.policy | org.apache.servicecomb.loadbalance.filter.SimpleTransactionControlFilter | - | No | Specifies the offload policies for dynamic routing. | The framework provides simple offload mechanisms. You can also customize offload policies. | +| servicecomb.loadbalance.transactionControl.options | - | key/value pairs | No | Specifies the parameter configured for the SimpleTransactionControlFilter offload policy. You can add any filtration tag for this item. | - | ### Sample Code @@ -43,7 +43,7 @@ redirect_from: Configure a processing link: ```yaml -cse: +servicecomb: # other configurations omitted handler: chain: @@ -55,7 +55,7 @@ cse: Add a routing policy: ```yaml -cse: +servicecomb: # other configurations omitted loadbalance: NFLoadBalancerRuleClassName: com.netflix.loadbalancer.RoundRobinRule @@ -70,7 +70,7 @@ cse: * Compile the developed policy and ensure that the generated class is under classpath. -* Use the software development kit(SDK) to configure the routing policy. Use AbcRule as a routing policy example. The configuration is as follows: `cse.loadbalance.NFLoadBalancerRuleClassName=org.apache.servicecomb.ribbon.rule.AbcRule` +* Use the software development kit(SDK) to configure the routing policy. Use AbcRule as a routing policy example. The configuration is as follows: `servicecomb.loadbalance.NFLoadBalancerRuleClassName=org.apache.servicecomb.ribbon.rule.AbcRule` ## Rate Limiting Policy ### Scenario @@ -88,7 +88,7 @@ Users at the provider end can use the rate limiting policy to limit the maximum Rate limiting policies are configured in the microservice.yaml file. For related configuration items, see Table 2. To enable the rate limiting policy at the provider end, you also need to configure the rate limiting handler on the server in the processing chain and add dependencies in the pom.xml file. An example of microservice.yaml file configuration is as follows: ```yaml -cse: +servicecomb: handler: chain: Consumer: @@ -99,9 +99,9 @@ cse: | Configuration Item | Default Value | Value Range | Mandatory | Description | Remarks | | :--------------------------------------- | :------------------ | :----------------------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.flowcontrol.Provider.qps.enabled | true | true/false | No | Specifies whether to enable traffic control at the provider end. | - | -| cse.flowcontrol.Provider.qps.limit.\[ServiceName\] | 2147483647(max int) | \(0,2147483647\],Integer | No | Specifies the number of requests allowed per second. | This parameter can only be configured for microservice | -| cse.flowcontrol.Provider.qps.global.limit | 2147483647(max int) | (0,2147483647\],Integer | No | Specifies the total number of requests allowed per second at the provider end | If no configuration is set for any specific microservices, this parameter takes effect | +| servicecomb.flowcontrol.Provider.qps.enabled | true | true/false | No | Specifies whether to enable traffic control at the provider end. | - | +| servicecomb.flowcontrol.Provider.qps.limit.\[ServiceName\] | 2147483647(max int) | \(0,2147483647\],Integer | No | Specifies the number of requests allowed per second. | This parameter can only be configured for microservice | +| servicecomb.flowcontrol.Provider.qps.global.limit | 2147483647(max int) | (0,2147483647\],Integer | No | Specifies the total number of requests allowed per second at the provider end | If no configuration is set for any specific microservices, this parameter takes effect | ## ## Fallback Policy @@ -130,26 +130,26 @@ By configuring a fallback policy, you can handler microservice exceptions. | Configuration Item | Default value | Value Range | Mandatory | Description | Remarks | | :--------------------------------------- | :------------- | :---------------------------- | :-------- | :--------------------------------------- | :--------------------------------------- | -| cse.isolation.timeout.enabled | FALSE | - | No | Specifies whether to enable timeout detection. | | -| cse.isolation.timeoutInMilliseconds | 30000 | - | No | Specifies the timeout duration threshold. | | -| cse.isolation.maxConcurrentRequests | 10 | - | No | Specifies the maximum number of concurrent requests. | | -| cse.circuitBreaker.enabled | TRUE | - | No | Specifies whether to enable fallbreak. | | -| cse.circuitBreaker.forceOpen | FALSE | - | No | Specifies that fallbreak is enable regardless of the number of failed requests or the error rate. | | -| cse.circuitBreaker.forceClosed | FALSE | - | No | Specifies that fallbreak can be implemented at any time. | If this parameter and cse.circuitBreaker.forceOpen both need to be configured, cse.circuitBreaker.forceOpen has priority. | -| cse.circuitBreaker.sleepWindowInMilliseconds | 15000 | - | No | Specifies the duration needed to recover from fallbreak. | After the recovery, the number of failed requests will be recalculated. Not: If the consumer fails to send a request to the provider after the recovery, fallbreak is enabled again. | -| cse.circuitBreaker.requestVolumeThreshold | 20 | - | No | Specifies the threshold of failed requests sent within 10 seconds. If the threshold is reached, fallbreak is triggered. | Ten seconds will be divided into ten 1 seconds, and the error rate is calculated 1 second later after an error occurred. Therefore, fallbreak can be implemented at least 1 second after the call. | -| cse.circuitBreaker.errorThresholdPercentage | 50 | - | No | Specifies the threshold of error rate. If the threshold is reached, fallbreak is triggered. | | -| cse.fallback.enabled | TRUE | - | No | Specifies whether to enable troubleshooting measures after an error occurred. | | -| cse.fallback.maxConcurrentRequests | 10 | - | No | Specifies the number of fault tolerance(cse.fallbackpolicy.policy) requests concurrently called. If the value exceeds 10, the measures will no longer be called, and exception are returned. | | -| cse.fallbackpolicy.policy | throwexception | returnnulll \| throwexception | No | Specifies the error handling policies after an error occurred. | | - -**NOTE:** Be cautions when setting cse.isolation.timeout.enabled to TRUE, All processes are asynchronously processed in the system, and any error value returned by an intermediate process because the set timeout duration is reached can cause failure of the follow-up processes. Therefore, you are advised to keep the default value FALSE for cse.isolation.timeout.enabled. For timeout duration from the network aspect, you are advised to set cse.request.timeout=30000. +| servicecomb.isolation.timeout.enabled | FALSE | - | No | Specifies whether to enable timeout detection. | | +| servicecomb.isolation.timeoutInMilliseconds | 30000 | - | No | Specifies the timeout duration threshold. | | +| servicecomb.isolation.maxConcurrentRequests | 10 | - | No | Specifies the maximum number of concurrent requests. | | +| servicecomb.circuitBreaker.enabled | TRUE | - | No | Specifies whether to enable fallbreak. | | +| servicecomb.circuitBreaker.forceOpen | FALSE | - | No | Specifies that fallbreak is enable regardless of the number of failed requests or the error rate. | | +| servicecomb.circuitBreaker.forceClosed | FALSE | - | No | Specifies that fallbreak can be implemented at any time. | If this parameter and servicecomb.circuitBreaker.forceOpen both need to be configured, servicecomb.circuitBreaker.forceOpen has priority. | +| servicecomb.circuitBreaker.sleepWindowInMilliseconds | 15000 | - | No | Specifies the duration needed to recover from fallbreak. | After the recovery, the number of failed requests will be recalculated. Not: If the consumer fails to send a request to the provider after the recovery, fallbreak is enabled again. | +| servicecomb.circuitBreaker.requestVolumeThreshold | 20 | - | No | Specifies the threshold of failed requests sent within 10 seconds. If the threshold is reached, fallbreak is triggered. | Ten seconds will be divided into ten 1 seconds, and the error rate is calculated 1 second later after an error occurred. Therefore, fallbreak can be implemented at least 1 second after the call. | +| servicecomb.circuitBreaker.errorThresholdPercentage | 50 | - | No | Specifies the threshold of error rate. If the threshold is reached, fallbreak is triggered. | | +| servicecomb.fallback.enabled | TRUE | - | No | Specifies whether to enable troubleshooting measures after an error occurred. | | +| servicecomb.fallback.maxConcurrentRequests | 10 | - | No | Specifies the number of fault tolerance(servicecomb.fallbackpolicy.policy) requests concurrently called. If the value exceeds 10, the measures will no longer be called, and exception are returned. | | +| servicecomb.fallbackpolicy.policy | throwexception | returnnulll \| throwexception | No | Specifies the error handling policies after an error occurred. | | + +**NOTE:** Be cautions when setting servicecomb.isolation.timeout.enabled to TRUE, All processes are asynchronously processed in the system, and any error value returned by an intermediate process because the set timeout duration is reached can cause failure of the follow-up processes. Therefore, you are advised to keep the default value FALSE for servicecomb.isolation.timeout.enabled. For timeout duration from the network aspect, you are advised to set servicecomb.request.timeout=30000. {: .notice--warning} ## Sample Code ```yaml -cse: +servicecomb: handler: chain: Consumer: diff --git a/_users/setup-environment.md b/_users/setup-environment.md index fe3779c..564dead 100644 --- a/_users/setup-environment.md +++ b/_users/setup-environment.md @@ -181,7 +181,7 @@ As we can see here the Service-Center can auto-discover all the instances of the In your microservice.yaml you can provide the SC IP of both the instance or any one instance, sdk can auto-discover other instances and use the other instances to get microservice details in case of failure of the first one. ```yaml -cse: +servicecomb: service: registry: address: "http://10.12.0.1:30100,http://10.12.0.2:30100" diff --git a/_users/use-service-contract.md b/_users/use-service-contract.md index 5993c6a..2db8828 100644 --- a/_users/use-service-contract.md +++ b/_users/use-service-contract.md @@ -21,7 +21,7 @@ When a consumer calls a service from a provider, you need to register a service In the microservice.yaml file, configure a provider for the consumer. The following is an example of the configuration: ```yaml -cse: +servicecomb: # other configurations omitted references: springmvc: diff --git a/_users/use-tls.md b/_users/use-tls.md index b92cce3..d9e35fb 100644 --- a/_users/use-tls.md +++ b/_users/use-tls.md @@ -21,7 +21,7 @@ The configuration related to external service communication is set in the micro The connection between the microservice and the service and configuration centers can be changed from HTTP to HTTPS, enabling TLS communication. The configuration example is as below: ```yaml - cse: + servicecomb: service: registry: address: https://127.0.0.1:30100 @@ -31,7 +31,7 @@ The configuration related to external service communication is set in the micro When configuring the service listening address, the service provider can add`?sslEnabled=true` to the end of the address to enable TLS communication. For example: ```yaml - cse: + servicecomb: rest: address: 0.0.0.0:8080?sslEnabled=true highway: @@ -116,7 +116,7 @@ Table 3 Configuration file of the service center The configuration example of enabling the TLS communication in the microservicce.yaml file is as follows: ```yaml -cse: +servicecomb: service: registry: address: https://127.0.0.1:30100 diff --git a/_users/zuul.md b/_users/zuul.md index 8cd6cd5..5a7a313 100644 --- a/_users/zuul.md +++ b/_users/zuul.md @@ -97,7 +97,7 @@ This topic describes how to start a ZuulProxy application as the API Gateway. Pe service_description: name: discoveryGateway #Service Name version: 0.0.2 #Service Version - cse: + servicecomb: service: registry: address: http://127.0.0.1:30100 #Service Center registration @@ -126,7 +126,7 @@ APPLICATION_ID: discoverytest #same as ZuulProxy service_description: name: discoveryServer #Service name, which corresponds to that of zuul.routers version: 0.0.2 -cse: +servicecomb: service: registry: address: http://127.0.0.1:30100 #Service Center registration ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: us...@infra.apache.org With regards, Apache Git Services