From a42c9ecadbd4ba1ef397dcd38e140c87825f3739 Mon Sep 17 00:00:00 2001 From: Dave Syer Date: Wed, 15 Jul 2015 15:53:26 +0000 Subject: [PATCH] Sync docs from master to gh-pages --- spring-cloud-stream.html | 48 ++++------------------------------------ 1 file changed, 4 insertions(+), 44 deletions(-) diff --git a/spring-cloud-stream.html b/spring-cloud-stream.html index e65018be5..def97981f 100644 --- a/spring-cloud-stream.html +++ b/spring-cloud-stream.html @@ -417,7 +417,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b
-

This project allows a user to develop and run messaging microservices using Spring Integration and run them locally, or in the cloud, or even on Spring XD. Just create MessageChannels "input" and/or "output" and add @EnableChannelBinding and run your app as a Spring Boot app (single application context). You just need to connect to the physical broker for the bus, which is automatic if the relevant bus implementation is available on the classpath. The sample uses Redis.

+

This project allows a user to develop and run messaging microservices using Spring Integration and run them locally, or in the cloud, or even on Spring XD. Just create MessageChannels "input" and/or "output" and add @EnableModule and run your app as a Spring Boot app (single application context). You just need to connect to the physical broker for the bus, which is automatic if the relevant bus implementation is available on the classpath. The sample uses Redis.

Here’s a sample source module (output channel only):

@@ -425,7 +425,7 @@ body.book #toc,body.book #preamble,body.book h1.sect0,body.book .sect1>h2{page-b 
@SpringBootApplication
-@EnableChannelBinding
+@EnableModule
 @ComponentScan(basePackageClasses=ModuleDefinition.class)
 public class ModuleApplication {
 
@@ -468,9 +468,6 @@ spring:
       outputChannelName: ${spring.application.name:ticker}
-
-

To be deployable as an XD module in a "traditional" way you need /config/.properties to point to any available Java config classes (via base_packages or options_class), or else you can put traditional XML configuration in /config/.xml. You don’t need those things to run as a consumer or producer to an existing XD system, but you do need to replace the outputChannelName with group, module and index (the index is a sequential counter that XD uses to label the modules in a stream from left to right). There’s an XML version of the same sample (a "timer" source).

-
@@ -487,8 +484,6 @@ spring:

There are several samples, all running on the redis transport (so you need redis running locally to test them).

-
-

Vanilla Module Samples

@@ -520,34 +515,11 @@ The main set of samples are "vanilla" in the sense that they are not deployable - -
-

XD Module Samples

-
-

There are several samples, all running on the redis transport (so you need redis running locally to test them):

-
-
-
    -
  • -

    source is a Java config version of the classic "timer" module from Spring XD. It has a "fixedDelay" option (in milliseconds) for the period between emitting messages.

    -
    • -
  • -

    sink is a Java config version of the classic "log" module from Spring XD. It has no options (but some could easily be added), and just logs incoming messages at INFO level.

    -
    • -
  • -

    tap is the same as the sink sample, except it is configured to tap the source sample output. When it is running it looks a lot like the sink, except that it only gets copies of the messages in the broker, and since it is a pub-sub subscriber, it only gets the messages sent since it started.

    -
    • -
  • -

    source-xml is a copy of the classic "timer" module from Spring XD.

    -
    • -
-

If you run the source and the sink and point them at the same redis instance (e.g. do nothing to get the one on localhost, or the one they are both bound to as a service on Cloud Foundry) then they will form a "stream" and start talking to each other. All the samples have friendly JMX and Actuator endpoints for inspecting what is going on in the system.

-

Module or App

@@ -555,21 +527,9 @@ The main set of samples are "vanilla" in the sense that they are not deployable

Code using this library can be deployed as a standalone app or as an XD module. In standalone mode you app will run happily as a service or in any PaaS (Cloud Foundry, Lattice, Heroku, Azure, etc.). Depending on whether your main aim is to develop an XD module and you just want to test it locally using the standalone mode, or if the ultimate goal is a standalone app, there are some things that you might do differently.

-

Module Options

-
-

Module option (placeholders) default values can be set in /config/.properties as per a normal XD module, and they can be overridden at runtime in standalone mode using standard Spring Boot configuration (e.g. application.yml). Because of the way XD likes to organize options, the default values can also be set as option. in bootstrap.yml (in standalone mode) or as System properties (generally).

-
-
-
-

Local Configuration

-
-

The application.yml and bootstrap.yml files are ignored by XD when deploying the module natively, so you can put whatever you like in there to control the app in standlone mode.

-
-
-

Fat JAR

-

You can run in standalone mode from your IDE for testing. To run in production you can create an executable (or "fat") JAR using the standard Spring Boot tooling, but the executable JAR has a load of stuff in it that isn’t needed if it’s going to be deployed as an XD module. In that case you are better off with the normal JAR packaging provided by Maven or Gradle.

+

You can run in standalone mode from your IDE for testing. To run in production you can create an executable (or "fat") JAR using the standard Spring Boot tooling.

@@ -623,7 +583,7 @@ The main set of samples are "vanilla" in the sense that they are not deployable