diff --git a/README.adoc b/README.adoc index 28a668033..2f39971b2 100644 --- a/README.adoc +++ b/README.adoc @@ -54,7 +54,7 @@ then turning them into `@Beans` that can be wrapped as above. isolated classloader, so that you can pack them together in a single JVM. -4. Adapters for https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS Lambda], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-openwhisk[Apache OpenWhisk] and possibly other "serverless" service providers. +4. Adapters for https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS Lambda], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-azure[Azure], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-openwhisk[Apache OpenWhisk] and possibly other "serverless" service providers. == Getting Started @@ -101,20 +101,17 @@ JMS. The `@Beans` can be `Function`, `Consumer` or `Supplier` (all from `java.util`), and their parametric types can be String or POJO. A -`Function` is exposed as a `Processor` if -`spring-cloud-function-stream` is on the classpath and a -`spring.cloud.function.stream.endpoint` property is configured in the -Spring environment. A `Consumer` is also exposed as an HTTP POST, or -as a Stream `Sink`. A `Supplier` translates to an HTTP GET, or a -Stream `Source`. +`Function` is exposed as a Spring Cloud Stream `Processor` if +`spring-cloud-function-stream` is on the classpath. +A `Consumer` is also exposed as a Stream +`Sink` and a `Supplier` translates to a Stream `Source`. +HTTP endpoints are exposed if the Stream binder is `spring-cloud-stream-binder-servlet`. Functions can be of `Flux` or `Flux` and Spring Cloud Function takes care of converting the data to and from the desired types, as long as it comes in as plain text or (in the case of the -POJO) JSON. Also works for `Flux>` and plain -`Pojo` types (where `Flux` is implied and implemented by the framework). -Additionally, you can replace `Flux` by `Publisher` in any function -definition and it should work that way too. +POJO) JSON. TBD: support for `Flux>` and maybe plain +`Pojo` types (Fluxes implied and implemented by the framework). Functions can be grouped together in a single application, or deployed one-per-jar. It's up to the developer to choose. An app with multiple @@ -349,4 +346,4 @@ added after the original pull request but before a merge. other target branch in the main project). * When writing a commit message please follow http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html[these conventions], if you are fixing an existing issue please add `Fixes gh-XXXX` at the end of the commit - message (where XXXX is the issue number). + message (where XXXX is the issue number). \ No newline at end of file diff --git a/docs/src/main/asciidoc/getting-started.adoc b/docs/src/main/asciidoc/getting-started.adoc index 3e08f3352..76670b13b 100644 --- a/docs/src/main/asciidoc/getting-started.adoc +++ b/docs/src/main/asciidoc/getting-started.adoc @@ -9,7 +9,7 @@ $ ./mvnw clean install Run one of the samples, e.g. ---- -$ java -jar spring-cloud-function-samples/spring-cloud-function-sample/target/*.jar +$ java -jar spring-cloud-function-samples/function-sample/target/*.jar ---- This runs the app and exposes its functions over HTTP, so you can diff --git a/docs/src/main/asciidoc/intro.adoc b/docs/src/main/asciidoc/intro.adoc index 533d956ec..a1d708b80 100644 --- a/docs/src/main/asciidoc/intro.adoc +++ b/docs/src/main/asciidoc/intro.adoc @@ -48,4 +48,4 @@ then turning them into `@Beans` that can be wrapped as above. isolated classloader, so that you can pack them together in a single JVM. -4. Adapters for https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS Lambda], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-openwhisk[Apache OpenWhisk] and possibly other "serverless" service providers. \ No newline at end of file +4. Adapters for https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-aws[AWS Lambda], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-azure[Azure], https://github.com/spring-cloud/spring-cloud-function/tree/master/spring-cloud-function-adapters/spring-cloud-function-adapter-openwhisk[Apache OpenWhisk] and possibly other "serverless" service providers. \ No newline at end of file