diff --git a/spring-cloud-stream-module-launcher/README.md b/spring-cloud-stream-module-launcher/README.md index 92e1b039e..e457873b2 100644 --- a/spring-cloud-stream-module-launcher/README.md +++ b/spring-cloud-stream-module-launcher/README.md @@ -1,6 +1,6 @@ # Module Launcher -The Module Launcher provides a single entry point that bootstraps module JARs located in a home directory. A single Docker image that contains such a directory of module JARs can then be used to launch any of those JARs based on an environment variable. When running standalone, a system property may be used instead of an environment variable, so that multiple instances of the Module Launcher may run on a single machine. The following examples demonstrate running the modules for the *ticktock* stream (`time | log`). +The Module Launcher provides a single entry point that bootstraps module JARs located in a Maven repository. A single Docker image can then be used to launch any of those JARs based on an environment variable. When running standalone, a system property may be used instead of an environment variable, so that multiple instances of the Module Launcher may run on a single machine. The following examples demonstrate running the modules for the *ticktock* stream (`time-source | log-sink`). ## Prerequisites @@ -29,12 +29,12 @@ java -Dmodules=org.springframework.cloud.stream.module:log-sink:1.0.0.BUILD-SNAP The time messages will be emitted every 5 seconds. The console for the log module will display each: ```` -2015-06-05 12:39:58.896 INFO 51078 --- [hannel-adapter1] config.ModuleDefinition : Received: 2015-06-05 12:39:58 -2015-06-05 12:40:02.699 INFO 51078 --- [hannel-adapter1] config.ModuleDefinition : Received: 2015-06-05 16:39:52 -2015-06-05 12:40:03.897 INFO 51078 --- [hannel-adapter1] config.ModuleDefinition : Received: 2015-06-05 12:40:03 +2015-07-31 11:51:42.133 INFO 3388 --- [hannel-adapter1] sink.LogSink : Received: 2015-07-31 11:51:36 +2015-07-31 11:51:42.135 INFO 3388 --- [hannel-adapter1] sink.LogSink : Received: 2015-07-31 11:51:41 +2015-07-31 11:51:46.569 INFO 3388 --- [hannel-adapter1] sink.LogSink : Received: 2015-07-31 11:51:46 ```` -*NOTE:* the two modules will be launched within a single process if both are specified: `-Dmodules=time,log` +*NOTE:* the two modules will be launched within a single process if both are provided (comma-delimited) via `-Dmodules` ## Running with Docker @@ -47,20 +47,8 @@ docker run -p 8081:8081 -e MODULES=org.springframework.cloud.stream.module:log-s ## Running on Lattice -### Initial Setup (if necessary) - 1: Launch lattice with vagrant as described [here](http://lattice.cf/docs/getting-started/). -2: Run a private Docker registry, and configure Lattice to use that as described [here](http://lattice.cf/docs/private-docker-registry/). - -### Deploying Modules - -1: Push the Docker image to the private registry (if necessary, run `$(boot2docker shellinit)` first): - -```` -$ docker push 192.168.59.103:5000/module-launcher -```` - 2: Create a Redis instance on Lattice (running as root): ````