diff --git a/1.3.x/multi/multi_spring-cloud-consul-bus.html b/1.3.x/multi/multi_spring-cloud-consul-bus.html index cf20c45b..c36898ac 100644 --- a/1.3.x/multi/multi_spring-cloud-consul-bus.html +++ b/1.3.x/multi/multi_spring-cloud-consul-bus.html @@ -1,3 +1,3 @@ - 6. Spring Cloud Bus with Consul
6. Spring Cloud Bus with Consul
Prev   Next

6. Spring Cloud Bus with Consul

6.1 How to activate

To get started with the Consul Bus use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-bus. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.

See the Spring Cloud Bus documentation for the available actuator endpoints and howto send custom messages.

Prev   Next
5. Consul Retry Home 7. Circuit Breaker with Hystrix
\ No newline at end of file + 6. Spring Cloud Bus with Consul
6. Spring Cloud Bus with Consul
Prev   Next

6. Spring Cloud Bus with Consul

6.1 How to activate

To get started with the Consul Bus use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-bus. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.

See the Spring Cloud Bus documentation for the available actuator endpoints and howto send custom messages.

Prev   Next
5. Consul Retry Home 7. Circuit Breaker with Hystrix
\ No newline at end of file diff --git a/1.3.x/multi/multi_spring-cloud-consul-config.html b/1.3.x/multi/multi_spring-cloud-consul-config.html index ee143324..8e55e03f 100644 --- a/1.3.x/multi/multi_spring-cloud-consul-config.html +++ b/1.3.x/multi/multi_spring-cloud-consul-config.html @@ -3,7 +3,7 @@ 4. Distributed Configuration with Consul
4. Distributed Configuration with Consul
Prev   Next

4. Distributed Configuration with Consul

Consul provides a Key/Value Store for storing configuration and other metadata. Spring Cloud Consul Config is an alternative to the Config Server and Client. Configuration is loaded into the Spring Environment during the special "bootstrap" phase. Configuration is stored in the /config folder by default. Multiple PropertySource instances are created based on the application’s name and the active profiles that mimicks the Spring Cloud Config order of resolving properties. For example, an application with the name "testApp" and with the "dev" profile will have the following property sources created:

config/testApp,dev/
 config/testApp/
 config/application,dev/
-config/application/

The most specific property source is at the top, with the least specific at the bottom. Properties in the config/application folder are applicable to all applications using consul for configuration. Properties in the config/testApp folder are only available to the instances of the service named "testApp".

Configuration is currently read on startup of the application. Sending a HTTP POST to /refresh will cause the configuration to be reloaded. Section 4.3, “Config Watch” will also automatically detect changes and reload the application context.

4.1 How to activate

To get started with Consul Configuration use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-config. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.

This will enable auto-configuration that will setup Spring Cloud Consul Config.

4.2 Customizing

Consul Config may be customized using the following properties:

bootstrap.yml.  +config/application/

The most specific property source is at the top, with the least specific at the bottom. Properties in the config/application folder are applicable to all applications using consul for configuration. Properties in the config/testApp folder are only available to the instances of the service named "testApp".

Configuration is currently read on startup of the application. Sending a HTTP POST to /refresh will cause the configuration to be reloaded. Section 4.3, “Config Watch” will also automatically detect changes and reload the application context.

4.1 How to activate

To get started with Consul Configuration use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-config. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.

This will enable auto-configuration that will setup Spring Cloud Consul Config.

4.2 Customizing

Consul Config may be customized using the following properties:

bootstrap.yml.  

spring:
   cloud:
     consul:
