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.

OpenFunction VersionKubernetes 1.17Kubernetes 1.18Kubernetes 1.19Kubernetes 1.20+
v0.6.0
v0.5.0
v0.4.0
HEAD

Install OpenFunction

Option 1: Helm

This option is the recommended installation method for Kubernetes version: >=v1.20.0-0

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

    helm repo add openfunction https://openfunction.github.io/charts/
    helm repo update
    
  2. Run the following command to install the OpenFunction chart.

    kubectl create namespace openfunction
    helm install openfunction openfunction/openfunction -n openfunction
    
  3. Run the following command to verify OpenFunction is ready.

    kubectl get pods -namespace openfunction
    

Option 2: 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
    

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