From 84a9bd9a4c485aa824541223df6366c476d930bd Mon Sep 17 00:00:00 2001 From: buildmaster Date: Sat, 22 Feb 2020 13:41:31 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- reference/html/README.html | 16 ++-- reference/html/appendix.html | 7 +- reference/html/index.html | 92 +++++++++------------- reference/html/intro.html | 5 +- reference/html/sagan-index.html | 4 +- reference/html/spring-cloud-zookeeper.html | 92 +++++++++------------- 6 files changed, 84 insertions(+), 132 deletions(-) diff --git a/reference/html/README.html b/reference/html/README.html index 4678311c..c3292545 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -130,9 +130,8 @@ $(addBlockSwitches); autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few annotations, you can quickly enable and configure the common patterns inside your application and build large distributed systems with Zookeeper based -components. The provided patterns include Service Discovery and Configuration. Integration -with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing -(Ribbon), and Circuit Breaker (Hystrix).

+components. The provided patterns include Service Discovery and Configuration. The project +also provides client-side load-balancing via integration with Spring Cloud LoadBalancer.

@@ -140,11 +139,10 @@ with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load

1. Zookeeper overview

-

ZooKeeper is a centralized service for maintaining configuration information, naming, -providing distributed synchronization, and providing group services. See the -Zookeeper site for more information. Spring Cloud Zookeeper -also builds on the Apache Curator project, which started life -at Netflix.

+

ZooKeeper is a centralized service for maintaining configuration information, naming, providing distributed synchronization, and providing group services. +See the +Zookeeper site for more information. +Spring Cloud Zookeeper also builds on the Apache Curator project, which started life at Netflix.

@@ -157,7 +155,7 @@ at Netflix.

@@ -374,15 +373,15 @@ public String serviceUrl() {

Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient -implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cloud -Zookeeper.

+implementation you use. +Feign and Spring Cloud LoadBalancer also work with Spring Cloud Zookeeper.

-

3.1. Ribbon with Zookeeper

+

3.1. Spring Cloud LoadBalancer with Zookeeper

-

Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use -the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the -ZookeeperServerList by default.

+

Spring Cloud Zookeeper provides an implementation of Spring Cloud LoadBalancer ServiceInstanceListSupplier. +When you use the spring-cloud-starter-zookeeper-discovery, Spring Cloud LoadBalancer is autoconfigured to use the +ZookeeperServiceInstanceListSupplier by default.

@@ -418,15 +417,13 @@ public void registerThings() {

4.1. Instance Status

-

Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the -server. These instances are not returned as active service instances. This is useful for -behaviors such as blue/green deployments. (Note that the Curator Service Discovery recipe -does not support this behavior.) Taking advantage of the flexible payload has let Spring -Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then -filtering on that metadata in the Ribbon ZookeeperServerList. The ZookeeperServerList -filters out all non-null instance statuses that do not equal UP. If the instance status -field is empty, it is considered to be UP for backwards compatibility. To change the -status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry +

Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the server. +These instances are not returned as active service instances. +This is useful for behaviors such as blue/green deployments. +(Note that the Curator Service Discovery recipe does not support this behavior.) Taking advantage of the flexible payload has let Spring Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then filtering on that metadata in the Spring Cloud LoadBalancer ZookeeperServiceInstanceListSupplier. +The ZookeeperServiceInstanceListSupplier filters out all non-null instance statuses that do not equal UP. +If the instance status field is empty, it is considered to be UP for backwards compatibility. +To change the status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry instance status actuator endpoint, as shown in the following example:

@@ -536,15 +533,15 @@ name is spring.cloud.zookeeper.dependencies.

5.3.1. Aliases

-

Below the root property you have to represent each dependency as an alias. This is due to -the constraints of Ribbon, which requires that the application ID be placed in the URL. -Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). The alias -is the name you use instead of the serviceId for DiscoveryClient, Feign, or +

Below the root property you have to represent each dependency as an alias. +This is due to the constraints of Spring Cloud LoadBalancer, which requires that the application ID be placed in the URL. +Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). +The alias is the name you use instead of the serviceId for DiscoveryClient, Feign, or RestTemplate.

-

In the previous examples, the aliases are newsletter and mailing. The following -example shows Feign usage with a newsletter alias:

