OpenWhisk - Quick Start


  1. Node.js v6.5.0 or later.
  2. Serverless CLI v1.9.0 or later. You can run npm install -g serverless to install it.
  3. An IBM Bluemix account. If you don't already have one, you can sign up for an account and then follow the instructions for getting access to OpenWhisk on Bluemix.
  4. Set-up your Provider Credentials.
  5. Install Framework & Dependencies Due to an outstanding issue with provider plugins, the OpenWhisk provider must be installed as a global module.
$ npm install --global serverless serverless-openwhisk

Create a new service

Create a new service using the Node.js template, specifying a unique name and an optional path for your service.

# Create a new Serverless Service/Project
$ serverless create --template openwhisk-nodejs --path my-service
# Change into the newly created directory
$ cd my-service
# Install npm dependencies
$ npm install

Using a self-hosted version of the platform?

Ensure you set the ignore_certs option in the serverless.yaml prior to deployment.

  name: openwhisk
  ignore_certs: true

Deploy, test and diagnose your service

  1. Deploy the Service

Use this when you have made changes to your Functions, Events or Resources in serverless.yml or you simply want to deploy all changes within your Service at the same time.

serverless deploy -v
  1. Deploy the Function

Use this to quickly upload and overwrite your function code, allowing you to develop faster.

serverless deploy function -f hello
  1. Invoke the Function

Invokes the Function and returns results.

serverless invoke --function hello
# results
  "payload": "Hello, World!"

serverless invoke --function hello --data '{"name": "OpenWhisk"}'
  "payload": "Hello, OpenWhisk!"
  1. Fetch the Function Logs

Open up a separate tab in your console and stream all logs for a specific Function using this command.

serverless logs -f hello -t


If at any point, you no longer need your service, you can run the following command to remove the Functions, Events and Resources that were created, and ensure that you don't incur any unexpected charges.

serverless remove

Check out the Serverless Framework Guide for more information.

Go to Github