Skip to main content

OpenWhisk CLI

What is OpenWhisk​

Apache OpenWhisk is an open-source, a serverless platform that executes custom functions. It manages the infrastructure, servers, and scaling using Docker containers. As per its programming model, Developers write functional logic called Actions, in any supported programming language. These actions can be dynamically scheduled and run in response to Triggers from external sources called Feeds or from HTTP requests.

OpenWhisk supports a growing set of Programming languages. It has REST API-based Command Line Interface (CLI) to support the deployment of actions.

You can configure OpenWhisk using Hypi CLI or OpenWhisk CLI. It is advisable to use Hypi CLI.

Hypi CLI for OpenWhisk​

You can configure OpenWhisk with Hypi CLI. Install Hypi CLI using this guide for installation. Configure the serverless function domain using Hypi CLI.

Login to Hypi App Instance. Enter the API hostname and the serverless function domain.

hypi login -d
? Please enter API domain, default  (https://api.hypi.app) : https://api.hypi.app
? Please enter Fn domain, default  (https://fn.hypi.app) : https://fn.hypi.app
Enter domain and token
? Domain?  professionally.apps.hypi.app
? Token?  <Auth-Token>
Logged in successfully
ok: whisk auth set. Run 'wsk property get --auth' to see the new value.
ok: whisk API host set to 'https://fn.hypi.app'

This completes the configuration of OpenWhisk. Now, you can create your own Serverless Functions. Use below steps for installation of OpenWhisk CLI if you opt to use it.

Install OpenWhisk CLI​

Install the latest version of OpenWhisk CLI (wsk) for your Operating system as per the instructions given in the below link.

https://github.com/apache/openwhisk-cli/releases

Make sure to set PATH environmental variable pointing towards wsk binary file. Verify the installation using the following command. You may get the list of available commands.

wsk --help

Configure OpenWhisk​

Before using OpenWhisk, you must configure it to point towards Hypi's API endpoint and provide associated authentication credentials.

wsk property set​

Run the follwing command to set Hypi Instance Domain as OpenWhisk Host.

hypi wsk property set --apihost "https://fn.hypi.app" --auth "<InstanceDomain\>:<Auth_Key>"

Here \<InstanceDomain> is App Instance Domain, e.g. proudest.apps.hypi.app and \<Auth_Key> is the Authorization token of that domain.

API endpoint to implement serverless functionality with Hypi is https://fn.hypi.app