Edit on github


The Serverless Framework needs access to account credentials for your OpenWhisk provider so that it can create and manage resources on your behalf.

OpenWhisk is an open-source serverless platform. This means you can either choose to run the platform yourself or choose to use a hosted provider's instance.

Here we'll provide setup instructions for both options, just pick the one that you're using.

#Register with OpenWhisk platform (IBM Bluemix)

IBM's Bluemix cloud platform provides a hosted serverless solution based upon Apache OpenWhisk.

Here's how to get started…

IBM Bluemix comes with a free trial that doesn't need credit card details for the first 30 days. Following the trial, developers have to enrol using a credit card but get a free tier for the platform and services.

All IBM Bluemix users get access to the Free Tier for OpenWhisk. This includes 400,000 GB-seconds of serverless function compute time per month.

Additional execution time is charged at $0.000017 per GB-second of execution, rounded to the nearest 100ms.

#Access Account Credentials

Once you have signed up for IBM Bluemix, we need to retrieve your account credentials. These are available on the page about installing the command-line tool from the service homepage.

The second point in the instructions contains a command-line which includes the platform endpoint and authentication keys.

wsk property set --apihost openwhisk.ng.bluemix.net --auth XXX:YYY

Make a note of the apihost and auth command flag values.

#(optional) Install command-line utility

The command-line utility is linked from the previous page. Download and install the binary into a location in your shell path.

#Register with OpenWhisk platform (Self-Hosted)

Following the Quick Start guide will let you run the platform locally using a Virtual Machine.

  • Download and install Vagrant for your platform.
  • Run the following commands to retrieve, build and start an instance of the platform.
# Clone openwhisk
git clone --depth=1 https://github.com/openwhisk/openwhisk.git

# Change directory to tools/vagrant
cd openwhisk/tools/vagrant

# Run script to create vm and run hello action

This platform will now be running inside a virtual machine at the following IP address:

#Access Account Credentials

The default environment has a guest account configured with the authentication key available here: https://github.com/openwhisk/openwhisk/blob/master/ansible/files/auth.guest

Use the address as the apihost value needed below.

#(optional) Install command-line utility

Building OpenWhisk from a cloned repository will result in the generation of the command line interface in openwhisk/bin/go-cli/. The default executable in this location will run on the operating system and CPU architecture on which it was built.

Executables for other operating system, and CPU architectures are located in the following directories: openwhisk/bin/go-cli/macopenwhisk/bin/go-cli/linuxopenwhisk/bin/go-cli/windows.

Download and install the correct binary into a location in your shell path.

#Using Account Credentials

You can configure the Serverless Framework to use your OpenWhisk credentials in two ways:

#Quick Setup

As a quick setup to get started you can export them as environment variables so they would be accessible to Serverless Framework:

export OW_AUTH=<your-key-here>
export OW_APIHOST=<your-api-host>
# OW_AUTH and OW_APIHOST are now available for serverless to use
serverless deploy

#Using Configuration File

For a more permanent solution you can also set up credentials through a configuration file. Here are different methods you can use to do so.

#Setup with the wsk cli

If you have followed the instructions above to install the wsk command-line utility, run the following command to create the configuration file.

$ wsk property set --apihost PLATFORM_API_HOST --auth USER_AUTH_KEY

Credentials are stored in ~/.wskprops, which you can edit directly if needed.

#Edit file manually

The following configuration values should be stored in a new file (.wskprops) in your home directory. Replace the PLATFORM_API_HOST and USER_AUTH_KEY values will the credentials from above.