An easy way to try OpenWhisk locally is to use Docker Compose.
The following are required to build and deploy OpenWhisk with Docker Compose:
brew cask install docker
These ports must be available:
80
, 443
, 9000
, 9001
, and 9090
for the API Gateway6379
for Redis2181
for Zookeeper5984
for CouchDB8085
for OpenWhisk's Invoker8888
for OpenWhisk's Controller9092
for Kafka8001
for Kafka Topics UImake quick-start
This command downloads the master
branch from the OpenWhisk repo, it builds OpenWhisk, the docker containers, it starts the system and it executes a simple hello-world
function. At the end of the execution it prints the output of the function:
{ "payload": "Hello, World!" }
If OPENWHISK_PROJECT_HOME
variable is set ( i.e. OPENWHISK_PROJECT_HOME=/path/to/openwhisk make quick-start
) then the command skips downloading the master
branch and uses instead the source code found in the PROJECT_HOME
folder. This is useful for working with a local clone, making changes to the code, and run it with docker-compose
.
This is the set of environment variables that can be set:
OPENWHISK_PROJECT_HOME
- a checkout of openwhiskOPENWHISK_CATALOG_HOME
- a checkout of openwhisk-catalogWSK_CLI
- the directory where the wsk
command line tool can be foundDOCKER_IMAGE_PREFIX
- the prefix of the docker images used for actions. If you are building and testing checkouts of runtimes locally, then consider setting this to whisk
.Note that these are all optional and only need to be set if you have a local checkout that you want to use.
To update the OpenWhisk Invoker or Controller without restarting everything, run:
make restart-invoker
This command destroys the running Invoker instance, waits for the controller to figure out the invoker is down
, then it starts a new Invoker, also waiting until it's marked as up
.
To do the same with the controller run:
make restart-controller
error: Authenticated user does not have namespace 'guest'; set command failed: Get https://localhost:443/api/v1/namespaces: dial tcp [::1]:443: getsockopt: connection refused
Make sure nothing runs on the above listed ports. Port 80 might be commonly in use by a local httpd for example. On a Mac, use sudo lsof -i -P
to find out what process runs on a port. You can turn off Internet Sharing under System Settings > Sharing, or try sudo /usr/sbin/apachectl stop
to stop httpd.
error: Unable to invoke action 'hello': There was an internal server error. (code 5)
Look at the logs in ~/tmp/openwhisk
especially ~/tmp/openwhisk/controller/logs/controller-local_logs.log
that might give more information. This can be an indication that the docker environment doesn't work properly (and on Mac you might need to switch to use Docker for Mac.
Check the issue tracker for more.
You can pull pre-built image
make docker_pull
This command pulls the docker images for local testing and development.
make docker_build
This command builds the opewnhisk core docker images for local testing and development.
make run
This command starts OpenWhisk by calling docker-compose up
, it initializes the database and the CLI.
The following command stops the docker-compose
:
make stop
To remove the stopped containers, clean the database files and the temporary files use:
make destroy
Once OpenWhisk is up and running you can execute a hello-world
function:
make hello-world
This command creates a new JS action, it invokes it, and then it deletes it. The javascript action is:
function main(params) { var name = params.name || "World"; return {payload: "Hello, " + name + "!"}; }
The result of the invocation should be printed on the terminal:
{ "payload": "Hello, World!" }
Here is a tutorial on getting started with actions.
OpenWhisk has numerous extra packages that are often installed into the /whisk.system
namespace.
These are not included by default with the devtools make quick-start
command.
If you want to install these packages, run the following make command.
make add-catalog
Once the installation process has completed, you can check the whisk.system
namespace to verify it those packages are now available.
wsk package list /whisk.system
If you want to pull new containers you can use make pull
to update all the containers used in the docker-compose file.
OpenWhisk supports feed providers for invoking triggers from external event sources.
Feed provider packages are not included by default with the devtools make quick-start
command.
Providers for the alarms
, kafka
and cloudant
feeds can be installed individually using the make
command.
make create-provider-alarms make create-provider-kafka make create-provider-cloudant
Once the installation process has completed, you can check the whisk.system
namespace to verify it the feed packages are now available.
wsk package list /whisk.system
~/tmp/openwhisk/controller/logs/
~/tmp/openwhisk/invoker/logs/
docker-compose
logs - ~/tmp/openwhisk/docker-compose.log
docker-compose
feed provider logs - ~/tmp/openwhisk/docker-provider-compose.log
~/tmp/openwhisk/<feed_name>provider
wsk -i activation logs <activationId>
To start docker-compose
with custom images used for running actions use the following 2 variables:
DOCKER_REGISTRY
- specify a custom docker registry. I.e DOCKER_REGISTRY=registry.example.com make quick-start
DOCKER_IMAGE_PREFIX
- specify a custom image prefix. I.e. DOCKER_IMAGE_PREFIX=my-prefix make quick-start
These 2 variable allow you to execute a JS action using the container registry.example.com/my-prefix/nodejs6action
.
By default this setup uses published images for controller and invokers from openwhisk
namespace i.e. openwhisk/controller
and openwhisk/invoker
. To make use of locally build images you can use DOCKER_OW_IMAGE_PREFIX
variable i.e. DOCKER_OW_IMAGE_PREFIX=whisk make quick-start