Remove Ribbon, Hystrix, Zuul and Turbine references from docs and checkstyle.
This commit is contained in:
Olga MaciaszekSharma
@@ -11,13 +11,7 @@ include::intro.adoc[]
|
||||
|
||||
* Service Discovery: Eureka instances can be registered and clients can discover the instances using Spring-managed beans
|
||||
* Service Discovery: an embedded Eureka server can be created with declarative Java configuration
|
||||
* Circuit Breaker: Hystrix clients can be built with a simple annotation-driven method decorator
|
||||
* Circuit Breaker: embedded Hystrix dashboard with declarative Java configuration
|
||||
* Client Side Load Balancer: Ribbon
|
||||
* External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions)
|
||||
* Router and Filter: automatic registration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation
|
||||
|
||||
include::maintenance-mode.adoc[]
|
||||
|
||||
== Building
|
||||
|
||||
|
||||
@@ -4,6 +4,5 @@ This project provides Netflix OSS integrations for Spring Boot apps through auto
|
||||
and binding to the Spring Environment and other Spring programming model idioms. With a few
|
||||
simple annotations you can quickly enable and configure the common patterns inside your
|
||||
application and build large distributed systems with battle-tested Netflix components. The
|
||||
patterns provided include Service Discovery (Eureka), Circuit Breaker (Hystrix),
|
||||
Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon).
|
||||
patterns provided include Service Discovery (Eureka).
|
||||
|
||||
|
||||
@@ -1,25 +0,0 @@
|
||||
include::_attributes.adoc[]
|
||||
|
||||
== Modules In Maintenance Mode
|
||||
|
||||
Placing a module in maintenance mode means that the Spring Cloud team will no longer be adding new features to the module.
|
||||
We will fix blocker bugs and security issues, and we will also consider and review small pull requests from the community.
|
||||
|
||||
We intend to continue to support these modules for a period of at least a year from the general availability
|
||||
of the Greenwich release train.
|
||||
|
||||
The following Spring Cloud Netflix modules and corresponding starters will be placed into maintenance mode:
|
||||
|
||||
* spring-cloud-netflix-archaius
|
||||
* spring-cloud-netflix-concurrency-limits
|
||||
* spring-cloud-netflix-hystrix-contract
|
||||
* spring-cloud-netflix-hystrix-dashboard
|
||||
* spring-cloud-netflix-hystrix-stream
|
||||
* spring-cloud-netflix-hystrix
|
||||
* spring-cloud-netflix-ribbon
|
||||
* spring-cloud-netflix-turbine-stream
|
||||
* spring-cloud-netflix-turbine
|
||||
* spring-cloud-netflix-zuul
|
||||
|
||||
NOTE: This does not include the Eureka modules.
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
Spring Cloud Netflix provides Netflix OSS integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few simple annotations you can quickly enable and configure the common patterns inside your application and build large distributed systems with battle-tested Netflix components. The patterns provided include Service Discovery (Eureka), Circuit Breaker (Hystrix), Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon)..
|
||||
Spring Cloud Netflix provides Netflix OSS integrations for Spring Boot apps through autoconfiguration and binding to the Spring Environment and other Spring programming model idioms. With a few simple annotations you can quickly enable and configure the common patterns inside your application and build large distributed systems with battle-tested Netflix components. The patterns provided include Service Discovery (Eureka).
|
||||
|
||||
## Features
|
||||
|
||||
@@ -6,12 +6,6 @@ Spring Cloud Netflix features:
|
||||
|
||||
* Service Discovery: Eureka instances can be registered and clients can discover the instances using Spring-managed beans
|
||||
* Service Discovery: an embedded Eureka server can be created with declarative Java configuration
|
||||
* Circuit Breaker: Hystrix clients can be built with a simple annotation-driven method decorator
|
||||
* Circuit Breaker: embedded Hystrix dashboard with declarative Java configuration
|
||||
* Declarative REST Client: Feign creates a dynamic implementation of an interface decorated with JAX-RS or Spring MVC annotations
|
||||
* Client Side Load Balancer: Ribbon
|
||||
* External Configuration: a bridge from the Spring Environment to Archaius (enables native configuration of Netflix components using Spring Boot conventions)
|
||||
* Router and Filter: automatic registration of Zuul filters, and a simple convention over configuration approach to reverse proxy creation
|
||||
|
||||
## Getting Started
|
||||
|
||||
|
||||
@@ -292,7 +292,6 @@ The following example shows the dependencies you need to add:
|
||||
You need not use the raw Netflix `EurekaClient`.
|
||||
Also, it is usually more convenient to use it behind a wrapper of some sort.
|
||||
Spring Cloud has support for <<spring-cloud-feign, Feign>> (a REST client builder) and <<spring-cloud-ribbon, Spring `RestTemplate`>> through the logical Eureka service identifiers (VIPs) instead of physical URLs.
|
||||
To configure Ribbon with a fixed list of physical servers, you can set `<client>.ribbon.listOfServers` to a comma-separated list of physical addresses (or hostnames), where `<client>` is the ID of the client.
|
||||
|
||||
You can also use the `org.springframework.cloud.client.discovery.DiscoveryClient`, which provides a simple API (not specific to Netflix) for discovery clients, as shown in the following example:
|
||||
|
||||
@@ -440,8 +439,6 @@ Clients also have an in-memory cache of Eureka registrations (so they do not hav
|
||||
By default, every Eureka server is also a Eureka client and requires (at least one) service URL to locate a peer.
|
||||
If you do not provide it, the service runs and works, but it fills your logs with a lot of noise about not being able to register with the peer.
|
||||
|
||||
See also <<spring-cloud-ribbon,below for details of Ribbon support>> on the client side for Zones and Regions.
|
||||
|
||||
[[spring-cloud-eureka-server-standalone-mode]]
|
||||
=== Standalone Mode
|
||||
|
||||
|
||||
@@ -3,44 +3,12 @@
|
||||
"-//Puppy Crawl//DTD Suppressions 1.1//EN"
|
||||
"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
|
||||
<suppressions>
|
||||
<suppress files=".*OkHttpRibbonResponse\.java" checks="IllegalImportCheck"/>
|
||||
<suppress files=".*RibbonApacheHttpResponse\.java" checks="IllegalImportCheck"/>
|
||||
<suppress files=".*TurbineApplication\.java" checks="HideUtilityClassConstructorCheck"/>
|
||||
<suppress files=".*SpringAggregatorFactory\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*HystrixDashboardConfiguration\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*EurekaHealthCheckHandler\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RestClientRibbonCommand\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*AbstractRibbonCommand\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*ContextPathZuulProxyApplicationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RetryableRibbonLoadBalancingHttpClient\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*CustomHostRoutingFilterTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*HystrixDashboardConfigurationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*ServletPathZuulProxyApplicationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*TurbineStreamTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*InstanceRegistryTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RibbonClientConfigurationIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*HystrixStreamEndpointTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*EurekaCustomPeerNodesTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*EurekaHealthCheckTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*HttpClientRibbonCommandIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*HttpClientRibbonRetryIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*HystrixStreamEndpointTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*OkHttpRibbonCommandFallbackTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*OkHttpRibbonCommandIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*OkHttpRibbonRetryIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RefreshablePeerEurekaNodesTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RestClientRibbonCommandFallbackTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RestClientRibbonCommandIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*RibbonRoutingFilterLoadBalancerKeyIntegrationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*SimpleZuulProxyApplicationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*TurbineHttpTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*ZuulProxyApplicationTests\.java" checks="LineLengthCheck"/>
|
||||
<suppress files=".*PatternServiceRouteMapper\.java" checks="JavadocTagContinuationIndentationCheck"/>
|
||||
<suppress files=".*PatternServiceRouteMapper\.java" checks="AtclauseOrder"/>
|
||||
<suppress files=".*PatternServiceRouteMapper\.java" checks="NonEmptyAtclauseDescription"/>
|
||||
<suppress files=".*EurekaRegistration\.java" checks="FinalClass"/>
|
||||
<suppress files=".*RequestVerifierFilter\.java" checks="FinalClass"/>
|
||||
<suppress files=".*RibbonClientHttpRequestFactoryTests\.java" checks="JavadocVariable"/>
|
||||
<suppress files=".*TestAutoConfiguration\.java" checks="HideUtilityClassConstructor"/>
|
||||
<suppress files=".*TestAutoConfiguration\.java" checks="JavadocStyle"/>
|
||||
<suppress files=".*TestAutoConfiguration\.java" checks="JavadocStyle"/>
|
||||
|
||||
Reference in New Issue
Block a user