https://github.com/apache/openwhisk-catalog
Curated catalog of Apache OpenWhisk packages to interface with event producers and consumers
https://github.com/apache/openwhisk-catalog
apache cloud faas functions-as-a-service openwhisk serverless serverless-architectures serverless-functions
Last synced: 12 months ago
JSON representation
Curated catalog of Apache OpenWhisk packages to interface with event producers and consumers
- Host: GitHub
- URL: https://github.com/apache/openwhisk-catalog
- Owner: apache
- License: apache-2.0
- Created: 2016-06-02T14:43:52.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2024-09-24T15:30:40.000Z (over 1 year ago)
- Last Synced: 2025-04-02T12:59:53.260Z (12 months ago)
- Topics: apache, cloud, faas, functions-as-a-service, openwhisk, serverless, serverless-architectures, serverless-functions
- Language: JavaScript
- Homepage: https://openwhisk.apache.org/
- Size: 495 KB
- Stars: 34
- Watchers: 30
- Forks: 49
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Openwhisk Catalog
[](https://travis-ci.com/apache/openwhisk-catalog)
[](http://www.apache.org/licenses/LICENSE-2.0)
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 Slack and GitHub.system packages and sample packages.
The catalog is available as packages in the `/whisk.system` namespace. See [Browsing packages](https://github.com/openwhisk/openwhisk/blob/master/docs/packages.md#browsing-packages)
for information about how to browse the catalog by using the command line tool.
## How to install openWhisk-catalog
### Pre-requisites
- [openwhisk](https://github.com/openwhisk/openwhisk/blob/master/README.md) 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/installCatalogUsingWskdeploy.sh](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](./packages/github/README.md) | offers a convenient way to use the [GitHub APIs](https://developer.github.com/). |
| [/whisk.system/slack](./packages/slack/README.md) | offers a convenient way to use the [Slack APIs](https://api.slack.com/). |
| [/whisk.system/websocket](./packages/websocket/README.md) | 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](https://github.com/openwhisk/openwhisk-package-template). It will provide a good example on what a good template should include (i.e., sufficient help build, test and integrate into OpenWhisk).