diff --git a/reference/html/appendix.html b/reference/html/appendix.html index 7dccf073..1b737755 100644 --- a/reference/html/appendix.html +++ b/reference/html/appendix.html @@ -300,11 +300,6 @@ Also, you can define your own properties. -

spring.cloud.loadbalancer.ribbon.enabled

-

true

-

Causes RibbonLoadBalancerClient to be used by default.

- -

spring.cloud.refresh.enabled

true

Enables autoconfiguration for the refresh scope and associated features.

diff --git a/reference/html/index.html b/reference/html/index.html index 5ecf0b04..5e7635e4 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -834,8 +834,7 @@ Individual applications must create it.

The URI needs to use a virtual host name (that is, a service name, not a host name). -The Ribbon client is used to create a full physical address. -See {githubroot}/spring-cloud-netflix/blob/master/spring-cloud-netflix-ribbon/src/main/java/org/springframework/cloud/netflix/ribbon/RibbonAutoConfiguration.java[RibbonAutoConfiguration] for the details of how the RestTemplate is set up.

+The BlockingLoadBalancerClient is used to create a full physical address.

@@ -845,24 +844,7 @@ See {githubroot}/spring-cloud-netflix/blob/master/spring-cloud-netflix-ribbon/sr - -
To use a load-balanced RestTemplate, you need to have a load-balancer implementation in your classpath. -The recommended implementation is BlockingLoadBalancerClient. Add Spring Cloud LoadBalancer starter to your project in order to use it. -The -RibbonLoadBalancerClient also can be used, but it’s now under maintenance and we do not recommend adding it to new projects. -
-
-
- - - -
- - -By default, if you have both RibbonLoadBalancerClient and BlockingLoadBalancerClient, to -preserve backward compatibility, RibbonLoadBalancerClient is used. -To override it, you can set the spring.cloud.loadbalancer.ribbon.enabled property to false.
@@ -903,7 +885,7 @@ public class MyClass {

The URI needs to use a virtual host name (that is, a service name, not a host name). -The Ribbon client or Spring Cloud LoadBalancer is used to create a full physical address.

+The Spring Cloud LoadBalancer is used to create a full physical address.

@@ -916,13 +898,6 @@ If you want to use a @LoadBalanced WebClient.Builder, you need to h implementation in the classpath. We recommend that you add the Spring Cloud LoadBalancer starter to your project. Then, ReactiveLoadBalancer is used underneath. -Alternatively, this functionality also works with spring-cloud-starter-netflix-ribbon, but the request -is handled by a non-reactive LoadBalancerClient under the hood. Additionally, -spring-cloud-starter-netflix-ribbon is already in maintenance mode, so we do not recommend -adding it to new projects. -If you have both spring-cloud-starter-loadbalancer and spring-cloud-starter-netflix-ribbon -in your classpath, Ribbon is used by default. To switch to Spring Cloud LoadBalancer, -set the spring.cloud.loadbalancer.ribbon.enabled property to false.
@@ -933,10 +908,7 @@ set the spring.cloud.loadbalancer.ribbon.enabled property to

A load-balanced RestTemplate can be configured to retry failed requests. By default, this logic is disabled. You can enable it by adding Spring Retry to your application’s classpath. -The load-balanced RestTemplate honors some of the Ribbon configuration values related to retrying failed requests. -You can use client.ribbon.MaxAutoRetries, client.ribbon.MaxAutoRetriesNextServer, and client.ribbon.OkToRetryOnAllOperations properties. -If you would like to disable the retry logic with Spring Retry on the classpath, you can set spring.cloud.loadbalancer.retry.enabled=false. -See the Ribbon documentation for a description of what these properties do.

+If you would like to disable the retry logic with Spring Retry on the classpath, you can set spring.cloud.loadbalancer.retry.enabled=false.

If you would like to implement a BackOffPolicy in your retries, you need to create a bean of type LoadBalancedRetryFactory and override the createBackOffPolicy method:

@@ -961,18 +933,6 @@ public class MyConfiguration {
-
- - - - - -
- - -client in the preceding examples should be replaced with your Ribbon client’s name. -
-

If you want to add one or more RetryListener implementations to your retry functionality, you need to create a bean of type LoadBalancedRetryListenerFactory and return the RetryListener array @@ -1185,28 +1145,11 @@ The following example shows how to configure a WebClient to use rea

The URI needs to use a virtual host name (that is, a service name, not a host name). The ReactorLoadBalancer is used to create a full physical address.

-
- - - - - -
- - -By default, if you have spring-cloud-netflix-ribbon in your classpath, LoadBalancerExchangeFilterFunction -is used to maintain backward compatibility. To use -ReactorLoadBalancerExchangeFilterFunction, set the spring.cloud.loadbalancer.ribbon.enabled property -to false. -
-

2.7.2. Spring WebFlux WebClient with a Non-reactive Load Balancer Client

-

If you you do not have Spring Cloud LoadBalancer starter in your project -but you do have spring-cloud-starter-netflix-ribbon, you can still use WebClient with LoadBalancerClient. -If spring-webflux is on the classpath, LoadBalancerExchangeFilterFunction +

If spring-webflux is on the classpath, LoadBalancerExchangeFilterFunction is auto-configured. Note, however, that this uses a non-reactive client under the hood. The following example shows how to configure a WebClient to use load-balancer:

@@ -1695,19 +1638,6 @@ and Evictor.
-
- - - - - -
- - -If you have both Ribbon and Spring Cloud LoadBalancer int the classpath, in order to maintain backward compatibility, Ribbon-based implementations will be used by default. -In order to switch to using Spring Cloud LoadBalancer under the hood, make sure you set the property spring.cloud.loadbalancer.ribbon.enabled to false. -
-

3.6. Passing Your Own Spring Cloud LoadBalancer Configuration

diff --git a/reference/html/spring-cloud-commons.html b/reference/html/spring-cloud-commons.html index 5ecf0b04..5e7635e4 100644 --- a/reference/html/spring-cloud-commons.html +++ b/reference/html/spring-cloud-commons.html @@ -834,8 +834,7 @@ Individual applications must create it.

The URI needs to use a virtual host name (that is, a service name, not a host name). -The Ribbon client is used to create a full physical address. -See {githubroot}/spring-cloud-netflix/blob/master/spring-cloud-netflix-ribbon/src/main/java/org/springframework/cloud/netflix/ribbon/RibbonAutoConfiguration.java[RibbonAutoConfiguration] for the details of how the RestTemplate is set up.

+The BlockingLoadBalancerClient is used to create a full physical address.

@@ -845,24 +844,7 @@ See {githubroot}/spring-cloud-netflix/blob/master/spring-cloud-netflix-ribbon/sr - -
To use a load-balanced RestTemplate, you need to have a load-balancer implementation in your classpath. -The recommended implementation is BlockingLoadBalancerClient. Add Spring Cloud LoadBalancer starter to your project in order to use it. -The -RibbonLoadBalancerClient also can be used, but it’s now under maintenance and we do not recommend adding it to new projects. -
-
-
- - - -
- - -By default, if you have both RibbonLoadBalancerClient and BlockingLoadBalancerClient, to -preserve backward compatibility, RibbonLoadBalancerClient is used. -To override it, you can set the spring.cloud.loadbalancer.ribbon.enabled property to false.
@@ -903,7 +885,7 @@ public class MyClass {

The URI needs to use a virtual host name (that is, a service name, not a host name). -The Ribbon client or Spring Cloud LoadBalancer is used to create a full physical address.

+The Spring Cloud LoadBalancer is used to create a full physical address.

@@ -916,13 +898,6 @@ If you want to use a @LoadBalanced WebClient.Builder, you need to h implementation in the classpath. We recommend that you add the Spring Cloud LoadBalancer starter to your project. Then, ReactiveLoadBalancer is used underneath. -Alternatively, this functionality also works with spring-cloud-starter-netflix-ribbon, but the request -is handled by a non-reactive LoadBalancerClient under the hood. Additionally, -spring-cloud-starter-netflix-ribbon is already in maintenance mode, so we do not recommend -adding it to new projects. -If you have both spring-cloud-starter-loadbalancer and spring-cloud-starter-netflix-ribbon -in your classpath, Ribbon is used by default. To switch to Spring Cloud LoadBalancer, -set the spring.cloud.loadbalancer.ribbon.enabled property to false.
@@ -933,10 +908,7 @@ set the spring.cloud.loadbalancer.ribbon.enabled property to

A load-balanced RestTemplate can be configured to retry failed requests. By default, this logic is disabled. You can enable it by adding Spring Retry to your application’s classpath. -The load-balanced RestTemplate honors some of the Ribbon configuration values related to retrying failed requests. -You can use client.ribbon.MaxAutoRetries, client.ribbon.MaxAutoRetriesNextServer, and client.ribbon.OkToRetryOnAllOperations properties. -If you would like to disable the retry logic with Spring Retry on the classpath, you can set spring.cloud.loadbalancer.retry.enabled=false. -See the Ribbon documentation for a description of what these properties do.

+If you would like to disable the retry logic with Spring Retry on the classpath, you can set spring.cloud.loadbalancer.retry.enabled=false.

If you would like to implement a BackOffPolicy in your retries, you need to create a bean of type LoadBalancedRetryFactory and override the createBackOffPolicy method:

@@ -961,18 +933,6 @@ public class MyConfiguration {
-
- - - - - -
- - -client in the preceding examples should be replaced with your Ribbon client’s name. -
-

If you want to add one or more RetryListener implementations to your retry functionality, you need to create a bean of type LoadBalancedRetryListenerFactory and return the RetryListener array @@ -1185,28 +1145,11 @@ The following example shows how to configure a WebClient to use rea

The URI needs to use a virtual host name (that is, a service name, not a host name). The ReactorLoadBalancer is used to create a full physical address.

-
- - - - - -
- - -By default, if you have spring-cloud-netflix-ribbon in your classpath, LoadBalancerExchangeFilterFunction -is used to maintain backward compatibility. To use -ReactorLoadBalancerExchangeFilterFunction, set the spring.cloud.loadbalancer.ribbon.enabled property -to false. -
-

2.7.2. Spring WebFlux WebClient with a Non-reactive Load Balancer Client

-

If you you do not have Spring Cloud LoadBalancer starter in your project -but you do have spring-cloud-starter-netflix-ribbon, you can still use WebClient with LoadBalancerClient. -If spring-webflux is on the classpath, LoadBalancerExchangeFilterFunction +

If spring-webflux is on the classpath, LoadBalancerExchangeFilterFunction is auto-configured. Note, however, that this uses a non-reactive client under the hood. The following example shows how to configure a WebClient to use load-balancer:

@@ -1695,19 +1638,6 @@ and Evictor.
-
- - - - - -
- - -If you have both Ribbon and Spring Cloud LoadBalancer int the classpath, in order to maintain backward compatibility, Ribbon-based implementations will be used by default. -In order to switch to using Spring Cloud LoadBalancer under the hood, make sure you set the property spring.cloud.loadbalancer.ribbon.enabled to false. -
-

3.6. Passing Your Own Spring Cloud LoadBalancer Configuration