README
¶
Kubernetes-based Event Driven Autoscaling - HTTP Add-On
KEDA allows for fine-grained autoscaling (including to/from zero) for event driven Kubernetes workloads. With this add-on, you can easily autoscale your HTTP workloads.
| 🚧 Alpha - Not for production 🚧 |
|---|
| ⚠ The HTTP add-on is in experimental stage and not ready for production. It is provided as-is without support. |
This codebase moves very quickly. We can't currently guarantee that any part of it will work. Neither the complete feature set nor known issues may be fully documented. Similarly, issues filed against this project may not be responded to quickly or at all. We will release and announce a beta release of this project, and after we do that, we will document and respond to issues properly.
Walkthrough
Although this is an alpha release project right now, we have prepared a walkthrough document that with instructions on getting started for basic usage.
See that document at docs/walkthrough.md
Design
The HTTP add-on is composed of multiple mostly independent components. This design was chosen to allow for highly customizable installations while allowing us to ship reasonable defaults.
We have written a complete design document. Please see it at docs/design.md.
Installation
Please see the complete installation instructions.
We are a Cloud Native Computing Foundation (CNCF) sandbox project.
Directories
¶
| Path | Synopsis |
|---|---|
|
api/v1alpha1
Package v1alpha1 contains API Schema definitions for the http v1alpha1 API group +kubebuilder:object:generate=true +groupName=http.keda.sh
|
Package v1alpha1 contains API Schema definitions for the http v1alpha1 API group +kubebuilder:object:generate=true +groupName=http.keda.sh |
|
pkg
|
|
|
Handlers contains the gRPC implementation for an external scaler as defined by the KEDA documentation at https://keda.sh/docs/2.0/concepts/external-scalers/#built-in-scalers-interface This is the interface KEDA will poll in order to get the request queue size and scale user apps properly The HTTP Scaler is the standard implementation for a KEDA external scaler which can be found at https://keda.sh/docs/2.0/concepts/external-scalers/ This scaler has the implementation of an HTTP request counter and informs KEDA of the current request number for the queue in order to scale the app This file contains the implementation for the HTTP request queue used by the KEDA external scaler implementation
|
Handlers contains the gRPC implementation for an external scaler as defined by the KEDA documentation at https://keda.sh/docs/2.0/concepts/external-scalers/#built-in-scalers-interface This is the interface KEDA will poll in order to get the request queue size and scale user apps properly The HTTP Scaler is the standard implementation for a KEDA external scaler which can be found at https://keda.sh/docs/2.0/concepts/external-scalers/ This scaler has the implementation of an HTTP request counter and informs KEDA of the current request number for the queue in order to scale the app This file contains the implementation for the HTTP request queue used by the KEDA external scaler implementation |