jieding / http-add-on Goto Github PK

Kubernetes-based Event Driven Autoscaling - HTTP Add-On

The KEDA HTTP Add On allows Kubernetes users to automatically scale their HTTP servers up and down (including to/from zero) based on incoming HTTP traffic. Please see our use cases document to learn more about how and why you would use this project.

KEDA provides a reliable and well tested solution to scaling your workloads based on external events. The project supports a wide variety of scalers - sources of these events, in other words. These scalers are systems that produce precisely measurable events via an API.

KEDA does not, however, include an HTTP-based scaler out of the box for several reasons:

• The concept of an HTTP "event" is not well defined.
• There's no out-of-the-box single system that can provide an API to measure the current number of incoming HTTP events or requests.
• The infrastructure required to achieve these measurements is more complex and, in some cases, needs to be integrated into the HTTP routing system in the cluster (e.g. the ingress controller).

For these reasons, the KEDA core project has purposely not built generic HTTP-based scaling into the core.

This project, often called KEDA-HTTP, exists to provide that scaling. It is composed of simple, isolated components and includes an opinionated way to put them together.

Although this is currently a beta release project, we have prepared a walkthrough document that with instructions on getting started for basic usage.

See that document at docs/walkthrough.md

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.
• For more context on the design, please see our scope document.
• If you have further questions about the project, please see our FAQ document.

Please see the complete installation instructions.

This project follows the KEDA contributing guidelines, which are outlined in CONTRIBUTING.md.

If you would like to contribute code to this project, please see docs/developing.md.

We are a Cloud Native Computing Foundation (CNCF) incubation project.

Please refer to the organization-wide Code of Conduct document.