Edit

Azure Functions on Kubernetes with KEDA

  • Article

The Azure Functions runtime provides flexibility in hosting where and how you want. KEDA (Kubernetes-based Event Driven Autoscaling) pairs seamlessly with the Azure Functions runtime and tooling to provide event driven scale in Kubernetes.

Important

Azure Functions on Kubernetes using KEDA is an open-source effort that you can use free of cost. Best-effort support is provided by contributors and from the community, so please use GitHub issues in the Azure Functions repository to report bugs and raise feature requests. Azure Functions deployment to Azure Container Apps, which runs on managed Kubernetes clusters in Azure, is currently in preview. For more information, see Azure Container Apps hosting of Azure Functions.

How Kubernetes-based functions work

The Azure Functions service is made up of two key components: a runtime and a scale controller. The Functions runtime runs and executes your code. The runtime includes logic on how to trigger, log, and manage function executions. The Azure Functions runtime can run anywhere. The other component is a scale controller. The scale controller monitors the rate of events that are targeting your function, and proactively scales the number of instances running your app. To learn more, see Azure Functions scale and hosting.

Kubernetes-based Functions provides the Functions runtime in a Docker container with event-driven scaling through KEDA. KEDA can scale in to 0 instances (when no events are occurring) and out to n instances. It does this by exposing custom metrics for the Kubernetes autoscaler (Horizontal Pod Autoscaler). Using Functions containers with KEDA makes it possible to replicate serverless function capabilities in any Kubernetes cluster. These functions can also be deployed using Azure Kubernetes Services (AKS) virtual nodes feature for serverless infrastructure.

Managing KEDA and functions in Kubernetes

To run Functions on your Kubernetes cluster, you must install the KEDA component. You can install this component in one of the following ways:

  • Azure Functions Core Tools: using the func kubernetes install command.

  • Helm: there are various ways to install KEDA in any Kubernetes cluster, including Helm. Deployment options are documented on the KEDA site.

Deploying a function app to Kubernetes

You can deploy any function app to a Kubernetes cluster running KEDA. Since your functions run in a Docker container, your project needs a Dockerfile. You can create a Dockerfile by using the --docker option when calling func init to create the project. If you forgot to do this, you can always call func init again from the root of your Functions project, this time using the --docker-only option, as shown in the following example.

func init --docker-only

To learn more about Dockerfile generation, see the func init reference.

To build an image and deploy your functions to Kubernetes, run the following command:

func kubernetes deploy --name <name-of-function-deployment> --registry <container-registry-username>

In this example, replace <name-of-function-deployment> with the name of your function app.

The deploy command does the following:

  1. The Dockerfile created earlier is used to build a local image for the function app.
  2. The local image is tagged and pushed to the container registry where the user is logged in.
  3. A manifest is created and applied to the cluster that defines a Kubernetes Deployment resource, a ScaledObject resource, and Secrets, which includes environment variables imported from your local.settings.json file.

To learn more, see the func kubernetes deploy command.

Deploying a function app from a private registry

The above flow works for private registries as well. If you are pulling your container image from a private registry, include the --pull-secret flag that references the Kubernetes secret holding the private registry credentials when running func kubernetes deploy.

Removing a function app from Kubernetes

After deploying you can remove a function by removing the associated Deployment, ScaledObject, an Secrets created.

kubectl delete deploy <name-of-function-deployment>
kubectl delete ScaledObject <name-of-function-deployment>
kubectl delete secret <name-of-function-deployment>

Uninstalling KEDA from Kubernetes

You can remove KEDA from your cluster in one of the following ways:

Supported triggers in KEDA

KEDA has support for the following Azure Function triggers:

HTTP Trigger support

You can use Azure Functions that expose HTTP triggers, but KEDA doesn't directly manage them. You can leverage the KEDA prometheus trigger to scale HTTP Azure Functions from 1 to n instances.

Next Steps

For more information, see the following resources: