Extract adpater READMEs into docs subdir

This commit is contained in:
Dave Syer
2018-06-04 09:22:34 +01:00
parent 9dc569837a
commit 047aabcbdd
8 changed files with 259 additions and 12 deletions

View File

@@ -1,3 +1,5 @@
// Do not edit this file (e.g. go instead to src/main/asciidoc)
This project provides an adapter layer for a Spring Cloud Function application onto AWS Lambda. You can write an app with a single `@Bean` of type `Function`, `Consumer` or `Supplier` and it will be deployable in AWS if you get the JAR file laid out right. The best way to make it work is to include `spring-cloud-function-context` as a dependency, but not the higher level adapters (e.g. `spring-cloud-function-stream`).
The adapter has a couple of generic request handlers that you can use. The most generic is `SpringBootStreamHandler`, which uses a Jackson `ObjectMapper` provided by Spring Boot to serialize and deserialize the objects in the function. There is also a `SpringBootRequestHandler` which you can extend, and provide the input and output types as type parameters (enabling AWS to inspect the class and do the JSON conversions itself).

View File

@@ -1,3 +1,5 @@
// Do not edit this file (e.g. go instead to src/main/asciidoc)
This work is experimental.
This project provides an adapter layer for a Spring Cloud Function application onto Azure.
You can write an app with a single `@Bean` of type `Function` and it will be deployable in Azure if you get the JAR file laid out right.

View File

@@ -1,3 +1,5 @@
// Do not edit this file (e.g. go instead to src/main/asciidoc)
Implement a POF (be sure to use the `functions` package):
```
@@ -78,17 +80,12 @@ wsk action invoke example --result --param payload foo
"result": "FOO"
}
```
# Examples
== Examples
The following examples are built based on the details and explanations above, on how to deploy Spring Cloud Functions on to [OpenWhisk](https://openwhisk.apache.org/)
The following examples are built based on the details and explanations above, on how to deploy Spring Cloud Functions on to https://openwhisk.apache.org/[OpenWhisk]
* [Spring Cloud Function PoF Example](https://github.com/redhat-developer-demos/ow-scf-fruiteason)
* https://github.com/redhat-developer-demos/ow-scf-fruiteason[Spring Cloud Function PoF Example]. This example shows how to use Spring Cloud Functions by defining simple Plain Old Function (POF)
This example shows how to use Spring Cloud Functions by defining simple Plain Old Function (POF)
* https://github.com/redhat-developer-demos/ow-scf-greeter[Spring Cloud Function Application Example]. This example shows how to use Spring Cloud Functions with a complete Spring Boot Application that has functions defined by extending `java.util.function.Function` interfaces.
* [Spring Cloud Function Application Example](https://github.com/redhat-developer-demos/ow-scf-greeter)
This example shows how to use Spring Cloud Functions with a complete Spring Boot Application
that has functions defined by extending `java.util.function.Function` interfaces.
The base docker images used for above examples is available [here](https://github.com/redhat-developer-demos/openwhisk-scf-docker).
The base docker images used for above examples is available https://github.com/redhat-developer-demos/openwhisk-scf-docker[here].