cloud-functions-operator

README

Apache OpenWhisk Operators

This project provides a collection of Kubernetes operators for managing Apache OpenWhisk resources namely actions, packages, rules and triggers.

• Apache OpenWhisk Operators
• Quick start
  • Prerequisites
  • Installing the operators
  • Using the operators
    • Setting up OpenWhisk credentials
    • Deploying your first function
• Learn more

Quick start

Prerequisites

• A cluster running Kubernetes 1.11+
• kubectl installed and configured.
• kustomize installed.

Installing the operators

1. Install the CRDs using kubectl:

$ kustomize build github.com/IBM/openwhisk-operator//config/crds | kubectl apply -f -

1. Then install the operators:

$ kustomize build github.com/IBM/openwhisk-operator//config/default | kubectl apply -f -

By default the operators are installed in the openwhisk-system namespace and are granted clustor-wide permissions.

Using the operators

Setting up OpenWhisk credentials

By default, all operators look for OpenWhisk credentials in the seed-default-owprops secret:

# Extract properties from .wskprops
AUTH=$(cat ~/.wskprops | grep 'AUTH' | awk -F= '{print $2}')
APIHOST=$(cat ~/.wskprops | grep 'APIHOST' | awk -F= '{print $2}')

# And create secret
kubectl create secret generic seed-defaults-owprops \
    --from-literal=apihost=$APIHOST \
    --from-literal=auth=$AUTH

Alternativalely, you can directly create a k8s secret

apiVersion: v1
kind: Secret
metadata: 
  name: seed-default-owprops
stringData:
  apihost: localhost
  auth: "23bc46b1-71f6-4ed5-8c54-816aa4f8c502:123zO3xZCLrMN6v2BKK1dXYFpXlPkccOFqm12CdAsMgRU4VrNZ9lyGVCGuMDGIwP"
  insecure: "true"

NOTE: be aware that all operators update OpenWhisk entities and can potentially override existing entitites.

Deploying your first function

The Function resource kind allows the deployement of actions:

apiVersion: openwhisk.seed.ibm.com/v1beta1
kind: Function
metadata:
  name: greetings
spec:
  codeURI: https://raw.githubusercontent.com/apache/incubator-openwhisk-catalog/master/packages/utils/echo.js
  runtime: nodejs:6
  parameters:
  - name: message
    value: Bonjour

Deploy it:

$ kubectl apply -f sample.yaml

wait a little bit and run:

$ wsk action invoke greetings -br

Learn more

• reference documentation
• contributions