alexxnica / incubator-openwhisk-catalog

Curated catalog of Apache OpenWhisk packages to interface with event producers and consumers

Openwhisk Catalog

This openwhisk-catalog maintains the package catalogs of openwhisk. In OpenWhisk, the catalog of packages gives you an easy way to enhance your app with useful capabilities, and to access external services in the ecosystem. Examples of external services that are OpenWhisk-enabled include IBM Watson API, the Weather Company, Slack, and GitHub.system packages and sample packages.

The catalog is available as packages in the /whisk.system namespace. See Browsing packages for information about how to browse the catalog by using the command line tool.

How to install openWhisk-catalog

Pre-requisites

• openwhisk is installed.
• Environment variable OPENWHISK_HOME is configured as the path to openwhisk source code directory.

Install openwhisk-catalog

We should be able to run the script installCatalog.sh to install the catalog like:

./installCatalog.sh [catalog_auth_key] [api_host]

The first argument catalog_auth_key, defines the secret key used to authenticate the openwhisk service. The second argument api_host, determines the location, where the openwhisk edge host is running, in the format of IP or hostname.

Existing packages in catalog

Package	Description
/whisk.system/github	offers a convenient way to use the GitHub APIs.
/whisk.system/slack	offers a convenient way to use the Slack APIs.
/whisk.system/watson-translator	Package for text translation and language identification
/whisk.system/watson-speechToText	Package to convert speech into text
/whisk.system/watson-textToSpeech	Package to convert text into speech
/whisk.system/weather	Services from the Weather Company Data for IBM Bluemix API
/whisk.system/websocket	Package to send messages to Web Socket server

How to create packages

If you want to create your own packages, openwhisk-package-template is a good package creation template to help you build, test and integrate new packages.

For more details about how to use these packages, you can go to the README.md under each package folder.