Installation

This document describes how to install OpenFunction.

Prerequisites

• You need to have a Kubernetes cluster.

• You need to ensure your Kubernetes version meets the requirements described in the following compatibility matrix.

Install OpenFunction

Option 1: Install with helm chart (recommended)

Requirements

• Kubernetes version: >=v1.20.0-0
• Helm version: >=v3.6.3

Steps to install OpenFunction helm charts

1. Run the following command to add the OpenFunction chart repository first:

   helm repo add openfunction https://openfunction.github.io/charts/
   helm repo update
   

2. Then you have several options to setup OpenFunction, you can choose to:

   • Install all components:

     kubectl create namespace openfunction
     helm install openfunction openfunction/openfunction -n openfunction --version 0.1.0
     

   • Install Serving only (without build):

     kubectl create namespace openfunction
     helm install openfunction --set ShipwrightBuild.enabled=false --set TektonPipelines.enabled=false openfunction/openfunction -n openfunction --version 0.1.0
     

   • Install Knative sync runtime only:

     kubectl create namespace openfunction
     helm install openfunction --set Keda.enabled=false openfunction/openfunction -n openfunction --version 0.1.0
     

   • Install OpenFunction async runtime only:

     kubectl create namespace openfunction
     helm install openfunction --set IngressNginx.enabled=false  --set KnativeServing.enabled=false openfunction/openfunction -n openfunction --version 0.1.0
     

   Note

   For more information about how to install OpenFunction with Helm, see Install OpenFunction with Helm.

3. Run the following command to verify OpenFunction is up and running:

   kubectl get po -n openfunction
   

Option 2: Install with CLI

1. Run the following command to download ofn, the CLI of OpenFunction.

   wget -c  https://github.com/OpenFunction/cli/releases/latest/download/ofn_linux_amd64.tar.gz -O - | tar -xz
   

2. Run the following commands to make ofn executable and move it to /usr/local/bin/.

   chmod +x ofn && mv ofn /usr/local/bin/
   

3. Run the following command to install OpenFunction.

   ofn install --all
   

   Note

   For more information about how to use the ofn install command, see ofn install Parameters.

Uninstall OpenFunction

Helm

If you installed OpenFunction with Helm, run the following command to uninstall OpenFunction and its dependencies.

helm uninstall openfunction -n openfunction

CLI

If you installed OpenFunction with CLI, run the following command to uninstall OpenFunction and its dependencies.

ofn uninstall --all