diff --git a/1.3.x/multi/multi_spring-cloud-consul-discovery.html b/1.3.x/multi/multi_spring-cloud-consul-discovery.html
index 6901e68f..d0d21e90 100644
--- a/1.3.x/multi/multi_spring-cloud-consul-discovery.html
+++ b/1.3.x/multi/multi_spring-cloud-consul-discovery.html
@@ -1,6 +1,6 @@
 
       
-   3. Service Discovery with Consul
3. Service Discovery with Consul
Prev   Next
3. Service Discovery with Consul
Service Discovery is one of the key tenets of a microservice based architecture. Trying to hand configure each client or some form of convention can be very difficult to do and can be very brittle.  Consul provides Service Discovery services via an HTTP API and DNS.  Spring Cloud Consul leverages the HTTP API for service registration and discovery.  This does not prevent non-Spring Cloud applications from leveraging the DNS interface.  Consul Agents servers are run in a cluster that communicates via a gossip protocol and uses the Raft consensus protocol.
3.1 How to activate
To activate Consul Service Discovery use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-discovery. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
3.2 Registering with Consul
When a client registers with Consul, it provides meta-data about itself such as host and port, id, name and tags.  An HTTP Check is created by default that Consul hits the /health endpoint every 10 seconds.  If the health check fails, the service instance is marked as critical.
Example Consul client:
@SpringBootApplication
+   3. Service Discovery with Consul
3. Service Discovery with Consul
Prev   Next
3. Service Discovery with Consul
Service Discovery is one of the key tenets of a microservice based architecture. Trying to hand configure each client or some form of convention can be very difficult to do and can be very brittle.  Consul provides Service Discovery services via an HTTP API and DNS.  Spring Cloud Consul leverages the HTTP API for service registration and discovery.  This does not prevent non-Spring Cloud applications from leveraging the DNS interface.  Consul Agents servers are run in a cluster that communicates via a gossip protocol and uses the Raft consensus protocol.
3.1 How to activate
To activate Consul Service Discovery use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-discovery. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
3.2 Registering with Consul
When a client registers with Consul, it provides meta-data about itself such as host and port, id, name and tags.  An HTTP Check is created by default that Consul hits the /health endpoint every 10 seconds.  If the health check fails, the service instance is marked as critical.
Example Consul client:
@SpringBootApplication
 @RestController
 public class Application {
 
@@ -39,7 +39,7 @@
       discovery:
         instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

 
With this metadata, and multiple service instances deployed on localhost, the random value will kick in there to make the instance unique. In Cloudfoundry the vcap.application.instance_id will be populated automatically in a Spring Boot application, so the random value will not be needed.
3.4 Looking up services
3.4.1 Using Ribbon
Spring Cloud has support for Feign (a REST client builder) and also Spring RestTemplate
-for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize Ribbon for client-side load balancing.
If you want to access service STORES using the RestTemplate simply declare:
@LoadBalanced
+for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize Ribbon for client-side load balancing.
If you want to access service STORES using the RestTemplate simply declare:
@LoadBalanced
 @Bean
 public RestTemplate loadbalancedRestTemplate() {
      new RestTemplate();
diff --git a/1.3.x/multi/multi_spring-cloud-consul-hystrix.html b/1.3.x/multi/multi_spring-cloud-consul-hystrix.html
index 9c1cc1c3..d1783ab8 100644
--- a/1.3.x/multi/multi_spring-cloud-consul-hystrix.html
+++ b/1.3.x/multi/multi_spring-cloud-consul-hystrix.html
@@ -1,3 +1,3 @@
 
       
-   7. Circuit Breaker with Hystrix
7. Circuit Breaker with Hystrix
Prev   Next
7. Circuit Breaker with Hystrix
Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: spring-cloud-starter-hystrix.  Hystrix doesn’t depend on the Netflix Discovery Client. The @EnableHystrix annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with @HystrixCommand to be protected by a circuit breaker. See the documentation for more details.
Prev   Next
6. Spring Cloud Bus with Consul Home 8. Hystrix metrics aggregation with Turbine and Consul

\ No newline at end of file
+   7. Circuit Breaker with Hystrix
7. Circuit Breaker with Hystrix
Prev   Next
7. Circuit Breaker with Hystrix
Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: spring-cloud-starter-hystrix.  Hystrix doesn’t depend on the Netflix Discovery Client. The @EnableHystrix annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with @HystrixCommand to be protected by a circuit breaker. See the documentation for more details.
Prev   Next
6. Spring Cloud Bus with Consul Home 8. Hystrix metrics aggregation with Turbine and Consul

\ No newline at end of file
diff --git a/1.3.x/single/spring-cloud-consul.html b/1.3.x/single/spring-cloud-consul.html
index 33fdd26d..2a51a9f7 100644
--- a/1.3.x/single/spring-cloud-consul.html
+++ b/1.3.x/single/spring-cloud-consul.html
@@ -6,7 +6,7 @@ simple annotations you can quickly enable and configure the common patterns insi
 application and build large distributed systems with Consul based components. The
 patterns provided include Service Discovery, Control Bus and Configuration.
 Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon), Circuit Breaker
-(Hystrix) are provided by integration with Spring Cloud Netflix.
1. Install Consul
Please see the installation documentation for instructions on how to install Consul.
2. Consul Agent
A Consul Agent client must be available to all Spring Cloud Consul applications.  By default, the Agent client is expected to be at localhost:8500.  See the Agent documentation for specifics on how to start an Agent client and how to connect to a cluster of Consul Agent Servers.  For development, after you have installed consul, you may start a Consul Agent using the following command:
./src/main/bash/local_run_consul.sh
This will start an agent in server mode on port 8500, with the ui available at http://localhost:8500
3. Service Discovery with Consul
Service Discovery is one of the key tenets of a microservice based architecture. Trying to hand configure each client or some form of convention can be very difficult to do and can be very brittle.  Consul provides Service Discovery services via an HTTP API and DNS.  Spring Cloud Consul leverages the HTTP API for service registration and discovery.  This does not prevent non-Spring Cloud applications from leveraging the DNS interface.  Consul Agents servers are run in a cluster that communicates via a gossip protocol and uses the Raft consensus protocol.
3.1 How to activate
To activate Consul Service Discovery use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-discovery. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
3.2 Registering with Consul
When a client registers with Consul, it provides meta-data about itself such as host and port, id, name and tags.  An HTTP Check is created by default that Consul hits the /health endpoint every 10 seconds.  If the health check fails, the service instance is marked as critical.
Example Consul client:
@SpringBootApplication
+(Hystrix) are provided by integration with Spring Cloud Netflix.
1. Install Consul
Please see the installation documentation for instructions on how to install Consul.
2. Consul Agent
A Consul Agent client must be available to all Spring Cloud Consul applications.  By default, the Agent client is expected to be at localhost:8500.  See the Agent documentation for specifics on how to start an Agent client and how to connect to a cluster of Consul Agent Servers.  For development, after you have installed consul, you may start a Consul Agent using the following command:
./src/main/bash/local_run_consul.sh
This will start an agent in server mode on port 8500, with the ui available at http://localhost:8500
3. Service Discovery with Consul
Service Discovery is one of the key tenets of a microservice based architecture. Trying to hand configure each client or some form of convention can be very difficult to do and can be very brittle.  Consul provides Service Discovery services via an HTTP API and DNS.  Spring Cloud Consul leverages the HTTP API for service registration and discovery.  This does not prevent non-Spring Cloud applications from leveraging the DNS interface.  Consul Agents servers are run in a cluster that communicates via a gossip protocol and uses the Raft consensus protocol.
3.1 How to activate
To activate Consul Service Discovery use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-discovery. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
3.2 Registering with Consul
When a client registers with Consul, it provides meta-data about itself such as host and port, id, name and tags.  An HTTP Check is created by default that Consul hits the /health endpoint every 10 seconds.  If the health check fails, the service instance is marked as critical.
Example Consul client:
@SpringBootApplication
 @RestController
 public class Application {
 
@@ -45,7 +45,7 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon), Circuit Brea
       discovery:
         instanceId: ${spring.application.name}:${vcap.application.instance_id:${spring.application.instance_id:${random.value}}}

 
With this metadata, and multiple service instances deployed on localhost, the random value will kick in there to make the instance unique. In Cloudfoundry the vcap.application.instance_id will be populated automatically in a Spring Boot application, so the random value will not be needed.
3.4 Looking up services
3.4.1 Using Ribbon
Spring Cloud has support for Feign (a REST client builder) and also Spring RestTemplate
-for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize Ribbon for client-side load balancing.
If you want to access service STORES using the RestTemplate simply declare:
@LoadBalanced
+for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize Ribbon for client-side load balancing.
If you want to access service STORES using the RestTemplate simply declare:
@LoadBalanced
 @Bean
 public RestTemplate loadbalancedRestTemplate() {
      new RestTemplate();
@@ -68,7 +68,7 @@ public String serviceUrl() {
 }
4. Distributed Configuration with Consul
Consul provides a Key/Value Store for storing configuration and other metadata.  Spring Cloud Consul Config is an alternative to the Config Server and Client.  Configuration is loaded into the Spring Environment during the special "bootstrap" phase.  Configuration is stored in the /config folder by default.  Multiple PropertySource instances are created based on the application’s name and the active profiles that mimicks the Spring Cloud Config order of resolving properties.  For example, an application with the name "testApp" and with the "dev" profile will have the following property sources created:
config/testApp,dev/
 config/testApp/
 config/application,dev/
-config/application/
The most specific property source is at the top, with the least specific at the bottom.  Properties in the config/application folder are applicable to all applications using consul for configuration.  Properties in the config/testApp folder are only available to the instances of the service named "testApp".
Configuration is currently read on startup of the application.  Sending a HTTP POST to /refresh will cause the configuration to be reloaded. Section 4.3, “Config Watch” will also automatically detect changes and reload the application context.
4.1 How to activate
To get started with Consul Configuration use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-config. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
This will enable auto-configuration that will setup Spring Cloud Consul Config.
4.2 Customizing
Consul Config may be customized using the following properties:
bootstrap.yml. 
+config/application/
The most specific property source is at the top, with the least specific at the bottom.  Properties in the config/application folder are applicable to all applications using consul for configuration.  Properties in the config/testApp folder are only available to the instances of the service named "testApp".
Configuration is currently read on startup of the application.  Sending a HTTP POST to /refresh will cause the configuration to be reloaded. Section 4.3, “Config Watch” will also automatically detect changes and reload the application context.
4.1 How to activate
To get started with Consul Configuration use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-config. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
This will enable auto-configuration that will setup Spring Cloud Consul Config.
4.2 Customizing
Consul Config may be customized using the following properties:
bootstrap.yml. 
 
spring:
   cloud:
     consul:
@@ -108,7 +108,7 @@ exponential multiplier of 1.1 for subsequent backoffs. You can configure these
 properties (and others) using spring.cloud.consul.retry.* configuration properties.
 This works with both Spring Cloud Consul Config and Discovery registration.
[Tip]Tip
To take full control of the retry add a @Bean of type
 RetryOperationsInterceptor with id "consulRetryInterceptor". Spring
-Retry has a RetryInterceptorBuilder that makes it easy to create one.
6. Spring Cloud Bus with Consul
6.1 How to activate
To get started with the Consul Bus use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-bus. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
See the Spring Cloud Bus documentation for the available actuator endpoints and howto send custom messages.
7. Circuit Breaker with Hystrix
Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: spring-cloud-starter-hystrix.  Hystrix doesn’t depend on the Netflix Discovery Client. The @EnableHystrix annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with @HystrixCommand to be protected by a circuit breaker. See the documentation for more details.
8. Hystrix metrics aggregation with Turbine and Consul
Turbine (provided by the Spring Cloud Netflix project), aggregates multiple instances Hystrix metrics streams, so the dashboard can display an aggregate view. Turbine uses the DiscoveryClient interface to lookup relevant instances. To use Turbine with Spring Cloud Consul, configure the Turbine application in a manner similar to the following examples:
pom.xml. 
+Retry has a RetryInterceptorBuilder that makes it easy to create one.
6. Spring Cloud Bus with Consul
6.1 How to activate
To get started with the Consul Bus use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-bus. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
See the Spring Cloud Bus documentation for the available actuator endpoints and howto send custom messages.
7. Circuit Breaker with Hystrix
Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: spring-cloud-starter-hystrix.  Hystrix doesn’t depend on the Netflix Discovery Client. The @EnableHystrix annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with @HystrixCommand to be protected by a circuit breaker. See the documentation for more details.
8. Hystrix metrics aggregation with Turbine and Consul
Turbine (provided by the Spring Cloud Netflix project), aggregates multiple instances Hystrix metrics streams, so the dashboard can display an aggregate view. Turbine uses the DiscoveryClient interface to lookup relevant instances. To use Turbine with Spring Cloud Consul, configure the Turbine application in a manner similar to the following examples:
pom.xml. 
 
<dependency>
     <groupId>org.springframework.cloud</groupId>
     <artifactId>spring-cloud-netflix-turbine</artifactId>
diff --git a/1.3.x/spring-cloud-consul.xml b/1.3.x/spring-cloud-consul.xml
index 44743398..ef8195f7 100644
--- a/1.3.x/spring-cloud-consul.xml
+++ b/1.3.x/spring-cloud-consul.xml
@@ -32,7 +32,7 @@ Intelligent Routing (Zuul) and Client Side Load Balancing (Ribbon), Circuit Brea
 Service Discovery is one of the key tenets of a microservice based architecture. Trying to hand configure each client or some form of convention can be very difficult to do and can be very brittle.  Consul provides Service Discovery services via an HTTP API and DNS.  Spring Cloud Consul leverages the HTTP API for service registration and discovery.  This does not prevent non-Spring Cloud applications from leveraging the DNS interface.  Consul Agents servers are run in a cluster that communicates via a gossip protocol and uses the Raft consensus protocol.
 

 How to activate
-To activate Consul Service Discovery use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-discovery. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
+To activate Consul Service Discovery use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-discovery. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
 

 

 Registering with Consul
@@ -120,7 +120,7 @@ public class Application {
 

 Using Ribbon
 Spring Cloud has support for Feign (a REST client builder) and also Spring RestTemplate
-for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize Ribbon for client-side load balancing.
+for looking up services using the logical service names/ids instead of physical URLs. Both Feign and the discovery-aware RestTemplate utilize Ribbon for client-side load balancing.
 If you want to access service STORES using the RestTemplate simply declare:
 @LoadBalanced
 @Bean
@@ -165,7 +165,7 @@ config/application/
 Configuration is currently read on startup of the application.  Sending a HTTP POST to /refresh will cause the configuration to be reloaded.  will also automatically detect changes and reload the application context.
 

 How to activate
-To get started with Consul Configuration use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-config. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
+To get started with Consul Configuration use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-config. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
 This will enable auto-configuration that will setup Spring Cloud Consul Config.
 

 

@@ -277,13 +277,13 @@ Retry has a RetryInterceptorBuilder that makes it easy to cre
 Spring Cloud Bus with Consul
 

 How to activate
-To get started with the Consul Bus use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-bus. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
+To get started with the Consul Bus use the starter with group org.springframework.cloud and artifact id spring-cloud-starter-consul-bus. See the Spring Cloud Project page for details on setting up your build system with the current Spring Cloud Release Train.
 See the Spring Cloud Bus documentation for the available actuator endpoints and howto send custom messages.
 

 
 
 Circuit Breaker with Hystrix
-Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: spring-cloud-starter-hystrix.  Hystrix doesn’t depend on the Netflix Discovery Client. The @EnableHystrix annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with @HystrixCommand to be protected by a circuit breaker. See the documentation for more details.
+Applications can use the Hystrix Circuit Breaker provided by the Spring Cloud Netflix project by including this starter in the projects pom.xml: spring-cloud-starter-hystrix.  Hystrix doesn’t depend on the Netflix Discovery Client. The @EnableHystrix annotation should be placed on a configuration class (usually the main class). Then methods can be annotated with @HystrixCommand to be protected by a circuit breaker. See the documentation for more details.
 
 
 Hystrix metrics aggregation with Turbine and Consul