diff --git a/multi/multi_pr01.html b/multi/multi_pr01.html index 0178f47f..73d1ef43 100644 --- a/multi/multi_pr01.html +++ b/multi/multi_pr01.html @@ -1,6 +1,6 @@ -

2.1.0.BUILD-SNAPSHOT

This project provides Consul integrations for Spring Boot apps through autoconfiguration +

2.1.0.BUILD-SNAPSHOT

This project provides Consul 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 Consul based components. The diff --git a/multi/multi_spring-cloud-consul-agent.html b/multi/multi_spring-cloud-consul-agent.html index 3f309094..0238a3fb 100644 --- a/multi/multi_spring-cloud-consul-agent.html +++ b/multi/multi_spring-cloud-consul-agent.html @@ -1,3 +1,3 @@ - 2. Consul Agent

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

\ No newline at end of file + 2. Consul Agent

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

\ No newline at end of file diff --git a/multi/multi_spring-cloud-consul-bus.html b/multi/multi_spring-cloud-consul-bus.html index cf20c45b..680090bd 100644 --- a/multi/multi_spring-cloud-consul-bus.html +++ b/multi/multi_spring-cloud-consul-bus.html @@ -1,3 +1,3 @@ - 6. Spring Cloud Bus with Consul

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.

\ No newline at end of file + 6. Spring Cloud Bus with Consul

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.

\ No newline at end of file diff --git a/multi/multi_spring-cloud-consul-config.html b/multi/multi_spring-cloud-consul-config.html index fcfb3050..7d17e08c 100644 --- a/multi/multi_spring-cloud-consul-config.html +++ b/multi/multi_spring-cloud-consul-config.html @@ -1,6 +1,6 @@ - 4. Distributed Configuration with Consul

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/
+   4. Distributed Configuration with Consul

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.  diff --git a/multi/multi_spring-cloud-consul-discovery.html b/multi/multi_spring-cloud-consul-discovery.html index 26900e29..7b2f4535 100644 --- a/multi/multi_spring-cloud-consul-discovery.html +++ b/multi/multi_spring-cloud-consul-discovery.html @@ -1,6 +1,6 @@ - 3. Service Discovery with Consul

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

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 {
 
diff --git a/multi/multi_spring-cloud-consul-hystrix.html b/multi/multi_spring-cloud-consul-hystrix.html
index 9c1cc1c3..89b0e340 100644
--- a/multi/multi_spring-cloud-consul-hystrix.html
+++ b/multi/multi_spring-cloud-consul-hystrix.html
@@ -1,3 +1,3 @@
 
       
-   7. Circuit Breaker with Hystrix

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.

\ No newline at end of file + 7. Circuit Breaker with Hystrix

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.

\ No newline at end of file diff --git a/multi/multi_spring-cloud-consul-install.html b/multi/multi_spring-cloud-consul-install.html index 67a102e0..ab2bd249 100644 --- a/multi/multi_spring-cloud-consul-install.html +++ b/multi/multi_spring-cloud-consul-install.html @@ -1,3 +1,3 @@ - 1. Install Consul

1. Install Consul

Please see the installation documentation for instructions on how to install Consul.

\ No newline at end of file + 1. Install Consul

1. Install Consul

Please see the installation documentation for instructions on how to install Consul.

\ No newline at end of file diff --git a/multi/multi_spring-cloud-consul-retry.html b/multi/multi_spring-cloud-consul-retry.html index 66d78c58..65d2dc4c 100644 --- a/multi/multi_spring-cloud-consul-retry.html +++ b/multi/multi_spring-cloud-consul-retry.html @@ -1,6 +1,6 @@ - 5. Consul Retry

5. Consul Retry

If you expect that the consul agent may occasionally be unavailable when + 5. Consul Retry

5. Consul Retry

If you expect that the consul agent may occasionally be unavailable when your app starts, you can ask it to keep trying after a failure. You need to add spring-retry and spring-boot-starter-aop to your classpath. The default behaviour is to retry 6 times with an initial backoff interval of 1000ms and an diff --git a/multi/multi_spring-cloud-consul-turbine.html b/multi/multi_spring-cloud-consul-turbine.html index 807a187c..6dd41ee9 100644 --- a/multi/multi_spring-cloud-consul-turbine.html +++ b/multi/multi_spring-cloud-consul-turbine.html @@ -1,6 +1,6 @@ - 8. Hystrix metrics aggregation with Turbine and Consul

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.  + 8. Hystrix metrics aggregation with Turbine and Consul

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/multi/multi_spring-cloud-consul.html b/multi/multi_spring-cloud-consul.html
index 87632578..c1a09520 100644
--- a/multi/multi_spring-cloud-consul.html
+++ b/multi/multi_spring-cloud-consul.html
@@ -1,3 +1,3 @@
 
       
-   Spring Cloud Consul
\ No newline at end of file
+   Spring Cloud Consul
\ No newline at end of file
diff --git a/single/spring-cloud-consul.html b/single/spring-cloud-consul.html
index 2accd6a4..3d4b511d 100644
--- a/single/spring-cloud-consul.html
+++ b/single/spring-cloud-consul.html
@@ -1,6 +1,6 @@
 
       
-   Spring Cloud Consul

Spring Cloud Consul


2.1.0.BUILD-SNAPSHOT

This project provides Consul integrations for Spring Boot apps through autoconfiguration + Spring Cloud Consul

Spring Cloud Consul


2.1.0.BUILD-SNAPSHOT

This project provides Consul 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 Consul based components. The diff --git a/spring-cloud-consul.html b/spring-cloud-consul.html index 9d745893..7aab8811 100644 --- a/spring-cloud-consul.html +++ b/spring-cloud-consul.html @@ -4,7 +4,7 @@ - + spring-cloud-consul