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.

Note

OpenFunction has added the Domain feature since v0.5.0. To use this feature, you have to install OpenFunction in Kubernetes 1.19 or later. For more information about OpenFunction components compatibility with Kubernetes, refer to Component Compatibility Matrix.

Install OpenFunction

Option 1: Helm

This option is the recommended installation method.

Requirements

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

install the chart

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

   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 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

   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

Note

For more information about how to uninstall OpenFunction with Helm, see Uninstall OpenFunction with Helm.

CLI

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

ofn uninstall --all

Note

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

Last modified June 28, 2022: add helm installation requirements to installation.md (37ff7cf)