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 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_HOMEis configured as the path toopenwhisksource code directory.
Install openwhisk-catalog
We should be able to run the script packages/installCatalogUsingWskdeploy.sh to install the catalog like:
./packages/installCatalogUsingWskdeploy.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
For more details about how to use packages in the catalog, you can go to the README.md under each package subfolder.
| 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/weather | Services from the Weather Company Data for IBM Cloud API |
| /whisk.system/websocket | Package to send messages to Web Socket server |
How to create top-level packages
If your package is more involved you may want to create your own top-level packages repository using the openwhisk-package-template. It will provide a good example on what a good template template should include (i.e., sufficient help build, test and integrate into OpenWhisk).