Skip to main content
Version: 0.2.0

Installation

This document describes how to install Function Mesh based on your application in Kubernetes.

Install Function Mesh

This section describes how to install Function Mesh through the install.sh script or through the Helm.

Prerequisites

Before installing Function Mesh, ensure to perform the following operations.

Install Function Mesh through install.sh script

This example shows how to use the install.sh command to install Function Mesh on your laptop (Linux or Mac OS), including a local kind cluster, all the Custom Resource Definitions (CRDs), required service account configuration, and Function Mesh components.

curl -sSL https://github.com/streamnative/function-mesh/releases/download/v0.2.0/install.sh | bash

After executing the above command, you should be able to see the output indicating that the Function Mesh pod is up and running. For details, see verify installation.

Note

The install.sh command is suitable for trying Function Mesh out. If you want to deploy Function Mesh in production or other mission-critical scenarios, it is recommended to install Function Mesh through Helm.

Install Function Mesh through Helm

This example shows how to install Function Mesh through Helm.

Note

  • Before installation, ensure that Helm v3 is installed properly.
  • For the use of kubectl commands, see kubectl command reference.
  1. Add the StreamNative Function Mesh repository.

    helm repo add function-mesh http://charts.functionmesh.io/
    helm repo update
  2. Install the Function Mesh Operator.

    Let's set some variables for convenient use later.

    export FUNCTION_MESH_RELEASE_NAME=function-mesh  # change the release name according to your scenario
    export FUNCTION_MESH_RELEASE_NAMESPACE=function-mesh # change the namespace to where you want to install Function Mesh

    Install the Function Mesh Operator via following command.

    Note

    • If no Kubernetes namespace is specified, the default namespace is used.

    • If the namespace ${FUNCTION_MESH_RELEASE_NAMESPACE} doesn't exist yet, you can add the parameter --create-namespace to create it automatically.

    helm install ${FUNCTION_MESH_RELEASE_NAME} function-mesh/function-mesh-operator -n ${FUNCTION_MESH_RELEASE_NAMESPACE}

    This table outlines the configurable parameters of the Function Mesh Operator and their default values.

    ParametersDescriptionDefault
    enable-leader-electionWhether the Function Mesh Controller Manager should enable leader election.true
    enable-pprofWhether the Function Mesh Controller Manager should enable pprof.false
    pprof-addrThe address of the pprof.:8090
    metrics-addrThe address of the metrics.:8080
    health-probe-addrThe address of the health probe.:8000
    config-fileThe configuration file of the Function Mesh Controller Manager, which includes runnerImages, resourceLabels, and resourceAnnotations configurations.
    - runnerImage: the runner image to run the Pulsar Function instances. Currently, it supports Java, Python, and Go runner images.
    - resourceLabels: set labels for Pulsar Functions, Sources, or Sinks.
    - resourceAnnotations: set annotations for Pulsar Functions, Sources, or Sinks.
    /etc/config/configs.yaml

    For example, if you want to enable pprof for the Function Mesh Operator, set the controllerManager.pprof.enable to true.

    helm install ${FUNCTION_MESH_RELEASE_NAME} function-mesh/function-mesh-operator -n ${FUNCTION_MESH_RELEASE_NAMESPACE} \
    --set controllerManager.pprof.enable=true
  3. Check whether Function Mesh is installed successfully.

    kubectl get pods --namespace ${FUNCTION_MESH_RELEASE_NAMESPACE} -l app.kubernetes.io/instance=function-mesh

    Output

    NAME                                               READY   STATUS    RESTARTS   AGE
    function-mesh-controller-manager-5f867557c-d6vf4 1/1 Running 0 8s

Verify installation

  • This example shows how to verify whether Function Mesh is installed successfully.

    Note

    ${NAMESPACE} indicates the namespace where Function Mesh Operator is installed.

    kubectl get pods --namespace ${NAMEPSACE} -l app.kubernetes.io/instance=function-mesh

    Output

    NAME                                               READY   STATUS    RESTARTS   AGE
    function-mesh-controller-manager-5f867557c-d6vf4 1/1 Running 0 8s
  • This example shows how to verify whether Function Mesh can run properly.

    After installing the Function Mesh Operator and deploying a Pulsar cluster, you can submit a sample CRD to create Pulsar Functions, source, sink, or Function Mesh. In this example, a CRD is submitted to the Pulsar cluster for creating a Pulsar Function. You can also submit other CRDs under the ./config/samples directory.

    1. Submit a sample CRD to the Pulsar cluster.

      kubectl apply -f config/samples/compute_v1alpha1_function.yaml
    2. Verify your submission with the kubectl command, and you can see that the Function pod is running.

      kubectl get all
      NAME READY STATUS RESTARTS AGE
      pod/function-sample-0 1/1 Running 0 77s

Uninstall Function Mesh

Use the following command to uninstall Function Mesh through Helm.

Note

${NAMESPACE} indicates the namespace where Function Mesh Operator is installed.

helm delete function-mesh -n ${NAMESPACE}