Getting started
Overview
OpenFunction is a cloud-native, open source FaaS (function as a service) framework designed to let developers focus on their development intentions without worrying about the underlying runtime environment and infrastructure. Users can generate event-driven, dynamically scaling Serverless workloads by simply submitting a piece of code.
OpenFunction Features:
- Cloud-native, open source
- Automatically build code into OCI-compliant images
- Automatically deploys application with dynamic scaling capabilities
- Provides events framework to make functions event-driven
- Provides function version control and ingress traffic management capabilities
OpenFunction has two main capabilities:
- Serverless framework with CustomResourceDefinitions (CRD) Function, Builder, Serving
- Events framework with CustomResourceDefinitions (CRD) EventSource, EventBus (ClusterEventBus), Trigger
Prerequisites
The current version of OpenFunction requires that you have a Kubernetes cluster with version >=1.18.6.
You can install the dependencies of OpenFunction Builder and Serving by executing the following command:
sh hack/deploy.sh --all
You can also customize the installation with the following parameters:
| Parameter | Comment |
|---|---|
| –all | Install all supported Builder and Serving |
| –with-shipwright | Install Shipwright builder (Builder dependency) |
| –with-knative | Install Knative serving runtime (Serving dependency) |
| –with-openFuncAsync | Install OpenFuncAsync serving runtime (Serving dependency, include KEDA and Dapr) |
| –poor-network | Use this if you have poor network connectivity to GitHub/Googleapis |
| –tekton-dashboard-nodeport |
Expose the Tekton dashboard service with NodePort |
Install
You can install the OpenFunction platform by the following command:
- Install the latest stable version
kubectl apply -f https://github.com/OpenFunction/OpenFunction/releases/download/v0.3.1/bundle.yaml
- Install the development version
kubectl apply -f https://raw.githubusercontent.com/OpenFunction/OpenFunction/main/config/bundle.yaml
Note: When using non-default namespaces, make sure that the ClusterRoleBinding in the namespace is adapted.
Sample: Run a function.
If you have already installed the OpenFunction platform, refer to OpenFunction samples to run a sample function.
Uninstall
- Uninstall the latest stable version
kubectl delete -f https://raw.githubusercontent.com/OpenFunction/OpenFunction/release-0.3/config/bundle.yaml
- Uninstall the development version
kubectl delete -f https://raw.githubusercontent.com/OpenFunction/OpenFunction/main/config/bundle.yaml
Feedback
Was this page helpful?
Glad to hear it! Please tell us how we can improve.
Sorry to hear that. Please tell us how we can improve.