+

In the previous examples, the aliases are newsletter and mailing. +The following example shows Feign usage with a newsletter alias:

@@ -559,10 +556,10 @@ public interface NewsletterService {

5.3.2. Path

-

The path is represented by the path YAML property and is the path under which the -dependency is registered under Zookeeper. As described in the -previous section, Ribbon -operates on URLs. As a result, this path is not compliant with its requirement. +

The path is represented by the path YAML property and is the path under which the dependency is registered under Zookeeper. +As described in the +previous section, Spring Cloud LoadBalancer operates on URLs. +As a result, this path is not compliant with its requirement. That is why Spring Cloud Zookeeper maps the alias to the proper path.

@@ -572,9 +569,8 @@ That is why Spring Cloud Zookeeper maps the alias to the proper path.

The load balancer type is represented by loadBalancerType YAML property.

-

If you know what kind of load-balancing strategy has to be applied when calling this -particular dependency, you can provide it in the YAML file, and it is automatically -applied. You can choose one of the following load balancing strategies:

+

If you know what kind of load-balancing strategy has to be applied when calling this particular dependency, you can provide it in the YAML file, and it is automatically applied. +You can choose one of the following load balancing strategies:

    @@ -707,40 +703,24 @@ example:

    5.4. Configuring Spring Cloud Zookeeper Dependencies

    -

    You can set the following properties to enable or disable parts of Zookeeper Dependencies -functionalities:

    +

    You can set the following properties to enable or disable parts of Zookeeper Dependencies functionalities:

    • -

      spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use -Zookeeper Dependencies.

      +

      spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use Zookeeper Dependencies.

    • -

      spring.cloud.zookeeper.dependency.ribbon.enabled (enabled by default): Ribbon requires -either explicit global configuration or a particular one for a dependency. By turning on -this property, runtime load balancing strategy resolution is possible, and you can use the -loadBalancerType section of the Zookeeper Dependencies. The configuration that needs -this property has an implementation of LoadBalancerClient that delegates to the -ILoadBalancer presented in the next bullet.

      +

      spring.cloud.zookeeper.dependency.loadbalancer.enabled (enabled by default): Turns on Zookeeper-specific custom load-balancing strategies, including ZookeeperServiceInstanceListSupplier and dependency-based load-balanced RestTemplate setup.

    • -

      spring.cloud.zookeeper.dependency.ribbon.loadbalancer (enabled by default): Thanks to -this property, the custom ILoadBalancer knows that the part of the URI passed to Ribbon -might actually be the alias that has to be resolved to a proper path in Zookeeper. Without -this property, you cannot register applications under nested paths.

      +

      spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property registers a FeignBlockingLoadBalancerClient that automatically appends appropriate headers and content types with their versions, as presented in the Dependency configuration. +Without this setting, those two parameters do not work.

    • -

      spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property -registers a RibbonClient that automatically appends appropriate headers and content -types with their versions, as presented in the Dependency configuration. Without this -setting, those two parameters do not work.

      -
      • -
    • -

      spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When -enabled, this property modifies the request headers of a @LoadBalanced-annotated -RestTemplate such that it passes headers and content type with the version set in -dependency configuration. Without this setting, those two parameters do not work.

      +

      spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When enabled, this property modifies the request headers of a @LoadBalanced-annotated +RestTemplate such that it passes headers and content type with the version set in dependency configuration. +Without this setting, those two parameters do not work.

    diff --git a/reference/html/intro.html b/reference/html/intro.html index 3d2cd499..1d09767d 100644 --- a/reference/html/intro.html +++ b/reference/html/intro.html @@ -101,9 +101,8 @@ $(addBlockSwitches); autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few annotations, you can quickly enable and configure the common patterns inside your application and build large distributed systems with Zookeeper based -components. The provided patterns include Service Discovery and Configuration. Integration -with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing -(Ribbon), and Circuit Breaker (Hystrix).

    +components. The provided patterns include Service Discovery and Configuration. The project +also provides client-side load-balancing via integration with Spring Cloud LoadBalancer.

diff --git a/reference/html/sagan-index.html b/reference/html/sagan-index.html index 17cb48b8..a5db454c 100644 --- a/reference/html/sagan-index.html +++ b/reference/html/sagan-index.html @@ -117,10 +117,10 @@ $(addBlockSwitches);

Service Discovery: instances can be registered with Zookeeper and clients can discover the instances using Spring-managed beans

  • -

    Supports Ribbon, the client side load-balancer via Spring Cloud Netflix

    +

    Supports Spring Cloud LoadBalancer - client-side load-balancing solution

  • -

    Supports Zuul, a dynamic router and filter via Spring Cloud Netflix

    +

    Supports Spring Cloud OpenFeign

  • Distributed Configuration: using Zookeeper as a data store

    diff --git a/reference/html/spring-cloud-zookeeper.html b/reference/html/spring-cloud-zookeeper.html index 952fe196..8e6e6367 100644 --- a/reference/html/spring-cloud-zookeeper.html +++ b/reference/html/spring-cloud-zookeeper.html @@ -106,7 +106,7 @@ $(addBlockSwitches);
  • 3. Using Spring Cloud Zookeeper with Spring Cloud Netflix Components
  • 4. Spring Cloud Zookeeper and Service Registry @@ -147,9 +147,8 @@ $(addBlockSwitches); autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few annotations, you can quickly enable and configure the common patterns inside your application and build large distributed systems with Zookeeper based -components. The provided patterns include Service Discovery and Configuration. Integration -with Spring Cloud Netflix provides Intelligent Routing (Zuul), Client Side Load Balancing -(Ribbon), and Circuit Breaker (Hystrix).

    +components. The provided patterns include Service Discovery and Configuration. The project +also provides client-side load-balancing via integration with Spring Cloud LoadBalancer.

    • @@ -374,15 +373,15 @@ public String serviceUrl() {

    Spring Cloud Netflix supplies useful tools that work regardless of which DiscoveryClient -implementation you use. Feign, Turbine, Ribbon, and Zuul all work with Spring Cloud -Zookeeper.

    +implementation you use. +Feign and Spring Cloud LoadBalancer also work with Spring Cloud Zookeeper.

    -

    3.1. Ribbon with Zookeeper

    +

    3.1. Spring Cloud LoadBalancer with Zookeeper

    -

    Spring Cloud Zookeeper provides an implementation of Ribbon’s ServerList. When you use -the spring-cloud-starter-zookeeper-discovery, Ribbon is autoconfigured to use the -ZookeeperServerList by default.

    +

    Spring Cloud Zookeeper provides an implementation of Spring Cloud LoadBalancer ServiceInstanceListSupplier. +When you use the spring-cloud-starter-zookeeper-discovery, Spring Cloud LoadBalancer is autoconfigured to use the +ZookeeperServiceInstanceListSupplier by default.

    @@ -418,15 +417,13 @@ public void registerThings() {

    4.1. Instance Status

    -

    Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the -server. These instances are not returned as active service instances. This is useful for -behaviors such as blue/green deployments. (Note that the Curator Service Discovery recipe -does not support this behavior.) Taking advantage of the flexible payload has let Spring -Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then -filtering on that metadata in the Ribbon ZookeeperServerList. The ZookeeperServerList -filters out all non-null instance statuses that do not equal UP. If the instance status -field is empty, it is considered to be UP for backwards compatibility. To change the -status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry +

    Netflix Eureka supports having instances that are OUT_OF_SERVICE registered with the server. +These instances are not returned as active service instances. +This is useful for behaviors such as blue/green deployments. +(Note that the Curator Service Discovery recipe does not support this behavior.) Taking advantage of the flexible payload has let Spring Cloud Zookeeper implement OUT_OF_SERVICE by updating some specific metadata and then filtering on that metadata in the Spring Cloud LoadBalancer ZookeeperServiceInstanceListSupplier. +The ZookeeperServiceInstanceListSupplier filters out all non-null instance statuses that do not equal UP. +If the instance status field is empty, it is considered to be UP for backwards compatibility. +To change the status of an instance, make a POST with OUT_OF_SERVICE to the ServiceRegistry instance status actuator endpoint, as shown in the following example:

    @@ -536,15 +533,15 @@ name is spring.cloud.zookeeper.dependencies.

    5.3.1. Aliases

    -

    Below the root property you have to represent each dependency as an alias. This is due to -the constraints of Ribbon, which requires that the application ID be placed in the URL. -Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). The alias -is the name you use instead of the serviceId for DiscoveryClient, Feign, or +

    Below the root property you have to represent each dependency as an alias. +This is due to the constraints of Spring Cloud LoadBalancer, which requires that the application ID be placed in the URL. +Consequently, you cannot pass any complex path, suchas /myApp/myRoute/name). +The alias is the name you use instead of the serviceId for DiscoveryClient, Feign, or RestTemplate.

    -

    In the previous examples, the aliases are newsletter and mailing. The following -example shows Feign usage with a newsletter alias:

    +

    In the previous examples, the aliases are newsletter and mailing. +The following example shows Feign usage with a newsletter alias:

    @@ -559,10 +556,10 @@ public interface NewsletterService {

    5.3.2. Path

    -

    The path is represented by the path YAML property and is the path under which the -dependency is registered under Zookeeper. As described in the -previous section, Ribbon -operates on URLs. As a result, this path is not compliant with its requirement. +

    The path is represented by the path YAML property and is the path under which the dependency is registered under Zookeeper. +As described in the +previous section, Spring Cloud LoadBalancer operates on URLs. +As a result, this path is not compliant with its requirement. That is why Spring Cloud Zookeeper maps the alias to the proper path.

    @@ -572,9 +569,8 @@ That is why Spring Cloud Zookeeper maps the alias to the proper path.

    The load balancer type is represented by loadBalancerType YAML property.

    -

    If you know what kind of load-balancing strategy has to be applied when calling this -particular dependency, you can provide it in the YAML file, and it is automatically -applied. You can choose one of the following load balancing strategies:

    +

    If you know what kind of load-balancing strategy has to be applied when calling this particular dependency, you can provide it in the YAML file, and it is automatically applied. +You can choose one of the following load balancing strategies:

      @@ -707,40 +703,24 @@ example:

      5.4. Configuring Spring Cloud Zookeeper Dependencies

      -

      You can set the following properties to enable or disable parts of Zookeeper Dependencies -functionalities:

      +

      You can set the following properties to enable or disable parts of Zookeeper Dependencies functionalities:

      • -

        spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use -Zookeeper Dependencies.

        +

        spring.cloud.zookeeper.dependencies: If you do not set this property, you cannot use Zookeeper Dependencies.

      • -

        spring.cloud.zookeeper.dependency.ribbon.enabled (enabled by default): Ribbon requires -either explicit global configuration or a particular one for a dependency. By turning on -this property, runtime load balancing strategy resolution is possible, and you can use the -loadBalancerType section of the Zookeeper Dependencies. The configuration that needs -this property has an implementation of LoadBalancerClient that delegates to the -ILoadBalancer presented in the next bullet.

        +

        spring.cloud.zookeeper.dependency.loadbalancer.enabled (enabled by default): Turns on Zookeeper-specific custom load-balancing strategies, including ZookeeperServiceInstanceListSupplier and dependency-based load-balanced RestTemplate setup.

      • -

        spring.cloud.zookeeper.dependency.ribbon.loadbalancer (enabled by default): Thanks to -this property, the custom ILoadBalancer knows that the part of the URI passed to Ribbon -might actually be the alias that has to be resolved to a proper path in Zookeeper. Without -this property, you cannot register applications under nested paths.

        +

        spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property registers a FeignBlockingLoadBalancerClient that automatically appends appropriate headers and content types with their versions, as presented in the Dependency configuration. +Without this setting, those two parameters do not work.

      • -

        spring.cloud.zookeeper.dependency.headers.enabled (enabled by default): This property -registers a RibbonClient that automatically appends appropriate headers and content -types with their versions, as presented in the Dependency configuration. Without this -setting, those two parameters do not work.

        -
        • -
      • -

        spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When -enabled, this property modifies the request headers of a @LoadBalanced-annotated -RestTemplate such that it passes headers and content type with the version set in -dependency configuration. Without this setting, those two parameters do not work.

        +

        spring.cloud.zookeeper.dependency.resttemplate.enabled (enabled by default): When enabled, this property modifies the request headers of a @LoadBalanced-annotated +RestTemplate such that it passes headers and content type with the version set in dependency configuration. +Without this setting, those two parameters do not work.