You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@openwhisk.apache.org by pd...@apache.org on 2018/04/10 16:50:41 UTC
[incubator-openwhisk-wskdeploy] branch master updated: Partial fix
for issue #847 (#861)
This is an automated email from the ASF dual-hosted git repository.
pdesai pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-openwhisk-wskdeploy.git
The following commit(s) were added to refs/heads/master by this push:
new 853e9dc Partial fix for issue #847 (#861)
853e9dc is described below
commit 853e9dc5ae0c02ba5448dc18c63f7c5d349e02f3
Author: Bruno Girin <br...@gmail.com>
AuthorDate: Tue Apr 10 17:50:39 2018 +0100
Partial fix for issue #847 (#861)
* Partially addresses issue #847 by showing a simple sequence, doesn't handle web: raw
* Add new API Gateway sequence example to overall programming guide.
---
.../manifest_hello_world_apigateway_sequence.yml | 35 ++++++++++++++++++
docs/examples/src/hello_goodday.js | 33 +++++++++++++++++
docs/programming_guide.md | 1 +
docs/wskdeploy_apigateway_helloworld.md | 2 +-
...loworld.md => wskdeploy_apigateway_sequence.md} | 41 ++++++++++++----------
5 files changed, 93 insertions(+), 19 deletions(-)
diff --git a/docs/examples/manifest_hello_world_apigateway_sequence.yml b/docs/examples/manifest_hello_world_apigateway_sequence.yml
new file mode 100644
index 0000000..6dab7da
--- /dev/null
+++ b/docs/examples/manifest_hello_world_apigateway_sequence.yml
@@ -0,0 +1,35 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one or more contributor
+# license agreements. See the NOTICE file distributed with this work for additional
+# information regarding copyright ownership. The ASF licenses this file to you
+# under the Apache License, Version 2.0 (the # "License"); you may not use this
+# file except in compliance with the License. You may obtain a copy of the License
+# at:
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software distributed
+# under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
+# CONDITIONS OF ANY KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations under the License.
+#
+
+# Example: Basic Hello World action with API
+packages:
+ hello_world_package:
+ version: 1.0
+ license: Apache-2.0
+ actions:
+ hello_basic:
+ function: src/hello.js
+ hello_goodday:
+ function: src/hello_goodday.js
+ sequences:
+ hello_world:
+ actions: hello_basic, hello_goodday
+ web: true
+ apis:
+ hello-world:
+ hello:
+ world:
+ hello_world: GET
diff --git a/docs/examples/src/hello_goodday.js b/docs/examples/src/hello_goodday.js
new file mode 100644
index 0000000..737e9d3
--- /dev/null
+++ b/docs/examples/src/hello_goodday.js
@@ -0,0 +1,33 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+*/
+
+// Licensed to the Apache Software Foundation (ASF) under one or more contributor
+// license agreements; and to You under the Apache License, Version 2.0.
+
+/*
+ * This action is meant to capture the output from the basic Hello, world
+ * action and improve the greeting. It expects params to contain a greeting
+ * and just adds more to it.
+ */
+function main(params) {
+ msg = params.greeting + ", have a good day!";
+ return { greeting: msg };
+}
diff --git a/docs/programming_guide.md b/docs/programming_guide.md
index ed56256..59b0580 100644
--- a/docs/programming_guide.md
+++ b/docs/programming_guide.md
@@ -56,6 +56,7 @@ Each example shows the "code", that is the Package Manifest, Deployment file and
- [Binding parameters in a Deployment file](wskdeploy_triggerrule_trigger_bindings.md#triggers-and-rules) - using a deployment file to bind values to a Trigger’s parameters and applying them to a compatible manifest file.
- API Gateway examples
- [The "Hello World" API Gateway](wskdeploy_apigateway_helloworld.md#api-gateway) - deploy a "hello world" JavaScript function with associated HTTP API.
+ - [API Gateway sequence](wskdeploy_apigateway_sequence.md#api-gateway-sequence) - deploy JavaScript sequence with associated HTTP API.
---
<!--
diff --git a/docs/wskdeploy_apigateway_helloworld.md b/docs/wskdeploy_apigateway_helloworld.md
index 570e08d..39bdb1b 100644
--- a/docs/wskdeploy_apigateway_helloworld.md
+++ b/docs/wskdeploy_apigateway_helloworld.md
@@ -111,7 +111,7 @@ For convenience, the Packages and Actions grammar can be found here:
<tr>
<td><a href="wskdeploy_triggerrule_trigger_bindings.md#triggers-and-rules"><< previous</a></td>
<td><a href="programming_guide.md#guided-examples">Example Index</a></td>
- <!--<td><a href="">next >></a></td>-->
+ <td><a href="wskdeploy_apigateway_sequence.md#api-gateway-sequence">next >></a></td>
</tr>
</table>
</div>
diff --git a/docs/wskdeploy_apigateway_helloworld.md b/docs/wskdeploy_apigateway_sequence.md
similarity index 56%
copy from docs/wskdeploy_apigateway_helloworld.md
copy to docs/wskdeploy_apigateway_sequence.md
index 570e08d..8ee24c3 100644
--- a/docs/wskdeploy_apigateway_helloworld.md
+++ b/docs/wskdeploy_apigateway_sequence.md
@@ -16,27 +16,32 @@
#
-->
-# API Gateway
+# API Gateway sequence
-## The "Hello World" API
+## Sequencing actions
-This example builds on the ["Hello World" Action](wskdeploy_action_helloworld.md#actions) example by adding an API definition on top of that action so that I can be queried via an HTTP call.
+This example builds on the ["Hello World" API Gateway](wskdeploy_apigateway_helloworld.md#api-gateway) example by combining multiple actions in a sequence to create a complex result and making this sequence available through the API Gateway.
It shows how to:
-- update the Action named ‘hello_world’ to expose it to the gateway.
-- specify the API's endpoint that will trigger the action.
+- create a sequence that chains multiple actions.
+- export the sequence via the gateway.
### Manifest file
-#### _Example: “Hello world” action with API_
+#### _Example: “Hello world” sequence with API_
```yaml
packages:
hello_world_package:
version: 1.0
license: Apache-2.0
actions:
- hello_world:
+ hello_basic:
function: src/hello.js
- web-export: true
+ hello_goodday:
+ function: src/hello_goodday.js
+ sequences:
+ hello_world:
+ actions: hello_basic, hello_goodday
+ web: true
apis:
hello-world:
hello:
@@ -45,17 +50,16 @@ packages:
```
There are two key changes to this file:
-- the `hello_world` action now has the `web-export` flag set to `true`.
-- a new `apis` block has been created.
-
-The `apis` block contains a number of groups of API endpoint. Each endpoint is then defined by the hierarchy. In this case, we are creating the `hello/world` endpoint. The leaf in the structure specifies the action to trigger when the given HTTP verb is sent to that endpoint, in this case, when the HTTP verb `GET` is used on the `hello/world` endpoint, trigger the `hello_world` action.
+- we now have two actions define and neither of them is web available.
+- we have a new sequence that is web available.
+- the `apis` block now refers to the sequence rather than the action.
### Deploying
-You can actually deploy the "hello world API gateway" manifest from the incubator-openwhisk-wskdeploy project directory if you have downloaded it from GitHub:
+You can actually deploy the "API Gateway sequence" manifest from the incubator-openwhisk-wskdeploy project directory if you have downloaded it from GitHub:
```sh
-$ wskdeploy -m docs/examples/manifest_hello_world_apigateway.yaml
+$ wskdeploy -m docs/examples/manifest_hello_world_apigateway_sequence.yaml
```
### Invoking
@@ -77,7 +81,7 @@ The invocation should return a JSON response that includes this result:
```json
{
- "greeting": "Hello, undefined from undefined"
+ "greeting": "Hello, undefined from undefined, have a good day!"
}
```
@@ -89,12 +93,13 @@ $ curl <url>?name=World&place=Earth
### Discussion
-This "hello world" example represents the minimum valid Manifest file which includes only the required parts of the Package, Action and API descriptors.
+This example is very basic but it shows the power of OpenWhisk in creating complex processes by chaining together simple actions and making the resulting sequence available via the API Gateway. This allows you to build small modular actions rather than big bulky ones. And because OpenWhisk allows actions to be written with different programming languages, you can mix and match, for example chaining a combination of JavaScript and Python actions in the same sequence.
### Source code
The source code for the manifest and JavaScript files can be found here:
-- [manifest_hello_world_apigateway.yaml](examples/manifest_hello_world_apigateway.yaml)
+- [manifest_hello_world_apigateway_sequence.yaml](examples/manifest_hello_world_apigateway_sequence.yaml)
- [hello.js](examples/src/hello.js)
+- [hello_goodday.js](examples/src/hello_goodday.js)
### Specification
For convenience, the Packages and Actions grammar can be found here:
@@ -109,7 +114,7 @@ For convenience, the Packages and Actions grammar can be found here:
<div align="center">
<table align="center">
<tr>
- <td><a href="wskdeploy_triggerrule_trigger_bindings.md#triggers-and-rules"><< previous</a></td>
+ <td><a href="wskdeploy_apigateway_helloworld.md#packages"><< previous</a></td>
<td><a href="programming_guide.md#guided-examples">Example Index</a></td>
<!--<td><a href="">next >></a></td>-->
</tr>
--
To stop receiving notification emails like this one, please contact
pdesai@apache.org.