Skip to content
This repository was archived by the owner on Jan 17, 2025. It is now read-only.

ibm-functions/runtime-nodejs

Repository files navigation

IBM Cloud Functions runtime for nodejs

Build Status

The runtime provides the following npm packages for IBM Cloud:

How to use as a docker Action

To use as a docker action

ibmcloud wsk action update myAction myAction.js --docker ibmfunctions/action-nodejs-ibm-v10 

This works on any deployment of Apache OpenWhisk or IBM Cloud Functions

Future: IBM Cloud Functions (based on Apache OpenWhisk)

To use as a nodejs kind action

ibmcloud wsk action update myAction myAction --kind nodejs:10 

Tip: Not available yet in the IBM Cloud

Working with the local git repo

Prerequisite: Export OPENWHISK_HOME to point to your incubator/openwhisk cloned directory.

To build the nodejs:10 runtime:

./gradlew nodejs10:distDocker 

This will produce the image whisk/action-nodejs-ibm-v10

To build the nodejs:12 runtime:

./gradlew nodejs12:distDocker 

This will produce the image whisk/action-nodejs-ibm-v12

Build and Push image

docker login ./gradlew nodejs10:distDocker -PdockerImagePrefix=$prefix-user -PdockerRegistry=docker.io 

Deploy OpenWhisk using ansible environment that adds the new king nodejs:10 Assuming you have OpenWhisk already deploy localy and OPENWHISK_HOME pointing to root directory of OpenWhisk core repository.

Set ROOTDIR to the root directory of this repository.

Redeploy OpenWhisk

cd $OPENWHISK_HOME/ansible ANSIBLE_CMD="ansible-playbook -i ${ROOTDIR}/ansible/environments/local" $ANSIBLE_CMD setup.yml $ANSIBLE_CMD couchdb.yml $ANSIBLE_CMD initdb.yml $ANSIBLE_CMD wipe.yml $ANSIBLE_CMD openwhisk.yml 

To use as docker action push to your own dockerhub account

docker tag whisk/action-nodejs-ibm-v10 $user_prefix/action-nodejs-ibm-v10 docker push $user_prefix/action-nodejs-ibm-v10 

Then create the action using your the image from dockerhub

wsk action update myAction myAction.js --docker $user_prefix/action-nodejs-ibm-v10 

The $user_prefix is usually your dockerhub user id.

Testing

Install dependencies from the root directory on $OPENWHISK_HOME repository

./gradlew install 

Using IntelliJ:

  • Import project as gradle project.
  • Make sure working directory is root of the project/repo

Using Gradle

To run all tests: ./gradlew tests:test this include tests depending on credentials

To run all tests except those which do not rely on credentials ./gradlew tests:testWithoutCredentials

To run a single test-class: ./gradlew tests:test --tests <SomeGradleTestFilter>

For example, in order to execute the tests in /tests/src/test/scala/actionContainers/IBMNodeJSActionDB2Tests.scala, run: ./gradlew tests:test --tests *IBMNodeJsActionDB2Tests

Note: If you're running all tests locally with credentials like ./gradlew tests:test or ./gradlew tests:test --tests *CredentialsIBMNodeJsActionWatsonTests you need to set up a tests/credentials.json file containing Watson credentials in the format of:

{ "language_translation":[ { "credentials": { "url": "", "apikey": "" } } ], "cloudantNoSQLDB":[ { "credentials": { "url": "", "host": "", "port": "" , "password": "", "username": "" } } ], "dashDB":[ { "credentials": { "ssldsn": "DATABASE=BLUDB;HOSTNAME=<hostname_value>;PORT=50001;PROTOCOL=TCPIP;UID=<username_value>;PWD=<password_value>;Security=SSL;" } } ], "cloud-object-storage":[ { "credentials": { "resource_instance_id": "", "apikey": "" } } ], } 

Then update the whisk.properties file located in the directory $OPENWHISK_HOME, using the variable vcap.services.file

Maintenance Tasks

Updating Node.js 14 runtime

  • Get the version of the latest tag ibm image
VERSION=$(git tag | grep 14@ | tail -2 | head -1 | awk -F"@" '{print $2 }') 
  • Check the version of nodejs on the latest ibm image released
docker run --rm -it ibmfunctions/action-nodejs-v14:$VERSION sh -c "node -v" 
nvm ls-remote | grep v14. 

Updating Node.js 12 runtime

  • Get the version of the latest tag ibm image
VERSION=$(git tag | grep 12@ | tail -2 | head -1 | awk -F"@" '{print $2 }') 
  • Check the version of nodejs on the latest ibm image released
docker run --rm -it ibmfunctions/action-nodejs-v12:$VERSION sh -c "node -v" 
nvm ls-remote | grep v12. 

Updating Node.js 10 runtime

  • Get the version of the latest tag ibm image
VERSION=$(git tag | grep 10@ | tail -2 | head -1 | awk -F"@" '{print $2 }') 
  • Check the version of nodejs on the latest ibm image released
docker run --rm -it ibmfunctions/action-nodejs-v10:$VERSION sh -c "node -v" 
nvm ls-remote | grep v10. 

Pushing new versions for runtimes

  • After the PR is merged and the master pass Travis CI, checkout master.
  • Create tag for each runtime and push upstream
git tag 14@<new version> git push upstream 14@<new version> 
  • After the image is deployed to production update the latest tag for each runtime.
git tag 14@latest -f git push upstream 14@latest -f 

License

Apache 2.0

About

⛔️ DEPRECATED - IBM Cloud Functions NodeJS Runtime

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 12