diff --git a/reference/html/README.html b/reference/html/README.html index 71ecb8d..756c33d 100644 --- a/reference/html/README.html +++ b/reference/html/README.html @@ -96,21 +96,34 @@ $(addBlockSwitches);
Table of Contents
@@ -130,7 +143,7 @@ either an AMQP broker or Kafka as the transport.

-

Quick Start

+

1. Quick Start

Spring Cloud Bus works by adding Spring Boot autconfiguration if it detects itself on the @@ -177,10 +190,10 @@ works with spring-cloud-bus.

-

Building

+

2. Building

-

Basic Compile and Test

+

2.1. Basic Compile and Test

To build the source you will need to install JDK 1.7.

@@ -258,7 +271,7 @@ If all else fails, build with the command from .travis.yml (usually
-

Documentation

+

2.2. Documentation

The spring-cloud-build module has a "docs" profile, and if you switch that on it will try to build asciidoc sources from @@ -271,7 +284,7 @@ a modified file in the correct place. Just commit it and push the change.

-

Working with the code

+

2.3. Working with the code

If you don’t have an IDE preference we would recommend that you use Spring Tools Suite or @@ -280,7 +293,7 @@ a modified file in the correct place. Just commit it and push the change.

should also work without issue as long as they use Maven 3.3.3 or better.

-

Importing into eclipse with m2eclipse

+

2.3.1. Importing into eclipse with m2eclipse

We recommend the m2eclipse eclipse plugin when working with eclipse. If you don’t already have m2eclipse installed it is available from the "eclipse @@ -307,7 +320,7 @@ pom into your settings.xml.

-

Importing into eclipse without m2eclipse

+

2.3.2. Importing into eclipse without m2eclipse

If you prefer not to use m2eclipse you can generate eclipse project metadata using the following command:

@@ -326,7 +339,7 @@ from the file menu.

-

Contributing

+

3. Contributing

Spring Cloud is released under the non-restrictive Apache 2.0 license, @@ -336,7 +349,7 @@ to contribute even something trivial please do not hesitate, but follow the guidelines below.

-

Sign the Contributor License Agreement

+

3.1. Sign the Contributor License Agreement

Before we accept a non-trivial patch or pull request we will need you to sign the Contributor License Agreement. @@ -347,7 +360,7 @@ given the ability to merge pull requests.

-

Code of Conduct

+

3.2. Code of Conduct

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code. Please report @@ -355,7 +368,7 @@ unacceptable behavior to spri

-

Code Conventions and Housekeeping

+

3.3. Code Conventions and Housekeeping

None of these is essential for a pull request, but they will all help. They can also be added after the original pull request but before a merge.

@@ -403,7 +416,7 @@ message (where XXXX is the issue number).

-

Checkstyle

+

3.4. Checkstyle

Spring Cloud Build comes with a set of checkstyle rules. You can find them in the spring-cloud-build-tools module. The most notable files under the module are:

@@ -436,7 +449,7 @@ message (where XXXX is the issue number).

-

Checkstyle configuration

+

3.4.1. Checkstyle configuration

Checkstyle rules are disabled by default. To add checkstyle to your project just define the following properties and plugins.

@@ -506,11 +519,11 @@ message (where XXXX is the issue number).

<?xml version="1.0"?>
 <!DOCTYPE suppressions PUBLIC
-		"-//Puppy Crawl//DTD Suppressions 1.1//EN"
-		"https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
+        "-//Puppy Crawl//DTD Suppressions 1.1//EN"
+        "https://www.puppycrawl.com/dtds/suppressions_1_1.dtd">
 <suppressions>
-	<suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
-	<suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
+    <suppress files=".*ConfigServerApplication\.java" checks="HideUtilityClassConstructor"/>
+    <suppress files=".*ConfigClientWatch\.java" checks="LineLengthCheck"/>
 </suppressions>
@@ -526,9 +539,9 @@ $ touch .springformat
-

IDE setup

+

3.5. IDE setup

-

Intellij IDEA

+

3.5.1. Intellij IDEA

In order to setup Intellij you should import our coding conventions, inspection profiles and set up the checkstyle plugin. The following files can be found in the Spring Cloud Build project.

@@ -600,15 +613,15 @@ The following files can be found in the -

Go to File → Settings → Other settings → Checkstyle. There click on the + icon in the Configuration file section. There, you’ll have to define where the checkstyle rules should be picked from. In the image above, we’ve picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build’s GitHub repository (e.g. for the checkstyle.xml : https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml). We need to provide the following variables:

+

Go to File → Settings → Other settings → Checkstyle. There click on the + icon in the Configuration file section. There, you’ll have to define where the checkstyle rules should be picked from. In the image above, we’ve picked the rules from the cloned Spring Cloud Build repository. However, you can point to the Spring Cloud Build’s GitHub repository (e.g. for the checkstyle.xml : raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle.xml). We need to provide the following variables:

  • -

    checkstyle.header.file - please point it to the Spring Cloud Build’s, spring-cloud-build-tools/src/main/resources/checkstyle/checkstyle-header.txt file either in your cloned repo or via the https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt URL.

    +

    checkstyle.header.file - please point it to the Spring Cloud Build’s, spring-cloud-build-tools/src/main/resources/checkstyle/checkstyle-header.txt file either in your cloned repo or via the raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/main/resources/checkstyle-header.txt URL.

  • -

    checkstyle.suppressions.file - default suppressions. Please point it to the Spring Cloud Build’s, spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml file either in your cloned repo or via the https://raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml URL.

    +

    checkstyle.suppressions.file - default suppressions. Please point it to the Spring Cloud Build’s, spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml file either in your cloned repo or via the raw.githubusercontent.com/spring-cloud/spring-cloud-build/master/spring-cloud-build-tools/src/checkstyle/checkstyle-suppressions.xml URL.

  • checkstyle.additional.suppressions.file - this variable corresponds to suppressions in your local project. E.g. you’re working on spring-cloud-contract. Then point to the project-root/src/checkstyle/checkstyle-suppressions.xml folder. Example for spring-cloud-contract would be: /home/username/spring-cloud-contract/src/checkstyle/checkstyle-suppressions.xml.

    diff --git a/reference/html/appendix.html b/reference/html/appendix.html new file mode 100644 index 0000000..1cf62ae --- /dev/null +++ b/reference/html/appendix.html @@ -0,0 +1,188 @@ + + + + + + + +Common application properties + + + + + + + + + + +
    +
    +

    Appendix A: Common application properties

    +
    +
    +

    Various properties can be specified inside your application.properties file, inside your application.yml file, or as command line switches. +This appendix provides a list of common Spring Cloud Bus properties and references to the underlying classes that consume them.

    +
    +
    + + + + + +
    + + +Property contributions can come from additional jar files on your classpath, so you should not consider this an exhaustive list. +Also, you can define your own properties. +
    +
    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    NameDefaultDescription

    spring.cloud.bus.ack.destination-service

    Service that wants to listen to acks. By default null (meaning all services).

    spring.cloud.bus.ack.enabled

    true

    Flag to switch off acks (default on).

    spring.cloud.bus.destination

    springCloudBus

    Name of Spring Cloud Stream destination for messages.

    spring.cloud.bus.enabled

    true

    Flag to indicate that the bus is enabled.

    spring.cloud.bus.env.enabled

    true

    Flag to switch off environment change events (default on).

    spring.cloud.bus.id

    application

    The identifier for this application instance.

    spring.cloud.bus.refresh.enabled

    true

    Flag to switch off refresh events (default on).

    spring.cloud.bus.trace.enabled

    false

    Flag to switch on tracing of acks (default off).

    +
    +
    +
    + + + + + + + \ No newline at end of file diff --git a/reference/html/index.html b/reference/html/index.html index 28d149b..28cd20a 100644 --- a/reference/html/index.html +++ b/reference/html/index.html @@ -96,23 +96,24 @@ $(addBlockSwitches);
@@ -134,7 +135,7 @@ either an AMQP broker or Kafka as the transport.

-Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at github. +Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at {docslink}[github]. @@ -142,7 +143,7 @@ Spring Cloud is released under the non-restrictive Apache 2.0 license. If you wo
-

Quick Start

+

1. Quick Start

Spring Cloud Bus works by adding Spring Boot autconfiguration if it detects itself on the @@ -189,7 +190,7 @@ works with spring-cloud-bus.

-

Bus Endpoints

+

2. Bus Endpoints

Spring Cloud Bus provides two endpoints, /actuator/bus-refresh and /actuator/bus-env @@ -197,7 +198,7 @@ that correspond to individual actuator endpoints in Spring Cloud Commons, /actuator/refresh and /actuator/env respectively.

-

Bus Refresh Endpoint

+

2.1. Bus Refresh Endpoint

The /actuator/bus-refresh endpoint clears the RefreshScope cache and rebinds @ConfigurationProperties. See the Refresh Scope documentation for @@ -214,7 +215,7 @@ application:

-

Bus Env Endpoint

+

2.2. Bus Env Endpoint

The /actuator/bus-env endpoint updates each instances environment with the specified key/value pair across multiple instances.

@@ -234,8 +235,8 @@ application:

{
-	"name": "key1",
-	"value": "value1"
+    "name": "key1",
+    "value": "value1"
 }
@@ -243,7 +244,7 @@ application:

-

Addressing an Instance

+

3. Addressing an Instance

Each instance of the application has a service ID, whose value can be set with @@ -276,7 +277,7 @@ ignore it.

-

Addressing All Instances of a Service

+

4. Addressing All Instances of a Service

The “destination” parameter is used in a Spring PathMatcher (with the path separator @@ -287,7 +288,7 @@ from earlier, /bus-env/customers:** targets all instances of the

-

Service ID Must Be Unique

+

5. Service ID Must Be Unique

The bus tries twice to eliminate processing an event — once from the original @@ -301,7 +302,7 @@ something unique for each instance of a service.

-

Customizing the Message Broker

+

6. Customizing the Message Broker

Spring Cloud Bus uses Spring Cloud Stream to @@ -322,7 +323,7 @@ Stream documentation.

-

Tracing Bus Events

+

7. Tracing Bus Events

Bus events (subclasses of RemoteApplicationEvent) can be traced by setting @@ -392,7 +393,7 @@ queries on the data or forward it to a specialized tracing service.

-

Broadcasting Your Own Events

+

8. Broadcasting Your Own Events

The Bus can carry any event of type RemoteApplicationEvent. The default transport is @@ -417,7 +418,7 @@ Both the producer and the consumer need access to the class definition.

-

Registering events in custom packages

+

8.1. Registering events in custom packages

If you cannot or do not want to use a subpackage of org.springframework.cloud.bus.event for your custom events, you must specify which packages to scan for events of type @@ -493,6 +494,14 @@ You can specify multiple base packages to scan.

+
+

9. Configuration properties

+
+
+

To see the list of all Bus related configuration properties please check the Appendix page.

+
+
+
diff --git a/reference/html/spring-cloud-bus.html b/reference/html/spring-cloud-bus.html index 28d149b..28cd20a 100644 --- a/reference/html/spring-cloud-bus.html +++ b/reference/html/spring-cloud-bus.html @@ -96,23 +96,24 @@ $(addBlockSwitches);
@@ -134,7 +135,7 @@ either an AMQP broker or Kafka as the transport.

-Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at github. +Spring Cloud is released under the non-restrictive Apache 2.0 license. If you would like to contribute to this section of the documentation or if you find an error, please find the source code and issue trackers in the project at {docslink}[github]. @@ -142,7 +143,7 @@ Spring Cloud is released under the non-restrictive Apache 2.0 license. If you wo
-

Quick Start

+

1. Quick Start

Spring Cloud Bus works by adding Spring Boot autconfiguration if it detects itself on the @@ -189,7 +190,7 @@ works with spring-cloud-bus.

-

Bus Endpoints

+

2. Bus Endpoints

Spring Cloud Bus provides two endpoints, /actuator/bus-refresh and /actuator/bus-env @@ -197,7 +198,7 @@ that correspond to individual actuator endpoints in Spring Cloud Commons, /actuator/refresh and /actuator/env respectively.

-

Bus Refresh Endpoint

+

2.1. Bus Refresh Endpoint

The /actuator/bus-refresh endpoint clears the RefreshScope cache and rebinds @ConfigurationProperties. See the Refresh Scope documentation for @@ -214,7 +215,7 @@ application:

-

Bus Env Endpoint

+

2.2. Bus Env Endpoint

The /actuator/bus-env endpoint updates each instances environment with the specified key/value pair across multiple instances.

@@ -234,8 +235,8 @@ application:

{
-	"name": "key1",
-	"value": "value1"
+    "name": "key1",
+    "value": "value1"
 }
@@ -243,7 +244,7 @@ application:

-

Addressing an Instance

+

3. Addressing an Instance

Each instance of the application has a service ID, whose value can be set with @@ -276,7 +277,7 @@ ignore it.

-

Addressing All Instances of a Service

+

4. Addressing All Instances of a Service

The “destination” parameter is used in a Spring PathMatcher (with the path separator @@ -287,7 +288,7 @@ from earlier, /bus-env/customers:** targets all instances of the

-

Service ID Must Be Unique

+

5. Service ID Must Be Unique

The bus tries twice to eliminate processing an event — once from the original @@ -301,7 +302,7 @@ something unique for each instance of a service.

-

Customizing the Message Broker

+

6. Customizing the Message Broker

Spring Cloud Bus uses Spring Cloud Stream to @@ -322,7 +323,7 @@ Stream documentation.

-

Tracing Bus Events

+

7. Tracing Bus Events

Bus events (subclasses of RemoteApplicationEvent) can be traced by setting @@ -392,7 +393,7 @@ queries on the data or forward it to a specialized tracing service.

-

Broadcasting Your Own Events

+

8. Broadcasting Your Own Events

The Bus can carry any event of type RemoteApplicationEvent. The default transport is @@ -417,7 +418,7 @@ Both the producer and the consumer need access to the class definition.

-

Registering events in custom packages

+

8.1. Registering events in custom packages

If you cannot or do not want to use a subpackage of org.springframework.cloud.bus.event for your custom events, you must specify which packages to scan for events of type @@ -493,6 +494,14 @@ You can specify multiple base packages to scan.

+
+

9. Configuration properties

+
+
+

To see the list of all Bus related configuration properties please check the Appendix page.

+
+
+