Introduce tutorial to deploy NodeJS runtime locally #190

bragaigor · 2021-03-11T14:16:20Z

The introduced tutorial uses Docker and a tranfer data
tool (e.g. curl, wget or Postman). A summary of the tutorial
steps are:

Create docker container based on core/nodejs14Action
Dockerfile
Deploy/run the container locally
Create function that resides in a json file
Initialize the function against the deployed container
using either curl, wget or Postman
Call/trigger function using either curl, wget or Postman

Signed-off-by: Igor Braga higorb1@gmail.com

bragaigor · 2021-03-11T14:16:41Z

cc: @mrutkows

The introduced tutorial uses Docker and a tranfer data tool (e.g. curl, wget or Postman). A summary of the tutorial steps are: 1. Create docker container based on core/nodejs14Action Dockerfile 2. Deploy/run the container locally 3. Create function that resides in a json file 4. Initialize the function against the deployed container using either curl, wget or Postman 5. Call/trigger function using either curl, wget or Postman Signed-off-by: Igor Braga <higorb1@gmail.com>

mrutkows

@bragaigor In general, we want all the runtimes to feature Gradle Wrapper as the simplified means for developers to build and test the runtime code (i.e., get developing the code) as the wrapper handles all installs. The manual Docker method you are adding is valuable, but should be clearly moved down as a secondary option leaving "intact" the exiting README text as it appears now as much as possible. In addition, we should avoid copying over Dockerfiles or creating artifacts which could accidentally be committed into the repo. by accident.

README.md

mrutkows · 2021-03-12T18:25:44Z

README.md

+git reset --hard origin/master
+```
+
+2. Build docker


Subsection "Build the docker image"

mrutkows · 2021-03-12T18:26:10Z

README.md

+
+Or in the command line you can simply type:
+```
+cp core/nodejs14Action/Dockerfile core/nodejsActionBase/


