Quickstart

The following quickstart guide will walk you through installing KEDA + Kedify in a k3d Kubernetes cluster and deploying a sample application to demonstrate how Kedify scales an application using HTTP requests.

Different Kubernetes distro?

You can run this quickstart on a Kubernetes distribution of your choice, and Kedify will work correctly. However, you might need to modify the Ingress configuration mentioned later in the quickstart to access the application.

Prerequisites

1. kubectl command line utility installed and accessible
2. curl command line utility installed and accessible
3. k3d installed on the machine via

   brew install k3d

   or

   curl -s https://raw.githubusercontent.com/rancher/k3d/main/install.sh | bash

   or using an installation method of your choice.

Create a new k3d cluster

Create a k3d cluster with port forwarding to the cluster's load balancer.

k3d cluster create --port "9080:80@loadbalancer"

KEDA + Kedify Installation

Let's install KEDA + Kedify on your cluster! The following three steps will walk you through the basics. Installing the Kedify Agent will automatically install KEDA.

Step 1: Install via Terminal Command

Generate a terminal command to install KEDA + Kedify in a single step

Generate Command

After running the command, you should see the Kedify Agent and KEDA installed in your cluster.

kubectl get deployment -n keda -w

The Kedify Agent will be installed as the first step, then it will configure KEDA with HTTP Add-On in the same namespace and in a minute (once all images are pulled, based on your connection speed), the output should be similar to this:

NAME                                   READY   UP-TO-DATE   AVAILABLE   AGE
kedify-agent                           1/1     1            1           1m
keda-add-ons-http-interceptor          1/1     1            1           1m
keda-add-ons-http-controller-manager   1/1     1            1           1m
keda-add-ons-http-external-scaler      1/1     1            1           1m
keda-operator                          1/1     1            1           1m
keda-operator-metrics-apiserver        1/1     1            1           1m
keda-admission-webhooks                1/1     1            1           1m

Step 2: Autoscale Application

Run the following commands to deploy a sample application that responds to HTTP requests.

kubectl apply -f 'https://dashboard.kedify.io/public/files/sample_http_deployment.yaml'

Note

The application is configured with an Ingress and a Service suitable for k3d configured above. If you are using a different Kubernetes distribution, you may need to modify the Ingress configuration.

Confirm the application is deployed correctly.

kubectl get deployment -n default -w

You should see the following output:

NAME                   READY   UP-TO-DATE   AVAILABLE   AGE
http-demo-deployment   1/1     1            1           26s

Test the application is working correctly

We are making an HTTP request to the application to confirm it is working correctly. The request is made to the `k3d` load balancer, which is listening on port 9080, we are using the host header to route the request to the correct service.

curl -I -H 'host: demo.keda' http://localhost:9080

You should see the following output:

HTTP/1.1 200 OK
Content-Length: 320
Content-Type: text/html
Date: Tue, 23 Jul 2024 22:27:59 GMT

Add ScaledObject

Run the following command to deploy a `ScaledObject` that will scale the application based on the number of HTTP requests.

kubectl apply -f 'https://dashboard.kedify.io/public/files/sample_http_scaledobject.yaml'

Note

This `ScaledObject` is using Kedify HTTP Trigger. Kedify Build of KEDA is needed to run this properly.

Confirm the app is scaled to zero

Confirm the application has been scaled to zero and that Kedify Proxy is running correctly. The `ScaledObject` defined above tells KEDA to scale down to 0 when there is no HTTP traffic flowing to the application.

kubectl get deployment -n default -w

You should see the following output, app scaled to zero and Kedify Proxy up and running:

NAME                   READY   UP-TO-DATE   AVAILABLE   AGE
http-demo-deployment   0/0     0            0           12m
kedify-proxy           1/1     1            1           35s

What is the Kedify Proxy?

The Kedify Proxy serves as a shared HTTP reverse proxy for all applications in a particular namespace. It is deployed by Kedify Agent only in namespaces that require it for scaling. All `ScaledObjects` that use the HTTP scaler have their traffic routed through an instance of Kedify Proxy and KEDA can scale the applications based on the metrics from the proxy.

Step 3: Monitor Autoscaling

Perform another HTTP request to test that the application is correctly scaled out and responds correctly.

curl -I -H 'host: demo.keda' http://localhost:9080

You should see the following output:

HTTP/1.1 200 OK
Content-Length: 320
Content-Type: text/html
Date: Tue, 23 Jul 2024 22:39:29 GMT
Server: envoy
X-Envoy-Upstream-Service-Time: 4103
X-Keda-Http-Cold-Start: true

Confirm the application has been scaled out to handle the traffic.

kubectl get deployment -n default

You should see the following output:

NAME                   READY   UP-TO-DATE   AVAILABLE   AGE
kedify-proxy           1/1     1            1           3m9s
http-demo-deployment   1/1     1            1           14m

By sending more requests you can see that the application is scaled out to a higher number of replicas.

Try the Kedify Dashboard

You can also use the Kedify Dashboard to monitor resources, metrics, and more. Use the email you entered above to log in.

Next Steps

• Review the Kedify Key Concepts
• Check out the Example AI Cluster Dashboard