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 https://developer.ibm.com/openwhisk or try it on IBM Bluemix OpenWhisk.

• Quick Start
• Other Configurations
• Learn concepts and commands
• License
• Issues

A Vagrant machine is the easiest way to run OpenWhisk on Mac, Windows PC or GNU/Linux. Download and install Vagrant for your operating system and architecture.

Follow these step to run your first OpenWhisk Action:

# Clone openwhisk
git clone --depth=1 https://github.com/openwhisk/openwhisk.git

# Change directory to tools/vagrant/simple
cd openwhisk/tools/vagrant/simple

# Run script to create vm and run hello action
./hello

Wait for hello action output:

vagrant ssh -- wsk action invoke /whisk.system/samples/echo -p message hello --blocking --result
{
    "message": "hello"
}

For more information about the simple vagrant scenario see the tools/vagrant/simple/README.md

The quick start above uses an ephemeral datastore that does not persist data when the vm is reloaded. The following instructions allow you to configure OpenWhisk to use a persistent datastore via Cloudant or CouchDB.

These steps were tested on Mac OS X El Capitan, Ubuntu 14.04.3 LTS and may work on Windows using Vagrant.

• Vagrant on Mac, Windows PC, or GNU/Linux
• OpenWhisk on Ubuntu natively

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

• System overview
• Getting Started
• Create and invoke actions
• Create triggers and rules
• Use and create packages
• Browse and use the catalog
• Using the OpenWhisk mobile SDK
• OpenWhisk system details

Copyright 2015-2016 IBM Corporation

Licensed under the Apache License, Version 2.0 (the "License").

Unless required by applicable law or agreed to in writing, software distributed under the license is distributed on an "as is" basis, without warranties or conditions of any kind, either express or implied. See the license for the specific language governing permissions and limitations under the license.

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