diff --git a/README.adoc b/README.adoc index 2437b6c37..db227d7fe 100644 --- a/README.adoc +++ b/README.adoc @@ -118,98 +118,6 @@ one-per-jar. It's up to the developer to choose. An app with multiple functions can be deployed multiple times in different "personalities", exposing different functions over different physical transports. -== Dynamic Compilation - -There is a sample app that uses the function compiler to create a -function from a configuration property. The vanilla "function-sample" -also has that feature. And there are some examples that you can run to -see the compilation happening at run time. To run these examples, -change into the `scripts` directory: - ----- -cd scripts ----- - -Also, start a RabbitMQ server locally (e.g. execute `rabbitmq-server`). - -=== Start the Function Registry Service: - ----- -./function-registry.sh ----- - -=== Register a Function: - ----- -./registerFunction.sh -n uppercase -f "f->f.map(s->s.toString().toUpperCase())" ----- - -=== Run a REST Microservice using that Function: - ----- -./web.sh -f uppercase -p 9000 -curl -H "Content-Type: text/plain" -H "Accept: text/plain" localhost:9000/uppercase -d foo ----- - -=== Register a Supplier: - ----- -./registerSupplier.sh -n words -f "()->Flux.just(\"foo\",\"bar\")" ----- - -=== Run a REST Microservice using that Supplier: - ----- -./web.sh -s words -p 9001 -curl -H "Accept: application/json" localhost:9001/words ----- - -=== Register a Consumer: - ----- -./registerConsumer.sh -n print -t String -f "System.out::println" ----- - -=== Run a REST Microservice using that Consumer: - ----- -./web.sh -c print -p 9002 -curl -X POST -H "Content-Type: text/plain" -d foo localhost:9002/print ----- - -=== Run Stream Processing Microservices: - -First register a streaming words supplier: - ----- -./registerSupplier.sh -n wordstream -f "()->Flux.interval(Duration.ofMillis(1000)).map(i->\"message-\"+i)" ----- - -Then start the source (supplier), processor (function), and sink (consumer) apps -(in reverse order): - ----- -./stream.sh -p 9103 -i uppercaseWords -c print -./stream.sh -p 9102 -i words -f uppercase -o uppercaseWords -./stream.sh -p 9101 -s wordstream -o words ----- - -The output will appear in the console of the sink app (one message per second, converted to uppercase): - ----- -MESSAGE-0 -MESSAGE-1 -MESSAGE-2 -MESSAGE-3 -MESSAGE-4 -MESSAGE-5 -MESSAGE-6 -MESSAGE-7 -MESSAGE-8 -MESSAGE-9 -... ----- - == Building :jdkversion: 1.7 diff --git a/docs/src/main/asciidoc/adapters/azure-intro.adoc b/docs/src/main/asciidoc/adapters/azure-intro.adoc index 2b1dbbf00..9bcafc96e 100644 --- a/docs/src/main/asciidoc/adapters/azure-intro.adoc +++ b/docs/src/main/asciidoc/adapters/azure-intro.adoc @@ -1,4 +1,7 @@ -The adapter has a generic http request handler that you can use. +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. + +The adapter has a generic HTTP request handler that you can use optionally. There is a `AzureSpringBootRequestHandler` which you must extend, and provide the input and output types as type parameters (enabling Azure to inspect the class and do the JSON conversions itself). If your app has more than one `@Bean` of type `Function` etc. then you can choose the one to use by configuring `function.name`. diff --git a/docs/src/main/asciidoc/adapters/azure-readme.adoc b/docs/src/main/asciidoc/adapters/azure-readme.adoc index f6d54fd7a..9a59baa8e 100644 --- a/docs/src/main/asciidoc/adapters/azure-readme.adoc +++ b/docs/src/main/asciidoc/adapters/azure-readme.adoc @@ -1,4 +1,8 @@ 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. -include::azure-intro.adoc[] \ No newline at end of file +include::azure-intro.adoc[] + +== Sample Function + +Go to the link:../../spring-cloud-function-samples/function-sample-azure/[function-sample-azure] to learn about how the sample works, and how to run and test it. diff --git a/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/README.adoc b/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/README.adoc index f182512ad..0cb0c24b8 100644 --- a/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/README.adoc +++ b/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/README.adoc @@ -3,7 +3,10 @@ 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. -The adapter has a generic http request handler that you can use. +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. + +The adapter has a generic HTTP request handler that you can use optionally. There is a `AzureSpringBootRequestHandler` which you must extend, and provide the input and output types as type parameters (enabling Azure to inspect the class and do the JSON conversions itself). If your app has more than one `@Bean` of type `Function` etc. then you can choose the one to use by configuring `function.name`. @@ -70,4 +73,8 @@ The input type for the function in the Azure sample is a Foo with a single prope { "value": "foobar" } ----- \ No newline at end of file +---- + +== Sample Function + +Go to the link:../../spring-cloud-function-samples/function-sample-azure/[function-sample-azure] to learn about how the sample works, and how to run and test it. \ No newline at end of file diff --git a/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/pom.xml b/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/pom.xml index 7f15cd126..138f1344e 100644 --- a/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/pom.xml +++ b/spring-cloud-function-adapters/spring-cloud-function-adapter-azure/pom.xml @@ -19,7 +19,7 @@ UTF-8 UTF-8 1.8 - 1.2.1 + [1.0.0-beta-3,1.0.0) @@ -44,7 +44,7 @@ com.microsoft.azure azure-functions-java-core - [1.0.0-beta-1,1.0.0) + ${azure.functions.java.core.version} diff --git a/spring-cloud-function-samples/function-sample-azure/README.adoc b/spring-cloud-function-samples/function-sample-azure/README.adoc new file mode 100644 index 000000000..0b9d98282 --- /dev/null +++ b/spring-cloud-function-samples/function-sample-azure/README.adoc @@ -0,0 +1,32 @@ +You can run this sample locally, just like the other Spring Cloud Function samples: + +---- +mvn spring-boot:run +---- + +and `curl -H "Content-Type: text/plain" localhost:8080/function -d '{"value": "hello foobar"}'`. + +To run locally on top of Azure Functions, and to deploy to your live Azure environment, you will need the Azure Functions Core Tools installed along with the Azure CLI (see https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-first-java-maven for more details). + +Run Azure Function locally: + +---- +mvn azure-functions:run +---- + +To deploy the function on your live Azure environment: + +---- +$ az login +$ mvn azure-functions:deploy +---- + +On another terminal try this: `curl https:///api/uppercase -d '{"value": "hello foobar!"}'`. Please ensure that you use the right URL for the function above. Alternatively you can test the function in the Azure Dashboard UI (click on the function name, go to the right hand side and click "Test" and to the bottom right, "Run"). + +The input type for the function in the Azure sample is a Foo with a single property called "value". So you need this to test it with something like below: + +---- +{ + "value": "foobar" +} +---- diff --git a/spring-cloud-function-samples/function-sample-azure/pom.xml b/spring-cloud-function-samples/function-sample-azure/pom.xml index e47e27361..72aaf307d 100644 --- a/spring-cloud-function-samples/function-sample-azure/pom.xml +++ b/spring-cloud-function-samples/function-sample-azure/pom.xml @@ -23,6 +23,7 @@ 1.8 function-sample-azure westus + java-function-group 3.1.2.RELEASE example.Config @@ -37,12 +38,6 @@ spring-cloud-starter-function-web provided - - com.microsoft.azure - azure-functions-java-core - 1.0.0-beta-2 - provided - @@ -74,7 +69,7 @@ com.microsoft.azure azure-functions-maven-plugin - 0.1.6 + 1.0.0-beta-1 @@ -91,7 +86,7 @@ com.microsoft.azure azure-functions-maven-plugin - java-functions-group + ${functionResourceGroup} ${functionAppName} ${functionAppRegion} diff --git a/spring-cloud-function-samples/function-sample-azure/src/main/azure/uppercase/function.json b/spring-cloud-function-samples/function-sample-azure/src/main/azure/uppercase/function.json index 0af9eca0f..03c68fbb7 100644 --- a/spring-cloud-function-samples/function-sample-azure/src/main/azure/uppercase/function.json +++ b/spring-cloud-function-samples/function-sample-azure/src/main/azure/uppercase/function.json @@ -8,7 +8,6 @@ "direction": "in", "authLevel": "anonymous", "methods": [ - "get", "post" ] },