Skip to content
Curated catalog of Apache OpenWhisk packages to interface with event producers and consumers
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
gradle/wrapper
packages
tests
tools/travis
.gitignore
.jshintrc
.scalafmt.conf
.travis.yml
CONTRIBUTING.md
DISCLAIMER.txt
LICENSE.txt
NOTICE.txt
README.md
credentials.json.enc
gradlew
gradlew.bat
settings.gradle

README.md

Openwhisk Catalog

Build Status License

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 packages/installCatalog.sh to install the catalog like:

./packages/installCatalog.sh [catalog_auth_key] [api_host] [cli_path]

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. The third argument cli_path is the full path to the wsk cli executable.

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.

Disclaimer

Apache OpenWhisk Catalog is an effort undergoing incubation at The Apache Software Foundation (ASF), sponsored by the Apache Incubator. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate that the project has yet to be fully endorsed by the ASF.

You can’t perform that action at this time.