- The runtime provides nodejs v10 with a set of npm packages see nodejs10/CHANGELOG.md
- The runtime provides nodejs v12 with a set of npm packages see nodejs12/CHANGELOG.md
- The runtime provides nodejs v14 with a set of npm packages see nodejs14/CHANGELOG.md
The runtime provides the following npm packages for IBM Cloud:
- IBM DB2/DashDB and IBM Informix ibm_db
- IBM Cloudant @cloudant/cloudant
- IBM Watson Cloud watson-developer-cloud
- IBM Cloud Object Storage ibm-cos-sdk
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
To use as a nodejs kind action
ibmcloud wsk action update myAction myAction --kind nodejs:10 Tip: Not available yet in the IBM Cloud
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.
Install dependencies from the root directory on $OPENWHISK_HOME repository
./gradlew install - Import project as gradle project.
- Make sure working directory is root of the project/repo
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
- 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" - Check if there is a new version of the Node.js LTS 14.
nvm ls-remote | grep v14. - If there is a new version update the OpenWhisk Node.js 14 Dockerfile and submit PR.
- After PR is merged wait for Travis CI to build and push a new tag image for openwhisk/action-nodejs-v14
- Update the ibm image nodejs14/Dockerfile FROM usign the new upstream tag
- Check if there are new npm packages available
- Use the latest released image to check the outdated npm packages
docker run --rm -it ibmfunctions/action-nodejs-v14:$VERSION sh -c "cd / && npm outdated"- Update nodejs14/package.json
- Update nodejs14/CHANGELOG.md
- 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" - Check if there is a new version of the Node.js LTS 12.
nvm ls-remote | grep v12. - If there is a new version update the OpenWhisk Node.js 12 Dockerfile and submit PR.
- After PR is merged wait for Travis CI to build and push a new tag image for openwhisk/action-nodejs-v12
- Update the ibm image nodejs12/Dockerfile FROM usign the new upstream tag
- Check if there are new npm packages available
- Use the latest released image to check the outdated npm packages
docker run --rm -it ibmfunctions/action-nodejs-v12:$VERSION sh -c "cd / && npm outdated"- Update nodejs12/package.json
- Update nodejs12/CHANGELOG.md
- 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" - Check if there is a new version of the Node.js LTS 10.
nvm ls-remote | grep v10. - If there is a new version update the OpenWhisk Node.js 10 Dockerfile and submit PR.
- After PR is merged wait for Travis CI to build and push a new tag image for openwhisk/action-nodejs-v10
- Update the ibm image nodejs10/Dockerfile FROM usign the new upstream tag
- Check if there are new npm packages available
- Use the latest released image to check the outdated npm packages
docker run --rm -it ibmfunctions/action-nodejs-v10:$VERSION sh -c "cd / && npm outdated"- Update nodejs10/package.json
- Update nodejs10/CHANGELOG.md
- 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
latesttag for each runtime.
git tag 14@latest -f git push upstream 14@latest -f