This repository can be used to deploy OpenWhisk to a Kubernetes cluster.

• Requirements
• Setting up Kubernetes
• Configuring OpenWhisk
• Cleanup
• Issues

Several requirements must be met for OpenWhisk to deploy on Kubernetes.

Kubernetes

• Kubernetes version 1.6+. However, avoid Kubernetes 1.6.3 due to an issue with volume mount subpaths. Our Travis CI testing uses Kubernetes version 1.7.4.
• The ability to create Ingresses to expose a Kubernetes service to the outside of a cluster so you can actually use OpenWhisk.
• Endpoints of Kubernetes services must be able to loopback to themselves ("hairpin mode").

OpenWhisk

• Docker version 1.12+

For local development and testing, we recommend using Minikube version 0.23+ with the docker network in promiscuous mode. Our Travis CI testing using Minikube 0.23.0. Take a look at these instructions.

You can also provision a Kubernetes cluster from a cloud provider, subject to the cluster meeting the requirements above.

• Create the openwhisk namespace: kubectl apply -f configure/openwhisk_kube_namespace.yml

To deploy OpenWhisk on Kubernetes, you must deploy its components in the proper order. Detailed instructions and the supporting .yml files can be found in the kubernetes directory tree. You will need to follow the instructions for each step in order.

• Configure or deploy CouchDB.
  • For development and testing purposes, this repo includes a configuration for deploying a simple non-persistent CouchDB instance within the Kubernetes cluster.
  • For a production level CouchDB instance, take a look at the main OpenWhisk documentation for configuring CouchDB.
• Deploy ApiGateway
• Deploy Zookeeper
• Deploy Kafka
• Deploy Controller
• Deploy Invoker
• Deploy Nginx
• Deploy Ingress

If you don't already have the wsk cli, follow the instructions here to get it.

Configure the wsk cli by setting the auth and apihost properties (replace API_HOST with the URL appropriate for the Ingress you deployed).

wsk property set --auth 23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP --apihost https://API_HOST

To do this, you will need to set the OPENWHISK_HOME environment variable to a git clone of the main OpenWhisk repository and replace API_HOST with the URL appropriate for the Ingress you deployed:

export OPENWHISK_HOME [location of your OpenWhisk clone]

pushd /tmp
  git clone https://github.com/apache/incubator-openwhisk-catalog
  cd incubator-openwhisk-catalog/packages
  ./installCatalog.sh 789c46b1-71f6-4ed5-8c54-816aa4f8c502:abczO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP https://API_HOST
popd

Your OpenWhisk installation should now be usable. You can test it by following these instructions to define and invoke a sample OpenWhisk action in your favorite programming language.

At some point there might be a need to cleanup the Kubernetes environment. For this, we want to delete all the OpenWhisk deployments, services, jobs and whatever else might be there. We provide a script to do this:

./configure/cleanup.sh

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

You can also join our slack channel and chat with developers. To get access to our slack channel, request an invite here.