Google Git
Sign in
apache / openwhisk-deploy-kube / 79e9395e6504acbaec0699de395a1e8529cffe43
commit79e9395e6504acbaec0699de395a1e8529cffe43[log] [tgz]
authorTom Xing <xingzhou@cn.ibm.com>Tue Apr 17 23:44:42 2018 +0800
committerDavid Grove <dgrove-oss@users.noreply.github.com>Tue Apr 17 11:44:42 2018 -0400
tree81df65f90a59915ff824bc5e4dfbba3fc359d88e
parent37fbcb7b32a8ee69790e31ca89e948bbadacfdff [diff]
Use helm to deploy openwhisk on top of kuberentes. (#182)

This patch provides a way to use Kubernetes helm charts to deploy
a minimum openwhisk cluster on top of kubernetes. The detail procedure
of deployment can be found in the README file in this patch.

The original repo of this patch can be found at:
https://github.com/xingzhou/Deploy_OpenWhisk_With_Helm
37 files changed
tree: 81df65f90a59915ff824bc5e4dfbba3fc359d88e
  1. docker/
  2. docs/
  3. helm/
  4. kubernetes/
  5. tools/
  6. .gitignore
  7. .travis.yml
  8. CONTRIBUTING.md
  9. LICENSE.txt
  10. README.md
README.md

OpenWhisk Deployment for Kubernetes

License Build Status

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

Table of Contents

Requirements

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

Kubernetes

  • Kubernetes version 1.6+. However, multiple minor releases of Kubernetes, including 1.6.3, 1.7.14, 1.8.9 and 1.9.4 will not work for OpenWhisk due to bugs with volume mount subpaths (see[1, 2]. This bug will surface as a failure when deploying the nginx container.
  • The ability to create Ingresses to make a Kubernetes service available outside of the cluster so you can actually use OpenWhisk.
  • Endpoints of Kubernetes services must be able to loopback to themselves (the kubelet's hairpin-mode must not be none).

Setting up Kubernetes

Using Minikube

For local development and testing, we recommend using Minikube with the docker network in promiscuous mode. Not all combinations of Minikube and Kubernetes versions will work for running OpenWhisk. Although other combinations may work, we recommend at least initially using a combination from the table below that is verified by our Travis CI testing.

Kubernetes VersionMinikube Version
1.7.40.23.0
1.8.00.25.2
1.9.00.25.2

For details on setting up Minikube, see these instructions.

Using a Kubernetes cluster from a cloud provider

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

Configuring OpenWhisk

The first time you deploy OpenWhisk on Kubernetes, we recommend following the steps below manually so you can inspect the results and debug your setup. After you are confident that OpenWhisk deploys smoothly on your cluster, you might find it useful to drive your deployments using the script build.sh that we use to deploy OpenWhisk on Kubernetes for our Travis CI testing.

Initial Cluster Configuration

Configure or Deploy CouchDB

Do one of the following:

  • For development and testing purposes, this repo includes a configuration for deploying a non-replicated CouchDB instance within the Kubernetes cluster.
  • For a production level CouchDB instance, take a look at the main OpenWhisk documentation for configuring CouchDB. You will need to define the db.auth secret and db.config configmap as described in the CouchDB README.md to match your database deployment and create a CouchDB service instance that forwards connections to your external database.

Deploy Remaining Components

To deploy OpenWhisk on Kubernetes, you must deploy its components in an order that respects their dependencies. Detailed instructions and the supporting configuration files can be found in the kubernetes directory tree. Follow the instructions for each step in order.

Install system actions and the openwhisk catalog

Verify

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.

Note: if you installed self-signed certificates when you configured Nginx, you will need to use wsk -i to suppress certificate checking. This works around cannot validate certificate errors from the wsk CLI.

Cleanup

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. This is easily accomplished by deleting the openwhisk namespace and all persistent volumes labeled with pv-owner=openwhisk:

kubectl delete namespace openwhisk
kubectl delete persistentvolume -lpv-owner=openwhisk

Issues

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.