Skip to content

Latest commit

 

History

History
94 lines (69 loc) · 4.68 KB

README.md

File metadata and controls

94 lines (69 loc) · 4.68 KB

OpenWhisk

Build Status License Join Slack codecov Twitter

OpenWhisk is a cloud-first distributed event-based programming service. It provides a programming model to upload event handlers to a cloud service, and register the handlers to respond to various events. Learn more at http://openwhisk.apache.org.

Quick Start

The easiest way to start using OpenWhisk is to get Docker installed on Mac, Windows or Linux. The Docker website has detailed instructions on getting the tools installed. This does not give you a production deployment but gives you enough of the pieces to start writing functions and seeing them run.

git clone https://github.com/apache/openwhisk-devtools.git
cd openwhisk-devtools/docker-compose
make quick-start

For more detailed instructions or if you encounter problems see the OpenWhisk-dev tools project.

Kubernetes Setup

Another path to quickly starting to use OpenWhisk is to install it on a Kubernetes cluster. On a Mac, you can use the Kubernetes support built into Docker 18.06 (or higher). You can also deploy OpenWhisk on Minikube, on a managed Kubernetes cluster provisioned from a public cloud provider, or on a Kubernetes cluster you manage yourself. To get started,

git clone https://github.com/apache/openwhisk-deploy-kube.git

Then follow the instructions in the OpenWhisk on Kubernetes README.md.

Native development

Docker must be natively installed in order to build and deploy OpenWhisk. If you plan to make contributions to OpenWhisk, we recommend either a Mac or Ubuntu environment.

Learn concepts and commands

Browse the documentation to learn more. Here are some topics you may be interested in:

Repository Structure

The OpenWhisk system is built from a number of components. The picture below groups the components by their GitHub repos. Please open issues for a component against the appropriate repo (if in doubt just open against the main openwhisk repo).

component/repo mapping

Issues

Report bugs, ask questions and request features here on GitHub.

Slack

You can also join the OpenWhisk Team on Slack https://openwhisk-team.slack.com and chat with developers. To get access to our public slack team, request an invite https://openwhisk.apache.org/slack.html.