Really do not like overwriting the Dockerfile in nodejsActionBase; is there an alternative (and one that we can make sure is part of /gitignore to avoid developers accidentally committing to the repo.?

Reorder tutorial so that Gradle instructions come first Signed-off-by: Igor Braga <higorb1@gmail.com>

mrutkows · 2021-04-14T17:24:47Z

README.md


 **Do you want to learn more about using Node.js actions to build serverless applications?** Please see the main project documentation [here](https://github.com/apache/openwhisk/blob/master/docs/actions-nodejs.md) for that information.

-## Usage


Usage should remain the title. It is how you invoke this runtime from the CLI and not a "gradle" usage. Perhaps this section needs to have its title reverted and moved above either "gradle" or "docker" specific sections (and clarify that this is how you use this runtime and select the correct versions.

mrutkows · 2021-04-14T17:27:15Z

README.md

+
+---
+
+## Using Gradle <a name="using_gradle"></a>


Adopting the "Build" -> "Using Gradle" section eliminates need for HTML anchor

mrutkows · 2021-04-14T17:30:17Z

README.md

 **Do you want to learn more about using Node.js actions to build serverless applications?** Please see the main project documentation [here](https://github.com/apache/openwhisk/blob/master/docs/actions-nodejs.md) for that information.

-## Usage
+## Build Runtimes


Actually, the notion of "build" (section) should be moved below sections "Usage", "Images", and "Development" as all are common/general info. not dependent on the gradle or docker (manual) builds.

Then you would have perhaps a layout like:

Usage

NodeJS 10,12,etc.

Images

Runtimes manifest

Development

Building Runtimes

Choices are:

Gradle (link to unique header)

Docker (link to unique header)

Using Gradle

Prerequisites

Building

Testing

Using Docker

Prerequisites

Building

Testing

Testing functions with arguments

Example: Calculate the nth Fibonacci number

mrutkows · 2021-04-14T17:34:19Z

README.md

+
+### Pre-requisites
+- [Docker](https://www.docker.com/)
+- [curl](https://curl.se/), [wget](https://www.gnu.org/software/wget/), or [Postman](https://www.postman.com/)


add some reason why you would choose this (manual) method over GRadle... e.g.,
"The Gradle Wrapper build method uses Docker internally to automate many functions. If you prefer building and testing with Docker directly, we have provided the following instructions"

mrutkows · 2021-04-14T17:47:06Z

README.md


 The `core/nodejsActionBase` folder contains the Node.js app server used to implement the [action interface](https://github.com/apache/openwhisk/blob/master/docs/actions-new.md#action-interface), used by the platform to inject action code into the runtime and fire invocation requests. This common code is used in all runtime versions.

-### Build


See layout suggested above

mrutkows · 2021-04-14T17:51:33Z

README.md

+cp core/nodejs14Action/Dockerfile build
+```
+
+If you follow the instructions at beginning of this tutorial [here](#build_gradle) that uses Gradle, you'll notice that Gradle takes care of this copying for us internally. Here since we just want to use docker and not worry about anything else we make create our own little build folder.


Do not refer to this page as a "tutorial"; instead add a subsection "Resetting the build"

mrutkows · 2021-04-14T17:52:59Z

README.md

+docker images
+```
+
+2.2. Tag image (Optional step). Required if you’re pushing your docker image to a registry e.g. dockerHub


Subsection "(Optional) Tagging the image"

mrutkows · 2021-04-14T17:54:08Z

README.md

+docker tag <docker_image_ID> <dockerHub_username>/nodejs-action-v14:1.0-SNAPSHOT
+```
+
+3. Run docker on localhost with either the following commands:


Move under "Testing" subsection

mrutkows · 2021-04-14T17:54:40Z

README.md

+```
+
+
+## Creating functions with arguments


subsection (see sugg. layout above)

mrutkows · 2021-04-14T17:54:51Z

README.md

+XXX_THE_END_OF_A_WHISK_ACTIVATION_XXX
+```
+
+## Now let's create a more interesting function


subsection (see sugg. layout above)

dgrove-oss · 2022-08-15T13:37:39Z

Closing as abandoned

bragaigor force-pushed the tutorial_nodejs branch from 8363814 to c4ad232 Compare March 11, 2021 15:27

mrutkows requested changes Mar 12, 2021

View reviewed changes

Add build folder to .gitignore and address issue comments

6699cba

Reorder tutorial so that Gradle instructions come first Signed-off-by: Igor Braga <higorb1@gmail.com>

bragaigor force-pushed the tutorial_nodejs branch from 8c30c7f to 6699cba Compare March 13, 2021 01:31

mrutkows requested changes Apr 14, 2021

View reviewed changes

dgrove-oss closed this Aug 15, 2022


		Do you want to learn more about using Node.js actions to build serverless applications? Please see the main project documentation [here](https://github.com/apache/openwhisk/blob/master/docs/actions-nodejs.md) for that information.

		## Usage


		The `core/nodejsActionBase` folder contains the Node.js app server used to implement the [action interface](https://github.com/apache/openwhisk/blob/master/docs/actions-new.md#action-interface), used by the platform to inject action code into the runtime and fire invocation requests. This common code is used in all runtime versions.

		### Build

Introduce tutorial to deploy NodeJS runtime locally #190

Introduce tutorial to deploy NodeJS runtime locally #190

Uh oh!

Conversation

bragaigor commented Mar 11, 2021

Uh oh!

bragaigor commented Mar 11, 2021

Uh oh!

mrutkows left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

mrutkows Mar 12, 2021 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Usage

Images

Runtimes manifest

Development

Building Runtimes

Using Gradle

Prerequisites

Building

Testing

Using Docker

Prerequisites

Building

Testing

Testing functions with arguments

Example: Calculate the nth Fibonacci number

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

dgrove-oss commented Aug 15, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

mrutkows Mar 12, 2021 •

edited

Loading

dgrove-oss commented Aug 15, 2022 •

edited

Loading