KEDA

Install the HTTP Add-on

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Before installing the HTTP Add-on, ensure you have:

A Kubernetes cluster (tested against the three most recent minor versions)
Helm 3
KEDA core installed (deployment guide)

If you have not installed KEDA yet, run:

helm repo add kedacore https://kedacore.github.io/charts
helm repo update
helm install keda kedacore/keda --namespace keda --create-namespace

Install

Add the KEDA Helm repository (if you have not already):

helm repo add kedacore https://kedacore.github.io/charts
helm repo update

Install the HTTP Add-on into the same namespace as KEDA:

Install the HTTP Add-on

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Before installing the HTTP Add-on, ensure you have:

A Kubernetes cluster (tested against the three most recent minor versions)
- Supported architectures: amd64, arm64, or s390x (CI-tested on amd64 and arm64)
Helm 3
KEDA core installed (deployment guide)

If you have not installed KEDA yet, run:

helm repo add kedacore https://kedacore.github.io/charts
helm repo update
helm install keda kedacore/keda --namespace keda --create-namespace

Install

Add the KEDA Helm repository (if you have not already):

Install the HTTP Add-on

Mon, 01 Jan 0001 00:00:00 +0000

Prerequisites

Before installing the HTTP Add-on, ensure you have:

A Kubernetes cluster (tested against the three most recent minor versions)
- Supported architectures: amd64, arm64, or s390x (CI-tested on amd64 and arm64)
Helm 3
KEDA core installed (deployment guide)

If you have not installed KEDA yet, run:

helm repo add kedacore https://kedacore.github.io/charts
helm repo update
helm install keda kedacore/keda --namespace keda --create-namespace

Install

Add the KEDA Helm repository (if you have not already):

Kubernetes Control plane is unable to communicate to Metric server?

Mon, 01 Jan 0001 00:00:00 +0000

If while setting up KEDA, you get an error: (v1beta1.external.metrics.k8s.io) status FailedDiscoveryCheck with a message: failing or missing response from https://POD-IP:6443/apis/external.metrics.k8s.io/v1beta1: Get "https://POD-IP:6443/apis/external.metrics.k8s.io/v1beta1": Address is not allowed.

One of the reason for this can be due to CNI like Cilium or any other.

Before you start

Make sure no network policies are blocking traffic and required CIDR’s are added

Check the status:

Find the api service name for the service keda/keda-metrics-apiserver:

Why is Kubernetes unable to get metrics from KEDA?

Mon, 01 Jan 0001 00:00:00 +0000

If while setting up KEDA, you get an error: (v1beta1.external.metrics.k8s.io) status FailedDiscoveryCheck with a message: no response from https://ip:443: Get https://ip:443: net/http: request canceled while waiting for connection (Client.Timeout exceeded while awaiting headers).

One of the reason for this can be that you are behind a proxy network.

Before you start

Make sure no network policies are blocking traffic

Check the status

Find the api service name for the service keda/keda-metrics-apiserver:

Why is my `ScaledObject` paused?

Mon, 01 Jan 0001 00:00:00 +0000

When KEDA has upstream errors to get scaler source information it will keep the current instance count of the workload unless the fallback section is defined.

This behavior might feel like the autoscaling is not happening, but in reality, it is because of problems related to the scaler source.

You can check if this is your case by reviewing the logs from the KEDA pods where you should see errors in both our Operator and Metrics server. You can also check a status of the ScaledObject (READY and ACTIVE condition) by running following command:

Context Deadline Exceeded when `kubectl apply`?

Mon, 01 Jan 0001 00:00:00 +0000

If you’re encountering the following error when trying to apply a ScaledObject using the kubectl apply command:

kubectl apply -f nginx-scaledobject.yaml

And receive an error like:

Error from server (Timeout): error when applying patch: {"metadata":{"annotations":{"kubectl.kubernetes.io/last-applied-configuration":"{\"apiVersion\":\"keda.sh/v1alpha1\",\"kind\":\"ScaledObject\",\"metadata\":{\"annotations\":{},\"name\":\"nginx-scaledobject\",\"namespace\":\"default\"},\"spec\":{\"cooldownPeriod\":300,\"maxReplicaCount\":2,\"minReplicaCount\":1,\"pollingInterval\":3,\"scaleTargetRef\":{\"name\":\"nginx-deploy\"},\"triggers\":[{\"metadata\":{\"type\":\"Utilization\",\"value\":\"90\"},\"type\":\"cpu\"}]}}\n"}},"spec":{"maxReplicaCount":2}} to: Resource: "keda.sh/v1alpha1, Resource=scaledobjects", GroupVersionKind: "keda.sh/v1alpha1, Kind=ScaledObject" Name: "nginx-scaledobject", Namespace: "default" for: "nginx-scaledobject.yaml": error when patching "nginx-scaledobject.yaml": Timeout: request did not complete within requested timeout - context deadline exceeded.

Root cause

This issue commonly occurs when the KEDA admission webhook is not reachable by the Kubernetes control plane due to a network connectivity issue, typically on port 9443, which the webhook listens on.

Admission Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Validation Enforcement

By default, the admission webhooks are registered with failurePolicy: Ignore, this won’t block the resources creation/update when the admission controller is not available. To ensure that the validation is always required and perform validation, setting failurePolicy to Fail is required.

Admission Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Validation Enforcement

Admission Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Validation Enforcement

Admission Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Validation Enforcement

Admission Webhooks

Mon, 01 Jan 0001 00:00:00 +0000

Validation Enforcement

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 Event will be emitted to both Kubernetes Events and CloudEvents Destination if CloudEventSource resource is created.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 Event will be emitted to both Kubernetes Events and CloudEvents Destination if CloudEventSource resource is created.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 Event will be emitted to both Kubernetes Events and CloudEvents Destination if CloudEventSource resource is created.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 Event will be emitted to both Kubernetes Events and CloudEvents Destination if CloudEventSource resource is created.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 Event will be emitted to both Kubernetes Events and CloudEvents Destination if CloudEventSource resource is created.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 When a CloudEventSource resource is created, KEDA continues to emit Kubernetes Events and will additionally emit CloudEvents for the supported event types listed in this document.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 When a CloudEventSource resource is created, KEDA continues to emit Kubernetes Events and will additionally emit CloudEvents for the supported event types listed in this document.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

CloudEvent Support

Mon, 01 Jan 0001 00:00:00 +0000

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

📝 When a CloudEventSource resource is created, KEDA continues to emit Kubernetes Events and will additionally emit CloudEvents for the supported event types listed in this document.

Here is a the schema of the CloudEventSource CRD:

apiVersion: eventing.keda.sh/v1alpha1
kind: CloudEventSource
metadata:
 name: {cloud-event-name}
spec:
 clusterName: {cluster-name} #Optional. Will be used in the source/subject to specify where the event comes from. The default value is 'kubernetes-default' and it can also be set during the installation of KEDA with --k8sClusterName. This one will overwrite others if set.
 authenticationRef: 
 name: {trigger-authentication-name} #Optional. Used to reference a `TriggerAuthentication` for authentication. 
 kind: TriggerAuthentication # Optional. Used to choose the authentication scopes. https://keda.sh/docs/latest/concepts/authentication/#authentication-scopes-namespace-vs-cluster
 destination:
 http:
 uri: http://foo.bar
 azureEventGridTopic:
 endpoint: https://my-topic.eastus-1.eventgrid.azure.net/api/events

 eventSubscription: #Optional. Submit included/excluded event types will filter events when emitting events. 
 includedEventTypes: #Optional. Only events in this section will be emitted.
 - keda.scaledobject.failed.v1
 excludedEventTypes: #Optional. Events in this section will not be emitted. 
 - keda.scaledobject.ready.v1

In general, an event emitted by KEDA would fundamentally come down to the following structure:

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.0 has been tested on Kubernetes v1.16.0 or above.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.1 has been tested on Kubernetes v1.16.0 or above.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.4 has been tested on Kubernetes v1.16.0 or above.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.5 has been tested on Kubernetes v1.17.0 or above.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.6 has been tested on Kubernetes v1.17.0 through v1.25.0.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.7 has been tested on Kubernetes v1.17.0 through v1.25.0.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes

KEDA is community-supported. For all support options, see the Support page.

KEDA v2.8 has been tested on Kubernetes v1.17.0 through v1.25.0.

Cluster Capacity

The KEDA runtime require the following resources in a production-ready setup:

Deployment	CPU	Memory
Metrics Server	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi
Operator	Limit: 1, Request: 100m	Limit: 1000Mi, Request: 100Mi

These are used by default when deploying through YAML.

💡 For more info on CPU and Memory resource units and their meaning, see this link.

Cluster

Mon, 01 Jan 0001 00:00:00 +0000

Requirements

Kubernetes Compatibility

KEDA is community-supported. For all support options, see the Support page.

The tested window of Kubernetes versions with KEDA follows an “N-2” approach, which means each KEDA release is generally tested against N-2 Kubernetes minor versions at minimum.

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

CloudEvent Support (Experimental)

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

CloudEvent Support (Experimental)

Subscribing to events with `CloudEventSource`

CloudEventSource resource can be used in KEDA for subscribing to events that are emitted to the user’s defined CloudEvent sink.

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events

Mon, 01 Jan 0001 00:00:00 +0000

Kubernetes Events emitted by KEDA

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (just an external metric):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query an specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (just an external metric):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (just an external metric):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (just an external metric):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA (external metrics only):

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "externalmetrics",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 }
 ]
}

In order to query a specific metric value, you also can do it using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

KEDA Metrics Server

Mon, 01 Jan 0001 00:00:00 +0000

Querying metrics exposed by KEDA Metrics Server

The metrics exposed by KEDA Metrics Server can be queried directly using kubectl:

kubectl get --raw "/apis/external.metrics.k8s.io/v1beta1"

This will return a json with the list of metrics exposed by KEDA:

{
 "kind": "APIResourceList",
 "apiVersion": "v1",
 "groupVersion": "external.metrics.k8s.io/v1beta1",
 "resources": [
 {
 "name": "s0-rabbitmq-queueName",
 "singularName": "",
 "namespaced": true,
 "kind": "ExternalMetricValueList",
 "verbs": [
 "get"
 ]
 },
 {
 "name": "s1-rabbitmq-queueName2",
 ....
 }
 ]
}

You can also query for the value of a specific metric using kubectl:

Schema

Mon, 01 Jan 0001 00:00:00 +0000

Scaler Schema

KEDA provides a separate scaler’s schema for third-party usage (scalers-metadata-schema.yaml/scalers-metadata-schema.json). The schema file will keep updating according to the scaler’s refactor.

*Notice: The schema file still lacks some of the scalers. It will be completed once all scalers are refactored to use the new declarative scaler config.

Specification

Here is a the schema of the scalers:

kedaVersion: main 
schemaVersion: 1
scalers:
 - type: activemq
 parameters:
 - name: managementEndpoint
 type: string
 optional: true
 metadataVariableReadable: true
 - name: destinationName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: brokerName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: username
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: password
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: corsHeader
 type: string
 optional: true
 metadataVariableReadable: true
 - name: restAPITemplate
 type: string
 optional: true
 metadataVariableReadable: true
 - name: targetQueueSize
 type: string
 default: "10"
 metadataVariableReadable: true
 - name: activationTargetQueueSize
 type: string
 default: "0"
 metadataVariableReadable: true
 - type: apache-kafka
 parameters:
 - name: bootstrapServers
 ...

Metadata field’s property detail:

Schema

Mon, 01 Jan 0001 00:00:00 +0000

Scaler Schema

KEDA provides a separate scaler’s schema for third-party usage (scalers-metadata-schema.yaml/scalers-metadata-schema.json). The schema file will keep updating according to the scaler’s refactor.

*Notice: The schema file still lacks some of the scalers. It will be completed once all scalers are refactored to use the new declarative scaler config.

Specification

Here is a the schema of the scalers:

kedaVersion: main 
schemaVersion: 1
scalers:
 - type: activemq
 parameters:
 - name: managementEndpoint
 type: string
 optional: true
 metadataVariableReadable: true
 - name: destinationName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: brokerName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: username
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: password
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: corsHeader
 type: string
 optional: true
 metadataVariableReadable: true
 - name: restAPITemplate
 type: string
 optional: true
 metadataVariableReadable: true
 - name: targetQueueSize
 type: string
 default: "10"
 metadataVariableReadable: true
 - name: activationTargetQueueSize
 type: string
 default: "0"
 metadataVariableReadable: true
 - type: apache-kafka
 parameters:
 - name: bootstrapServers
 ...

Metadata field’s property detail:

Schema

Mon, 01 Jan 0001 00:00:00 +0000

Scaler Schema

KEDA provides a separate scaler’s schema for third-party usage (scalers-metadata-schema.yaml/scalers-metadata-schema.json). The schema file will keep updating according to the scaler’s refactor.

*Notice: The schema file still lacks some of the scalers. It will be completed once all scalers are refactored to use the new declarative scaler config.

Specification

Here is a the schema of the scalers:

kedaVersion: main 
schemaVersion: 1
scalers:
 - type: activemq
 parameters:
 - name: managementEndpoint
 type: string
 optional: true
 metadataVariableReadable: true
 - name: destinationName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: brokerName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: username
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: password
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: corsHeader
 type: string
 optional: true
 metadataVariableReadable: true
 - name: restAPITemplate
 type: string
 optional: true
 metadataVariableReadable: true
 - name: targetQueueSize
 type: string
 default: "10"
 metadataVariableReadable: true
 - name: activationTargetQueueSize
 type: string
 default: "0"
 metadataVariableReadable: true
 - type: apache-kafka
 parameters:
 - name: bootstrapServers
 ...

Metadata field’s property detail:

Schema

Mon, 01 Jan 0001 00:00:00 +0000

Scaler Schema

KEDA provides a separate scaler’s schema for third-party usage (scalers-metadata-schema.yaml/scalers-metadata-schema.json). The schema file will keep updating according to the scaler’s refactor.

*Notice: The schema file still lacks some of the scalers. It will be completed once all scalers are refactored to use the new declarative scaler config.

Specification

Here is a the schema of the scalers:

kedaVersion: main 
schemaVersion: 1
scalers:
 - type: activemq
 parameters:
 - name: managementEndpoint
 type: string
 optional: true
 metadataVariableReadable: true
 - name: destinationName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: brokerName
 type: string
 optional: true
 metadataVariableReadable: true
 - name: username
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: password
 type: string
 metadataVariableReadable: true
 envVariableReadable: true
 triggerAuthenticationVariableReadable: true
 - name: corsHeader
 type: string
 optional: true
 metadataVariableReadable: true
 - name: restAPITemplate
 type: string
 optional: true
 metadataVariableReadable: true
 - name: targetQueueSize
 type: string
 default: "10"
 metadataVariableReadable: true
 - name: activationTargetQueueSize
 type: string
 default: "0"
 metadataVariableReadable: true
 - type: apache-kafka
 parameters:
 - name: bootstrapServers
 ...

Metadata field’s property detail:

Security

Mon, 01 Jan 0001 00:00:00 +0000

Use your own TLS Certificates

Overview

Deployments are the most common way to scale workloads with KEDA.

It allows you to define the Kubernetes Deployment that you want KEDA to scale based on a scale trigger. KEDA will monitor that service and based on the events that occur it will automatically scale your deployment out/in accordingly.

Behind the scenes, KEDA acts to monitor the event source and feed that data to Kubernetes and the HPA (Horizontal Pod Autoscaler) to drive rapid scale of a deployment. Each replica of a deployment is actively pulling items from the event source. With KEDA and scaling deployments you can scale based on events while also preserving rich connection and processing semantics with the event source (e.g. in-order processing, retries, deadletter, checkpointing).

Scaling Deployments

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Deployments are the most common way to scale workloads with KEDA.

Scaling Deployments, StatefulSets & Custom Resources

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Scaling of Deployments and StatefulSets

Deployments and StatefulSets are the most common way to scale workloads with KEDA.

Scaling Deployments and StatefulSets

Deployments and StatefulSets are the most common way to scale workloads with KEDA.

Scaling Deployments, StatefulSets & Custom Resources

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Scaling of Deployments and StatefulSets

Deployments and StatefulSets are the most common way to scale workloads with KEDA.

Scaling Deployments, StatefulSets & Custom Resources

Mon, 01 Jan 0001 00:00:00 +0000

This page describes the deployment scaling behavior of KEDA.

Specification

See the Scaled Object specification for details on how to set the behaviors described below.

Scaling objects

Scaling Deployments, StatefulSets & Custom Resources

Mon, 01 Jan 0001 00:00:00 +0000

Overview

Scaling of Deployments and StatefulSets

Deployments and StatefulSets are the most common way to scale workloads with KEDA.

Scaling Jobs

Mon, 01 Jan 0001 00:00:00 +0000

Overview

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use credentials or delegate authentication with TriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use credentials or delegate authentication with TriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use credentials or delegate authentication with TriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

Authentication

Mon, 01 Jan 0001 00:00:00 +0000

Often a scaler will require authentication or secrets and config to check for events.

KEDA provides a few secure patterns to manage authentication flows:

Configure authentication per ScaledObject
Re-use per-namespace credentials or delegate authentication with TriggerAuthentication
Re-use global credentials with ClusterTriggerAuthentication

Defining secrets and config maps on ScaledObject

Some metadata parameters will not allow resolving from a literal value, and will instead require a reference to a secret, config map, or environment variable defined on the target container.

External Scalers

Mon, 01 Jan 0001 00:00:00 +0000

If you are experiencing messages like “Waited for … due to client-side throttling” in your KEDA operator logs, it might indicate that the KEDA operator is being throttled by the Kubernetes API server. This can happen in environments with a large number of ScaledObject resources.

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

Reporting issues

If you are having issues or hitting a potential bug, please file an issue in the KEDA GitHub repo with details, logs, and steps to reproduce the behavior.

Troubleshooting

Mon, 01 Jan 0001 00:00:00 +0000

KEDA logging and telemetry

You can view the KEDA operator pod via kubectl:

kubectl get pods -n keda

You can view the logs for the keda operator container with the following:

kubectl logs -n keda {keda-pod-name} -c keda-operator

What is KEDA and why is it useful?

What are the prerequisites for using KEDA?

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAScalerInfo`	`Normal`	When a Scaler contains deprecated field
`KEDAScalerInfo`	`Warning`	When a Scaler contains unexpected parameter (disabled by default, enable with `KEDA_CHECK_UNEXPECTED_SCALERS_PARAMS`)
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectUpdateFailed`	`Warning`	When KEDA fails to update status for a ScaledObject
`ScaledJobUpdateFailed`	`Warning`	When KEDA fails to update status for a ScaledJob
`ScaledObjectPaused`	`Normal`	When a ScaledObject is paused
`ScaledObjectUnpaused`	`Normal`	When a ScaledObject is unpaused
`ScaledObjectFallbackActivated`	`Normal`	When a ScaledObject fallback becomes active
`ScaledObjectFallbackDeactivated`	`Normal`	When a ScaledObject fallback becomes inactive
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`ScaledJobPaused`	`Normal`	When a ScaledJob is paused
`ScaledJobUnpaused`	`Normal`	When a ScaledJob is unpaused
`ScaledJobPauseFailed`	`Warning`	When KEDA fails to pause a ScaledJob
`ScaledJobRolloutCleanupStarted`	`Normal`	When KEDA starts cleaning up Jobs owned by the previous version of a ScaledJob
`ScaledJobRolloutCleanupCompleted`	`Normal`	When KEDA completes cleanup of Jobs owned by the previous version of a ScaledJob
`ScaledJobRolloutCleanupFailed`	`Warning`	When KEDA fails to delete a Job owned by the previous version of a ScaledJob
`ScaledJobActive`	`Normal`	When a ScaledJob becomes active (triggers are active and scaling is performed)
`ScaledJobInactive`	`Normal`	When a ScaledJob becomes inactive (triggers are not active and scaling is not performed)
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAMetricSourceFailed`	`Warning`	When a scaler fails as a metric source for custom formula
`KEDAScalerInfo`	`Normal`	When a Scaler contains deprecated field
`KEDAScalerInfo`	`Warning`	When a Scaler contains unexpected parameter (disabled by default, enable with `KEDA_CHECK_UNEXPECTED_SCALERS_PARAMS`)
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`KEDAJobCreateFailed`	`Warning`	When KEDA fails to create a Job for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationUpdated`	`Normal`	When a TriggerAuthentication is updated
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationUpdated`	`Normal`	When a ClusterTriggerAuthentication is updated
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectUpdateFailed`	`Warning`	When KEDA fails to update status for a ScaledObject
`ScaledJobUpdateFailed`	`Warning`	When KEDA fails to update status for a ScaledJob
`ScaledObjectPaused`	`Normal`	When a ScaledObject is paused
`ScaledObjectUnpaused`	`Normal`	When a ScaledObject is unpaused
`ScaledObjectFallbackActivated`	`Normal`	When a ScaledObject fallback becomes active
`ScaledObjectFallbackDeactivated`	`Normal`	When a ScaledObject fallback becomes inactive
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`ScaledJobPaused`	`Normal`	When a ScaledJob is paused
`ScaledJobUnpaused`	`Normal`	When a ScaledJob is unpaused
`ScaledJobPauseFailed`	`Warning`	When KEDA fails to pause a ScaledJob
`ScaledJobRolloutCleanupStarted`	`Normal`	When KEDA starts cleaning up Jobs owned by the previous version of a ScaledJob
`ScaledJobRolloutCleanupCompleted`	`Normal`	When KEDA completes cleanup of Jobs owned by the previous version of a ScaledJob
`ScaledJobRolloutCleanupFailed`	`Warning`	When KEDA fails to delete a Job owned by the previous version of a ScaledJob
`ScaledJobActive`	`Normal`	When a ScaledJob becomes active (triggers are active and scaling is performed)
`ScaledJobInactive`	`Normal`	When a ScaledJob becomes inactive (triggers are not active and scaling is not performed)
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAMetricSourceFailed`	`Warning`	When a scaler fails as a metric source for custom formula
`KEDAScalerInfo`	`Normal`	When a Scaler contains deprecated field
`KEDAScalerInfo`	`Warning`	When a Scaler contains unexpected parameter (disabled by default, enable with `KEDA_CHECK_UNEXPECTED_SCALERS_PARAMS`)
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`KEDAJobCreateFailed`	`Warning`	When KEDA fails to create a Job for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationUpdated`	`Normal`	When a TriggerAuthentication is updated
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationUpdated`	`Normal`	When a ClusterTriggerAuthentication is updated
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

Events reference

Mon, 01 Jan 0001 00:00:00 +0000

KEDA emits the following Kubernetes Events:

Event	Type	Description
`ScaledObjectReady`	`Normal`	On the first time a ScaledObject is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledJobReady`	`Normal`	On the first time a ScaledJob is ready, or if the previous ready condition status of the object was `Unknown` or `False`
`ScaledObjectCheckFailed`	`Warning`	If the check validation for a ScaledObject fails
`ScaledJobCheckFailed`	`Warning`	If the check validation for a ScaledJob fails
`ScaledObjectUpdateFailed`	`Warning`	When KEDA fails to update status for a ScaledObject
`ScaledJobUpdateFailed`	`Warning`	When KEDA fails to update status for a ScaledJob
`ScaledObjectPaused`	`Normal`	When a ScaledObject is paused
`ScaledObjectUnpaused`	`Normal`	When a ScaledObject is unpaused
`ScaledObjectFallbackActivated`	`Normal`	When a ScaledObject fallback becomes active
`ScaledObjectFallbackDeactivated`	`Normal`	When a ScaledObject fallback becomes inactive
`ScaledObjectDeleted`	`Normal`	When a ScaledObject is deleted and removed from KEDA watch
`ScaledJobDeleted`	`Normal`	When a ScaledJob is deleted and removed from KEDA watch
`ScaledJobPaused`	`Normal`	When a ScaledJob is paused
`ScaledJobUnpaused`	`Normal`	When a ScaledJob is unpaused
`ScaledJobPauseFailed`	`Warning`	When KEDA fails to pause a ScaledJob
`ScaledJobRolloutCleanupStarted`	`Normal`	When KEDA starts cleaning up Jobs owned by the previous version of a ScaledJob
`ScaledJobRolloutCleanupCompleted`	`Normal`	When KEDA completes cleanup of Jobs owned by the previous version of a ScaledJob
`ScaledJobRolloutCleanupFailed`	`Warning`	When KEDA fails to delete a Job owned by the previous version of a ScaledJob
`ScaledJobActive`	`Normal`	When a ScaledJob becomes active (triggers are active and scaling is performed)
`ScaledJobInactive`	`Normal`	When a ScaledJob becomes inactive (triggers are not active and scaling is not performed)
`KEDAScalersStarted`	`Normal`	When Scalers watch loop have started for a ScaledObject or ScaledJob
`KEDAScalersStopped`	`Normal`	When Scalers watch loop have stopped for a ScaledObject or a ScaledJob
`KEDAScalerFailed`	`Warning`	When a Scaler fails to create or check its event source
`KEDAMetricSourceFailed`	`Warning`	When a scaler fails as a metric source for custom formula
`KEDAScalerInfo`	`Normal`	When a Scaler contains deprecated field
`KEDAScalerInfo`	`Warning`	When a Scaler contains unexpected parameter (disabled by default, enable with `KEDA_CHECK_UNEXPECTED_SCALERS_PARAMS`)
`KEDAScaleTargetActivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 1, triggered by {scalers1;scalers2;…}
`KEDAScaleTargetDeactivated`	`Normal`	When the scale target (Deployment, StatefulSet, etc) of a ScaledObject is scaled to 0
`KEDAScaleTargetActivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 1
`KEDAScaleTargetDeactivationFailed`	`Warning`	When KEDA fails to scale the scale target of a ScaledObject to 0
`KEDAJobsCreated`	`Normal`	When KEDA creates jobs for a ScaledJob
`KEDAJobCreateFailed`	`Warning`	When KEDA fails to create a Job for a ScaledJob
`TriggerAuthenticationAdded`	`Normal`	When a new TriggerAuthentication is added
`TriggerAuthenticationUpdated`	`Normal`	When a TriggerAuthentication is updated
`TriggerAuthenticationDeleted`	`Normal`	When a TriggerAuthentication is deleted
`ClusterTriggerAuthenticationAdded`	`Normal`	When a new ClusterTriggerAuthentication is added
`ClusterTriggerAuthenticationUpdated`	`Normal`	When a ClusterTriggerAuthentication is updated
`ClusterTriggerAuthenticationDeleted`	`Normal`	When a ClusterTriggerAuthentication is deleted

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This specification describes the ScaledObject Custom Resource definition that defines the triggers and scaling behaviors used by KEDA to scale Deployment, StatefulSet and Custom Resource target resources. The .spec.ScaleTargetRef section holds the reference to the target resource, defined in scaledobject_types.go.

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 behavior: {kind-of-behavior} # Optional. Default: "static"
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 behavior: {kind-of-behavior} # Optional. Default: "static"
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 behavior: {kind-of-behavior} # Optional. Default: "static"
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 behavior: {kind-of-behavior} # Optional. Default: "static"
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledObject specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
 name: {scaled-object-name}
 annotations:
 scaledobject.keda.sh/transfer-hpa-ownership: "true" # Optional. Use to transfer an existing HPA ownership to this ScaledObject
 validations.keda.sh/hpa-ownership: "true" # Optional. Use to disable HPA ownership validation on this ScaledObject
 autoscaling.keda.sh/paused: "true" # Optional. Use to pause autoscaling of objects explicitly
spec:
 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]
 pollingInterval: 30 # Optional. Default: 30 seconds
 cooldownPeriod: 300 # Optional. Default: 300 seconds
 initialCooldownPeriod: 0 # Optional. Default: 0 seconds
 idleReplicaCount: 0 # Optional. Default: ignored, must be less than minReplicaCount
 minReplicaCount: 1 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 fallback: # Optional. Section to specify fallback options
 failureThreshold: 3 # Mandatory if fallback section is included
 replicas: 6 # Mandatory if fallback section is included
 behavior: {kind-of-behavior} # Optional. Default: "static"
 advanced: # Optional. Section to specify advanced options
 restoreToOriginalReplicaCount: true/false # Optional. Default: false
 horizontalPodAutoscalerConfig: # Optional. Section to specify HPA related options
 name: {name-of-hpa-resource} # Optional. Default: keda-hpa-{scaled-object-name}
 behavior: # Optional. Use to modify HPA's scaling behavior
 scaleDown:
 stabilizationWindowSeconds: 300
 policies:
 - type: Percent
 value: 100
 periodSeconds: 15
 triggers:
 # {list of triggers to activate scaling of the target resource}

scaleTargetRef

 scaleTargetRef:
 apiVersion: {api-version-of-target-resource} # Optional. Default: apps/v1
 kind: {kind-of-target-resource} # Optional. Default: Deployment
 name: {name-of-target-resource} # Mandatory. Must be in the same namespace as the ScaledObject
 envSourceContainerName: {container-name} # Optional. Default: .spec.template.spec.containers[0]

The reference to the resource this ScaledObject is configured for. This is the resource KEDA will scale up/down and set up an HPA for, based on the triggers defined in triggers:.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This specification describes the ScaledJob custom resource definition that defines the triggers and scaling behaviors use by KEDA

to scale jobs. The .spec.ScaleTargetRef section holds the reference to the job, defined in scaledjob_types.go.

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This specification describes the ScaledJob custom resource definition that defines the triggers and scaling behaviors use by KEDA to scale Job resources. The .spec.ScaleTargetRef section holds the reference to the job, defined in scaledjob_types.go.

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

This specification describes the ScaledJob custom resource definition that defines the triggers and scaling behaviors use by KEDA to scale jobs. The .spec.ScaleTargetRef section holds the reference to the job, defined in scaledjob_types.go.

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

ScaledJob specification

Mon, 01 Jan 0001 00:00:00 +0000

Overview

apiVersion: keda.sh/v1alpha1
kind: ScaledJob
metadata:
 name: {scaled-job-name}
 labels:
 my-label: {my-label-value} # Optional. ScaledJob labels are applied to child Jobs
 annotations:
 autoscaling.keda.sh/paused: true # Optional. Use to pause autoscaling of Jobs
 my-annotation: {my-annotation-value} # Optional. ScaledJob annotations are applied to child Jobs
spec:
 jobTargetRef:
 parallelism: 1 # [max number of desired pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 completions: 1 # [desired number of successfully finished pods](https://kubernetes.io/docs/concepts/workloads/controllers/job/#controlling-parallelism)
 activeDeadlineSeconds: 600 # Specifies the duration in seconds relative to the startTime that the job may be active before the system tries to terminate it; value must be positive integer
 backoffLimit: 6 # Specifies the number of retries before marking this job failed. Defaults to 6
 template:
 # describes the job's [pod template](https://kubernetes.io/docs/concepts/workloads/controllers/job)
 pollingInterval: 30 # Optional. Default: 30 seconds
 successfulJobsHistoryLimit: 5 # Optional. Default: 100. How many completed jobs should be kept.
 failedJobsHistoryLimit: 5 # Optional. Default: 100. How many failed jobs should be kept.
 envSourceContainerName: {container-name} # Optional. Default: .spec.JobTargetRef.template.spec.containers[0]
 minReplicaCount: 10 # Optional. Default: 0
 maxReplicaCount: 100 # Optional. Default: 100
 rolloutStrategy: gradual # Deprecated: Use rollout.strategy instead (see below).
 rollout:
 strategy: gradual # Optional. Default: default. Which Rollout Strategy KEDA will use.
 propagationPolicy: foreground # Optional. Default: background. Kubernetes propagation policy for cleaning up existing jobs during rollout.
 scalingStrategy:
 strategy: "custom" # Optional. Default: default. Which Scaling Strategy to use. 
 customScalingQueueLengthDeduction: 1 # Optional. A parameter to optimize custom ScalingStrategy.
 customScalingRunningJobPercentage: "0.5" # Optional. A parameter to optimize custom ScalingStrategy.
 pendingPodConditions: # Optional. A parameter to calculate pending job count per the specified pod conditions
 - "Ready"
 - "PodScheduled"
 - "AnyOtherCustomPodCondition"
 multipleScalersCalculation : "max" # Optional. Default: max. Specifies how to calculate the target metrics when multiple scalers are defined.
 triggers:
 # {list of triggers to create jobs}

You can find all supported triggers here.

Google Cloud deprecations

Mon, 15 Sep 2025 00:00:00 +0000

One year ago, Google Cloud deprecated its Monitoring Query Language in favor of a PromQL-based API:

Announcement: Starting on October 22, 2024, Monitoring Query Language (MQL) will no longer be a recommended query language for Cloud Monitoring. Certain usability features will be disabled, but you can still run MQL queries in Metrics Explorer, and dashboards and alerting policies that use MQL will continue to work. For more information, see the deprecation notice for MQL.

KEDA is graduating to CNCF Graduated project 🎉

Tue, 22 Aug 2023 00:00:00 +0000

In 2019, KEDA embarked on a mission to make application autoscaling on Kubernetes dead-simple. Our aim was to make sure that every Kubernetes platform can use it to scale applications without having to worry about the underlying autoscaling infrastructure.

As part of that mission, we wanted to build a vendor-neutral project that is open to everyone and nicely integrates with other tools. Because of that, the KEDA maintainers decided that the Cloud Native Computing Foundation (CNCF) was a natural fit and got accepted as a sandbox project in 2020.

Securing autoscaling with the newly improved certificate management in KEDA 2.10

Tue, 16 May 2023 00:00:00 +0000

Recently, we have release KEDA v2.10 that introduced a key improvement for managing certificates and your autoscaling security:

Encryption of any communication between KEDA components.
Support for providing your own certificates for internal communications.
Support for using customs certificate authorities (CA).

With these new improvements, we can dramatically improve the security between KEDA components, the Kubernetes API server and scaler sources. Let’s take a closer look.

Where do we come from?

KEDA is a component that runs on kubernetes, receiving request from kubernetes API server (from the HPA Controller) but also integrates with multiple external sources (upstreams).

Help shape the future of KEDA with our survey 📝

Thu, 04 May 2023 00:00:00 +0000

As maintainers, we are always eager to learn who is using KEDA (become a listed end-user!) and how they are using KEDA to scale their cloud-native workloads.

Our job is to make sure that your are able to scale the workloads that you run with as less friction as possible, production-grade security, insights on what is going on, etc.

In order to be successful, we need to learn how big of KEDA deployments end-users are running, what is causing frustration and what we can improve. This is why we have created a survey to gain more insights and make KEDA better.

Announcing KEDA v2.9 🎉

Mon, 12 Dec 2022 00:00:00 +0000

We recently completed our most recent release: 2.9.0 🎉!

Here are some highlights:

Newly published Deprecations and Breaking Change policy (docs)
Introduce new CouchDB, Etcd & Loki scalers
Introduce off-the-shelf Grafana dashboard for application autoscaling
Introduce improved operational metrics in Prometheus
Introduce capability to cache metric values for a scaler during the polling interval (experimental feature)
Performance improvements and architecture changes on how metrics are exposed to Kubernetes
Azure Key Vault authentication provider now supports pod identities for authentication
A ton of new features and fixes for some of our 50+ scalers

Potential breaking changes and deprecations include:

HTTP add-on is looking for contributors by end of November

Tue, 27 Sep 2022 00:00:00 +0000

On Nov 25, 2020, we started the HTTP add-on based on @arschles his initial POC which closed a big gap in KEDA’s story - HTTP autoscaling without a dependency on an external system, such as Prometheus.

To this day, the autoscaling community has a very high demand for a solution in this area that auto scales and works in the same manner as the KEDA core.

With the add-on, we want to cover all traffic patterns ranging from ingress, to service meshes and service-to-service communication and make it super simple to autoscale (and with scale-to-zero support).

Announcing KEDA v2.8 🎉

Wed, 10 Aug 2022 00:00:00 +0000

We recently completed our most recent release: 2.8.0 🎉!

Here are some highlights:

Introduction of new AWS DynomoDB Streams & NATS JetStream scalers.
Introduction of new Azure AD Workload Identity authentication provider.
Support for specifying minReplicaCount in ScaledJob.
Support to customize the HPA name.
Support for permission segregation when using Azure AD Pod / Workload Identity
Additional features to various scalers such as AWS SQS, Azure Pipelines, CPU, GCP Stackdriver, Kafka, Memory, Prometheus

Here are the new deprecation(s) as of this release:

How Zapier uses KEDA

Thu, 10 Mar 2022 00:00:00 +0000

RabbitMQ is at the heart of Zap processing at Zapier. We enqueue messages to RabbitMQ for each step in a Zap. These messages get consumed by our backend workers, which run on Kubernetes. To keep up with the varying task loads in Zapier we need to scale our workers with our message backlog.

For a long time, we scaled with CPU-based autoscaling using Kubernetes native Horizontal Pod Autoscale (HPA), where more tasks led to more processing, increasing CPU usage, and triggering our workers’ autoscaling. It seemed to work pretty well, except for certain edge cases.

Introducing PredictKube - an AI-based predictive autoscaler for KEDA made by Dysnix

Mon, 14 Feb 2022 00:00:00 +0000

Introducing PredictKube—an AI-based predictive autoscaler for KEDA made by Dysnix

Dysnix has been working with high-traffic backend systems for a long time, and the efficient scaling demand is what their team comes across each day. The engineers have understood that manually dealing with traffic fluctuations and preparations of infrastructure is inefficient because you need to deploy more resources before the traffic increases, not at the moment the event happens. This strategy is problematic for two reasons: first, because it’s often too late to scale when traffic has already arrived and second, resources will be overprovisioned and idle during the times that traffic isn’t present.

How CAST AI uses KEDA for Kubernetes autoscaling

Wed, 04 Aug 2021 00:00:00 +0000

How CAST AI uses KEDA for Kubernetes autoscaling

Kubernetes comes with several built-in autoscaling mechanisms - among them the Horizontal Pod Autoscaler (HPA). Scaling is essential for the producer-consumer workflow, a common use case in the IT world today. It’s especially useful for monthly reports and transactions with a huge load where teams need to spin up many workloads to process things faster and cheaper (for example, by using spot instances).

Announcing KEDA HTTP Add-on v0.1.0

Thu, 24 Jun 2021 00:00:00 +0000

Over the past few months, we’ve been adding more and more scalers to KEDA making it easier for users to scale on what they need. Today, we leverage more than 30 scalers out-of-the-box, supporting all major cloud providers & industry-standard tools such as Prometheus that can scale any Kubernetes resource.

But, we are missing a major feature that many modern, distributed applications need - the ability to scale based on HTTP traffic.

Autoscaling Azure Pipelines agents with KEDA

Thu, 27 May 2021 00:00:00 +0000

With the addition of Azure Piplines support in KEDA, it is now possible to autoscale your Azure Pipelines agents based on the agent pool queue length.

Self-hosted Azure Pipelines agents are the perfect workload for this scaler. By autoscaling the agents you can create a scalable CI/CD environment.

💡 The number of concurrent pipelines you can run is limited by your parallel jobs.

KEDA will autoscale to the maximum defined in the ScaledObject and does not limit itself to the parallel jobs count defined for the Azure DevOps organization.

Why Alibaba Cloud uses KEDA for application autoscaling

Tue, 06 Apr 2021 00:00:00 +0000

This blog post was initially posted on CNCF blog and is co-authored by Yan Xun, Senior Engineer from Alibaba Cloud EDAS team & Andy Shi, Developer Advocator from Alibaba Cloud.

When scaling Kubernetes there are a few areas that come to mind, but if you are new to Kubernetes this can be a bit overwhelming.

In this blog post; we will briefly explain the areas that need to be considered, how KEDA aims to make application auto-scaling simple, and why Alibaba Cloud’s Enterprise Distributed Application Service (EDAS) has fully standardized on KEDA.

Migrating our container images to GitHub Container Registry

Fri, 26 Mar 2021 00:00:00 +0000

We provide various ways to deploy KEDA in your cluster including by using Helm chart, Operator Hub and raw YAML specifications.

These deployment options all rely on the container images that we provide which are available on Docker Hub, the industry standard for public container images.

However, we have found that Docker Hub is no longer the best place for our container images and are migrating to GitHub Container Registry (Preview).

Announcing KEDA 2.0 - Taking app autoscaling to the next level

Wed, 04 Nov 2020 00:00:00 +0000

A year ago, we were excited to announce our 1.0 release with a core set of scalers, allowing the community to start autoscaling Kubernetes deployments. We were thrilled with the response and encouraged to see many users leveraging KEDA for event driven and serverless scale within any Kubernetes cluster.

With KEDA, any container can scale to zero and burst scale based directly on event source metrics.

Give KEDA 2.0 (Beta) a test drive

Fri, 11 Sep 2020 00:00:00 +0000

Today, we are happy to share that our first beta version of KEDA 2.0 is available! 🎊

Highlights

With this release, we are shipping majority of our planned features.

Here are some highlights:

Making scaling more powerful
- Introduction of ScaledJob (docs)
- Introduction of Azure Log Analytics scaler (docs)
- Support for scaling Deployments, Stateful Sets and/or any Custom Resources (docs)
- Support for scaling on standard resource metrics (CPU/Memory)
- Support for multiple triggers in a single ScaledObject (docs)
- Support for scaling to original replica count after deleting ScaledObject (docs)
- Support for controlling scaling behavior of underlying HPA
Easier to operate KEDA
- Introduction of readiness and liveness probes
- Introduction of Prometheus metrics for Metrics Server (docs)
- Provide more information when querying KEDA resources with kubectl
Extensibility
- Introduction of External Push scaler (docs)
- Introduction of Metric API scaler (docs)
- Provide KEDA client-go library

For a full list of changes, we highly recommend going through our changelog! With our stable release, we’ll provide a full overview of what’s released in a new blog post.

Kubernetes Event-driven Autoscaling (KEDA) is now an official CNCF Sandbox project 🎉

Tue, 31 Mar 2020 00:00:00 +0000

Over the past year, We’ve been contributing to Kubernetes Event-Driven Autoscaling (KEDA), which makes application autoscaling on Kubernetes dead simple. If you have missed it, read about it in our “Exploring Kubernetes-based event-driven autoscaling (KEDA)” blog post.

We started the KEDA project to address an essential missing feature in the Kubernetes autoscaling story. Namely, the ability to autoscale on arbitrary metrics. Before KEDA, users were only able to autoscale based on metrics such as memory and CPU usage. While these values are essential for autoscaling, they disregard a rich world of external metrics from sources such as Azure, AWS, GCP, Redis, and Kafka (among many more).

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the activemq trigger that scales based on a ActiveMQ Queue.

triggers:
- type: activemq
 metadata:
 managementEndpoint: "activemq.activemq-test:8161"
 destinationName: "testQueue"
 brokerName: "activemq_broker"
 targetQueueSize: "100"
 activationTargetQueueSize: "10"

Parameter list:

managementEndpoint - ActiveMQ management endpoint in format: <hostname>:<port>.
destinationName - Name of the queue to check for the message count.
brokerName - Name of the broker as defined in ActiveMQ.
targetQueueSize - Target value for queue length passed to the scaler. The scaler will cause the replicas to increase if the queue message count is greater than the target value per active replica. (Default: 10, Optional)
activationTargetQueueSize - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restAPITemplate - Template to build REST API url to get queue size. (Default: "http://{{.ManagementEndpoint}}/api/jolokia/read/org.apache.activemq:type=Broker,brokerName={{.BrokerName}},destinationType=Queue,destinationName={{.DestinationName}}/QueueSize", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Parameter Requirements:

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'

Parameter list:

managementEndpoint - “hostname:port” to connect to ActiveMQ Artemis management endpoint.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address name of the broker.
queueLength - How much messages are in the queue. (Default: 10, Optional.)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)
unsafeSsl - Skip certificate validation when connecting over HTTPS. (Default: false, Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)
unsafeSsl - Skip certificate validation when connecting over HTTPS. (Default: false, Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)
unsafeSsl - Skip certificate validation when connecting over HTTPS. (Default: false, Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)
unsafeSsl - Skip certificate validation when connecting over HTTPS. (Default: false, Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

ActiveMQ Artemis

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the artemis-queue trigger for ActiveMQ Artemis queues.

triggers:
- type: artemis-queue
 metadata:
 managementEndpoint: "artemis-activemq.artemis:8161"
 queueName: "test"
 brokerName: "artemis-activemq"
 brokerAddress: "test"
 queueLength: '10'
 activationQueueLength: '1'
 username: 'ARTEMIS_USERNAME'
 password: 'ARTEMIS_PASSWORD'
 restApiTemplate: # Optional. Default : "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount"

Parameter list:

managementEndpoint - ActiveMQ Artemis management endpoint to connect to in <hostname>:<port> format.
queueName - Name of the queue to check for the number of messages available.
brokerName - Name of the broker as defined in Artemis.
brokerAddress - Address of the broker.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (default: 10)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
restApiTemplate - Template to build REST API url to get queue size. (Default: "http://<<managementEndpoint>>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<<brokerName>>\",component=addresses,address=\"<<brokerAddress>>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<<queueName>>\"/MessageCount", Optional)
corsHeader - Value to populate the Origin header field for CORS filtering. (Default: "http://<<managmentEndpoint>>", Optional)

Authentication Parameters

You can use TriggerAuthentication CRD to configure the username and password to connect to the management endpoint.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

No. of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

No. of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

No. of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

No. of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

No. of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

The number of partitions with non-zero lag if limitToPartitionsWithLag is set to true That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed the number of partitions on a topic. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed the number of partitions on a topic and will not exceed maxReplicaCount. That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

This is so because if there are more number of consumers than the number of partitions in a topic, then extra consumer will have to sit idle.

Trigger Specification

This specification describes the kafka trigger for an Apache Kafka topic.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

By default, the number of replicas will not exceed:

The number of partitions on a topic when a topic is specified;

The number of partitions of all topics in the consumer group when no topic is specified;

maxReplicaCount specified in ScaledObject/ScaledJob. If not specified, then the default value of maxReplicaCount is taken into account;

That is, if maxReplicaCount is set more than number of partitions, the scaler won’t scale up to target maxReplicaCount. See allowIdleConsumers below to disable this default behavior.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Kafka (Experimental)

Mon, 01 Jan 0001 00:00:00 +0000

Notice:

This is an experimental Kafka scaler based on kafka-go library.

This scaler is not fully compatible with the existing Kafka scaler. There are some differences in the configuration and behavior. Please read the documentation carefully before using it.

If you are using OAuth authentication, please use the existing Kafka scaler, as this scaler does not yet support OAuth2 authentication.

This scaler has support for AWS MSK IAM based authentication.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls,basic, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls,basic, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls, basic, oauth, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)
oauthTokenURI - The OAuth Access Token URI for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
scope - A comma separated lists of OAuth scopes, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
clientID - Client ID for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)
endpointParams - Additional parameters as URL-encoded query string for requests to the token endpoint for the OAuth provider, used when authModes is set to oauth. Ignored if provided from authenticationRef. (Optional)

Authentication Parameters

The authentication is defined in authModes. The associated configuration parameters are specified in the TriggerAuthentication spec.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)

Authentication Parameters

If TLS is required you should set tls to enable. If required for your Pulsar configuration, you may also provide a ca, cert and key. ca, cert and key must be specified together.

Apache Pulsar

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the pulsar trigger for an Apache Pulsar topic.

triggers:
- type: pulsar
 metadata:
 adminURL: http://localhost:80
 topic: persistent://public/default/my-topic
 isPartitionedTopic: false
 subscription: sub1
 msgBacklogThreshold: '5'
 activationMsgBacklogThreshold: '2'
 authModes: ""

Parameter list:

adminURL - Stats URL of the admin API for your topic.
topic - Pulsar topic. format of persistent://{tenant}/{namespace}/{topicName}
isPartitionedTopic - Whether the topic is partitioned. When true, the msgBacklogThreshold will be the cumulative subscription backlog across partitions. (default: false, Optional)
subscription - Name of the topic subscription
msgBacklogThreshold - Average target value to trigger scaling actions. (default: 10)
activationMsgBacklogThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
authModes - a comma separated list of authentication modes to use. (Values: bearer, tls,basic, Default: "", Optional, tls,bearer or tls,basic are valid combinations and would indicate mutual TLS to secure the connection and then bearer or basic headers should be added to the HTTP request)

The HTTP Add-on solves this by placing dedicated infrastructure in the request path. An interceptor proxy sits in front of your application, counts requests as they flow through, and holds requests during cold starts while backends scale up. A scaler component aggregates those counts into metrics that KEDA can use to drive the Horizontal Pod Autoscaler (HPA).

Architecture

Mon, 01 Jan 0001 00:00:00 +0000

The Problem: HTTP Has No Queue

Architecture

Mon, 01 Jan 0001 00:00:00 +0000

The Problem: HTTP Has No Queue

Autoscale an App

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through the two resources needed to autoscale an existing HTTP service with the KEDA HTTP Add-on: an InterceptorRoute and a KEDA ScaledObject.

Prerequisites

The HTTP Add-on is installed in your cluster.
You have an existing Deployment (or other workload) and a Service for your HTTP application.

Step 1: Create an InterceptorRoute

The InterceptorRoute tells the interceptor how to route requests to your service and what scaling metrics to report.

Autoscale an App

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through the two resources needed to autoscale an existing HTTP service with the KEDA HTTP Add-on: an InterceptorRoute and a KEDA ScaledObject.

Prerequisites

The HTTP Add-on is installed in your cluster.
You have an existing Deployment (or other workload) and a Service for your HTTP application.

Step 1: Create an InterceptorRoute

The InterceptorRoute tells the interceptor how to route requests to your service and what scaling metrics to report.

Autoscale an App

Mon, 01 Jan 0001 00:00:00 +0000

This guide walks you through the two resources needed to autoscale an existing HTTP service with the KEDA HTTP Add-on: an InterceptorRoute and a KEDA ScaledObject.

Prerequisites

The HTTP Add-on is installed in your cluster.
You have an existing Deployment (or other workload) and a Service for your HTTP application.

Step 1: Create an InterceptorRoute

The InterceptorRoute tells the interceptor how to route requests to your service and what scaling metrics to report.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS (IRSA) Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

AWS IAM Roles for Service Accounts (IRSA) Pod Identity Webhook (documentation) allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use AWS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws
 roleArn: <role-arn> # Optional. 
 identityOwner: keda|workload # Optional. If not set, 'keda' is default value. Mutually exclusive with 'roleArn' (if set)

Parameter list:

roleArn - Role ARN to be used by KEDA. If not set the IAM role which the KEDA operator uses will be used. Mutually exclusive with identityOwner: workload
identityOwner - Owner of the identity to be used. (Values: keda, workload, Default: keda, Optional)

⚠️ NOTE: podIdentity.roleArn and podIdentity.identityOwner are mutually exclusive, setting both is not supported.

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name
 dimensionName: QueueName
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyID: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKey: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name
 dimensionName: QueueName
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyID: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKey: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name
 dimensionName: QueueName
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
 dimensionName: QueueName
 # Required: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Metric Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator 
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Optional: ignoreNullValues
 ignoreNullValues: "false"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Optional: ignoreNullValues
 ignoreNullValues: "false"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Optional: ignoreNullValues
 ignoreNullValues: "false"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Optional: ignoreNullValues
 ignoreNullValues: "false"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: Specify metric source AWS Account ID when using CloudWatch cross-account observability
 awsAccountId: ""
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
 dimensionName: QueueName
 # Required: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Metric Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Optional: ignoreNullValues
 ignoreNullValues: "false"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: Specify metric source AWS Account ID when using CloudWatch cross-account observability
 awsAccountId: ""
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Optional: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 # Optional: metricName
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Optional: ignoreNullValues
 ignoreNullValues: "false"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: Specify metric source AWS Account ID when using CloudWatch cross-account observability
 awsAccountId: ""
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
 dimensionName: QueueName
 # Required: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Metric Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
 dimensionName: QueueName
 # Required: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Metric Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
 dimensionName: QueueName
 # Required: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Required: Dimension Name - Supports specifying multiple dimension names by using ";" as a separator i.e. dimensionName: QueueName;QueueName
 dimensionName: QueueName
 # Required: Dimension Value - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2
 dimensionValue: keda
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2"
 minMetricValue: "0"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS CloudWatch

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-cloudwatch trigger that scales based on a AWS CloudWatch.

triggers:
- type: aws-cloudwatch
 metadata:
 # Required: namespace
 namespace: AWS/SQS
 # Optional: Dimension Name
 dimensionName: QueueName
 # Optional: Dimension Value
 dimensionValue: keda
 # Optional: Expression query
 expression: SELECT MAX("ApproximateNumberOfMessagesVisible") FROM "AWS/SQS" WHERE QueueName = 'keda'
 metricName: ApproximateNumberOfMessagesVisible
 targetMetricValue: "2.1"
 minMetricValue: "1.5"
 # Required: region
 awsRegion: "eu-west-1"
 # Optional: AWS endpoint url
 awsEndpoint: ""
 # Optional: AWS Access Key ID, can use TriggerAuthentication as well
 awsAccessKeyIDFromEnv: AWS_ACCESS_KEY_ID # default AWS_ACCESS_KEY_ID
 # Optional: AWS Secret Access Key, can use TriggerAuthentication as well
 awsSecretAccessKeyFromEnv: AWS_SECRET_ACCESS_KEY # default AWS_SECRET_ACCESS_KEY
 identityOwner: pod | operator # Optional. Default: pod
 # Optional: Collection Time
 metricCollectionTime: "300" # default 300
 # Optional: Metric Statistic
 metricStat: "Average" # default "Average"
 # Optional: Metric Statistic Period
 metricStatPeriod: "300" # default 300
 # Optional: Metric Unit
 metricUnit: "Count" # default ""
 # Optional: Metric EndTime Offset
 metricEndTimeOffset: "60" # default 0

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}, ":filterValue" : {"S" : "hello world"}}'
 # Optional: filterExpression
 filterExpression: 'filterField = :filterValue'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}, ":filterValue" : {"S" : "hello world"}}'
 # Optional: filterExpression
 filterExpression: 'filterField = :filterValue'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional: indexName
 indexName: ""
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}, ":filterValue" : {"S" : "hello world"}}'
 # Optional: filterExpression
 filterExpression: 'filterField = :filterValue'
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Required: tableName
 tableName: myTableName
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Required: tableName
 tableName: myTableName
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the AWS DynamoDB scaler. This scaler uses a specified DynamoDB query to determine if and when to scale a given workload.

triggers:
- type: aws-dynamodb
 metadata:
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Required: targetValue
 targetValue: "1"
 # Required: expressionAttributeNames
 expressionAttributeNames: '{ "#k" : "partition_key_name"}'
 # Required: keyConditionExpression
 keyConditionExpression: "#k = :key"
 # Required: expressionAttributeValues
 expressionAttributeValues: '{ ":key" : {"S":"partition_key_target_value"}}'
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks and aws-kiam authentications)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks and aws-kiam authentications)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS DynamoDB Streams

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-dynamodb-streams trigger that scales based on the shard count of AWS DynamoDB Streams.

triggers:
- type: aws-dynamodb-streams
 metadata:
 # Required: awsRegion
 awsRegion: "ap-northeast-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Required: tableName
 tableName: myTableName
 # Optional targetValue
 shardCount: "2"
 # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

awsRegion - AWS Region for the DynamoDB.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
tableName - The target DynamoDB table to which the stream belongs.
shardCount - The target value that a DynamoDB streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
identityOwner - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

⚠️ WARNING: aws-eks auth has been deprecated and support for it will be removed from KEDA on v3. We strongly encourage the migration to aws auth.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS EKS Pod Identity Webhook

Mon, 01 Jan 0001 00:00:00 +0000

EKS Pod Identity Webhook, which is described more in depth here, allows you to provide the role name using an annotation on a service account associated with your pod.

You can tell KEDA to use EKS Pod Identity Webhook via podIdentity.provider.

podIdentity:
 provider: aws-eks # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

⚠️ WARNING: aws-kiam auth has been deprecated given AWS KIAM is no longer maintained. As a result, support for it will be removed from KEDA on v2.15. We strongly encourage the migration to aws auth.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

⚠️ WARNING: aws-kiam auth has been deprecated given AWS KIAM is no longer maintained. As a result, support for it will be removed from KEDA on v2.15. We strongly encourage the migration to aws auth.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kiam Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Kiam lets you bind an AWS IAM Role to a pod using an annotation on the pod.

You can tell KEDA to use Kiam via podIdentity.provider.

podIdentity:
 provider: aws-kiam # Optional. Default: none

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks and aws-kiam authentications)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks and aws-kiam authentications)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version 3, Values: pod, operator, Default: pod, Optional, This field only applies for aws-eks authentication)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Kinesis Stream

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-kinesis-stream trigger that scales based on the shard count of AWS Kinesis Stream.

triggers:
- type: aws-kinesis-stream
 metadata:
 # Required
 streamName: myKinesisStream
 # Required
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # Optional: Default: 2
 shardCount: "2"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

streamName - Name of AWS Kinesis Stream.
shardCount - The target value that a Kinesis data streams consumer can handle. (Default: 2, Optional)
activationShardCount - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
awsRegion - AWS Region for the Kinesis Stream.
awsEndpoint - Endpoint URL to override the default AWS endpoint. (Default: "", Optional)
identityOwner - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS Secret Manager

Mon, 01 Jan 0001 00:00:00 +0000

You can integrate AWS Secret Manager secrets into your trigger by configuring the awsSecretManager key in your KEDA scaling specification.

The podIdentity section configures the usage of AWS pod identity with the provider set to AWS.

The credentials section specifies AWS credentials, including the accessKey and secretAccessKey.

accessKey: Configuration for the AWS access key.
secretAccessKey: Configuration for the AWS secret access key.

The region parameter is optional and represents the AWS region where the secret resides, defaulting to the default region if not specified.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for ApproximateNumberOfMessages in the SQS Queue. (Default: 5, Optional)
awsRegion - AWS Region for the SQS Queue.
identityOwner - Receive permissions on the SQS Queue via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the SQS queue. Additional Authentication Parameters are not required.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for ApproximateNumberOfMessages in the SQS Queue. (Default: 5, Optional)
awsRegion - AWS Region for the SQS Queue.
identityOwner - Receive permissions on the SQS Queue via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the SQS queue. Additional Authentication Parameters are not required.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual ApproximateNumberOfMessages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
awsRegion - AWS Region for the SQS Queue.
identityOwner - Receive permissions on the SQS Queue via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the SQS queue. Additional Authentication Parameters are not required.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual ApproximateNumberOfMessages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
awsRegion - AWS Region for the SQS Queue.
identityOwner - Receive permissions on the SQS Queue via Pod Identity or from the KEDA operator itself (see below). (Values: pod, operator, Default: pod, Optional)

When identityOwner set to operator - the only requirement is that the KEDA operator has the correct IAM permissions on the SQS queue. Additional Authentication Parameters are not required.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity. (Optional, You can use this instead of queueURLFromEnv parameter)
queueURLFromEnv - Name of the environment variable on the scale target to read the queue URL from. (Optional, You can use this instead of queueURL parameter)
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)

For the purposes of scaling, the default formula for “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing. If you wish to only scale on ApproximateNumberOfMessages set scaleOnInFlight to false.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity. (Optional, You can use this instead of queueURLFromEnv parameter)
queueURLFromEnv - Name of the environment variable on the scale target to read the queue URL from. (Optional, You can use this instead of queueURL parameter)
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)

For the purposes of scaling, the default formula for “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing. If you wish to only scale on ApproximateNumberOfMessages set scaleOnInFlight to false.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity. (Optional, You can use this instead of queueURLFromEnv parameter)
queueURLFromEnv - Name of the environment variable on the scale target to read the queue URL from. (Optional, You can use this instead of queueURL parameter)
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)

For the purposes of scaling, the default formula for “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing. If you wish to only scale on ApproximateNumberOfMessages set scaleOnInFlight to false. You can also include the number of delayed messages when calculating “actual messages” by setting scaleOnDelayed to true. With scaleOnInFlight and scaleOnDelayed set to true the formula for “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible + ApproximateNumberOfMessagesDelayed.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)

For the purposes of scaling, “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 # DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in v3. Optional # Optional. Default: pod
 identityOwner: pod | operator

Parameter list:

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)

For the purposes of scaling, “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)

For the purposes of scaling, “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)

For the purposes of scaling, “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)

For the purposes of scaling, “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)

For the purposes of scaling, “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)

For the purposes of scaling, the default formula for “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing. If you wish to only scale on ApproximateNumberOfMessages set scaleOnInFlight to false.

AWS SQS Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the aws-sqs-queue trigger that scales based on an AWS SQS Queue.

triggers:
- type: aws-sqs-queue
 metadata:
 # Required: queueURL or queueURLFromEnv. If both provided, uses queueURL
 queueURL: https://sqs.eu-west-1.amazonaws.com/account_id/QueueName
 queueURLFromEnv: QUEUE_URL # Optional. You can use this instead of `queueURL` parameter
 queueLength: "5" # Default: "5"
 # Required: awsRegion
 awsRegion: "eu-west-1"
 # Optional: awsEndpoint
 awsEndpoint: ""
 identityOwner: pod | operator # Optional. Default: pod

Parameter list:

queueURL - Full URL for the SQS Queue. The simple name of the queue can be used in case there’s no ambiguity. (Optional, You can use this instead of queueURLFromEnv parameter)
queueURLFromEnv - Name of the environment variable on the scale target to read the queue URL from. (Optional, You can use this instead of queueURL parameter)
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual messages in the SQS Queue is 30, the scaler scales to 3 pods. (default: 5)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)

For the purposes of scaling, the default formula for “actual messages” is equal to ApproximateNumberOfMessages + ApproximateNumberOfMessagesNotVisible, since NotVisible in SQS terms means the message is still in-flight/processing. If you wish to only scale on ApproximateNumberOfMessages set scaleOnInFlight to false.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

Azure Pod Identity is an implementation of Azure AD Pod Identity which lets you bind an Azure Managed Identity to a Pod in a Kubernetes cluster as delegated access - Don’t manage secrets, let Azure AD do the hard work.

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure AD Pod Identity will give access to containers with a defined label for aadpodidbinding. You can set this label on the KEDA operator deployment. This can be done for you during deployment with Helm with --set podIdentity.activeDirectory.identity={your-label-name}.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

⚠️ WARNING: Azure AD Pod Identity was archived and support for it will be removed from KEDA on v2.15. We strongly encourage the migration to Azure Workload Identity.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

⚠️ WARNING: Azure AD Pod Identity was archived and support for it will be removed from KEDA on v2.15. We strongly encourage the migration to Azure Workload Identity.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure AD Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

Azure AD Workload Identity is the newer version of Azure AD Pod Identity. It lets your Kubernetes workloads access Azure resources using an Azure AD Application without having to specify secrets, using federated identity credentials - Don’t manage secrets, let Azure AD do the hard work.

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId From annotation on service-account.

Azure AD Workload Identity will give access to pods with service accounts having appropriate labels and annotations. Refer to these docs for more information. You can set these labels and annotations on the KEDA Operator service account. This can be done for you during deployment with Helm with the following flags -

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId From annotation on service-account.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId From annotation on service-account.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId From annotation on service-account.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

Azure AD Workload Identity is the newer version of Azure AD Pod Identity. It lets your Kubernetes workloads access Azure resources using an Azure AD Application or Azure Managed Identity without having to specify secrets, using federated identity credentials - Don’t manage secrets, let Azure AD do the hard work.

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId from annotation on service-account.
 identityTenantId: <tenant-id> # Optional. Default: TenantId from annotation on service-account.
 identityAuthorityHost: <authority-host> # Optional. Default: AZURE_AUTHORITY_HOST environment variable which is injected by azure-wi-webhook-controller-manager.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId From annotation on service-account.

Azure AD Workload Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Workload Identity via podIdentity.provider.

podIdentity:
 provider: azure-workload # Optional. Default: none
 identityId: <identity-id> # Optional. Default: ClientId From annotation on service-account.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 ignoreNullValues: true # Default is `false`. Set to `true` to ignore any errors with data extraction from a successful query. Set to `false` the scaler will return error when null values are discovered

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Application Insights

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-app-insights trigger that scales based on an Azure Application Insights metric.

triggers:
- type: azure-app-insights
 metadata:
 metricAggregationTimespan: "0:1"
 metricAggregationType: avg
 metricFilter: cloud/roleName eq 'role_name'
 metricId: "customMetrics/example-metric"
 targetValue: "1.5"
 activationTargetValue: "5.5"
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 applicationInsightsIdFromEnv: APP_ID # Optional, can use TriggerAuthentication as well
 tenantIdFromEnv: TENANT_ID` # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 appInsightsResourceURL: https://api.applicationinsights.airgap.io/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

This scaler is backed by the Azure Application Insights REST API. Please see this page for further details.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by delete/move the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob # Required: Name of Azure Blob Storage container
 blobCount: '5' # Optional. Amount of blobs to scale out on. Default: 5 blobs
 connection: STORAGE_CONNECTIONSTRING_ENV_NAME # Optional if TriggerAuthentication defined with pod identity or connection string authentication.
 blobPrefix: # Optional. Prefix for the Blob. Use this to specify sub path for the blobs if required. Default : ""
 blobDelimiter: # Optional. Delimiter for identifying the blob Prefix. Default: "/"

The connection value is the name of the environment variable your deployment uses to get the connection string. This is usually resolved from a Secret V1 or a ConfigMap V1 collections. env and envFrom are both supported.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob # Required: Name of Azure Blob Storage container
 blobCount: '5' # Optional. Amount of blobs to scale out on. Default: 5 blobs
 connection: STORAGE_CONNECTIONSTRING_ENV_NAME # Optional if TriggerAuthentication defined with pod identity or connection string authentication.
 blobPrefix: # Optional. Prefix for the Blob. Use this to specify sub path for the blobs if required. Default : ""
 blobDelimiter: # Optional. Delimiter for identifying the blob Prefix. Default: "/"

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)

Authentication Parameters

You can authenticate by using pod identity or connection string authentication.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)

You can also optionally assign a name to the metric using the metricName value. If not specified, the metricName will be generated automatically based on of the blobContainerName, blobPrefix and blobDelimiter. For example: azure-blob-functions-blob-myprefix-example. If using more than one trigger it is required that all metricName(s) be unique. The value will be prefixed with azure-blob-.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example
 cloud: Private
 endpointSuffix: blob.core.airgap.example # Required when cloud=Private

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)
cloud - Name of the cloud environment that the blob belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage blob endpoint suffix of the cloud environment that the blob belongs to, e.g. blob.core.cloudapi.de for AzureGermanCloud.

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example
 cloud: Private
 endpointSuffix: blob.core.airgap.example # Required when cloud=Private

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)
cloud - Name of the cloud environment that the blob belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example
 cloud: Private
 endpointSuffix: blob.core.airgap.example # Required when cloud=Private

Parameter list:

blobContainerName - Name of container in an Azure Storage account.
blobCount - Average target value to trigger scaling actions. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the container belongs to.
blobPrefix - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: "", Optional)
blobDelimiter - Delimiter for identifying the blob prefix. (Default: /, Optional)
cloud - Name of the cloud environment that the blob belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example
 cloud: Private
 endpointSuffix: blob.core.airgap.example # Required when cloud=Private
 recursive: false
 globPattern: glob-pattern

Parameter list:

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 activationBlobCount: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example
 cloud: Private
 endpointSuffix: blob.core.airgap.example # Required when cloud=Private
 recursive: false
 globPattern: glob-pattern

Parameter list:

Azure Blob Storage

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-blob trigger for Azure Blob Storage. It scales based on the count of blobs in a given blob storage container and assumes the worker is responsible for clearing the container by deleting/moving the blobs once the blob processing completed.

triggers:
- type: azure-blob
 metadata:
 blobContainerName: functions-blob
 blobCount: '5'
 activationBlobCount: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 blobPrefix: myprefix
 blobDelimiter: /example
 cloud: Private
 endpointSuffix: blob.core.airgap.example # Required when cloud=Private
 recursive: false
 globPattern: glob-pattern

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 clientSecret: t0p-s3cret # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 clientSecret: t0p-s3cret # DEPRECATED, use TriggerAuthentication or clientSecretFromEnv
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 clientSecret: t0p-s3cret # DEPRECATED, use TriggerAuthentication or clientSecretFromEnv
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "1000"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 clientSecret: t0p-s3cret # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 clientSecret: t0p-s3cret # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Data Explorer

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-data-explorer trigger that scales based on an Azure Data Explorer query result.

triggers:
- type: azure-data-explorer
 metadata:
 endpoint: https://keda.eastus.kusto.windows.net
 databaseName: kedadb
 query: |
 StormEvents
 | summarize StormCount = count() by State
 | top 1 by StormCount desc
 threshold: "10.5"
 activationThreshold: "10.5"
 tenantId: 045ef409-6dee-4893-a824-5612eac467b1 # Can use TriggerAuthentication as well
 clientId: 4ba039f1-d69c-434e-9268-4a2bb7bba90d # Can use TriggerAuthentication as well
 clientSecret: t0p-s3cret # Can use TriggerAuthentication as well
 # Alternatively, you can use existing environment variables to read aad app creds from:
 clientIdFromEnv: AAD_APP_CLIENT_ID_ENV_VAR_NAME # Optional. You can use this instead of `clientId` parameter.
 clientSecretFromEnv: AAD_APP_SECRET_ENV_VAR_NAME # Optional. You can use this instead of `clientSecret` parameter.
 tenantIdFromEnv: AAD_APP_TENANT_ID_ENV_VAR_NAME # Optional. You can use this instead of `tenantId` parameter.
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connection: EVENTHUB_CONNECTIONSTRING_ENV_NAME # Connection string for Event Hub namespace appended with "EntityPath=<event_hub_name>"
 storageConnection: STORAGE_CONNECTIONSTRING_ENV_NAME # Connection string for account used to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
 consumerGroup: $Default # Optional. Consumer group of event hub consumer. Default: $Default
 unprocessedEventThreshold: '64' # Optional. Target number of unprocessed events across all partitions in Event Hub for HPA. Default: 64 events.
 blobContainer: 'name_of_container' # Optional. Container name to store checkpoint. This is needed when a using an Event Hub application written in dotnet or java, and not an Azure function.

The connection value is the name of the environment variable your deployment uses to get the Event Hub connection string which is appended with the Event Hub name using Entity Path variable. storageConnection is the name of the environment variable your deployment uses to get the Storage connection string.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connection: EVENTHUB_CONNECTIONSTRING_ENV_NAME # Connection string for Event Hub namespace appended with "EntityPath=<event_hub_name>"
 storageConnection: STORAGE_CONNECTIONSTRING_ENV_NAME # Connection string for account used to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
 consumerGroup: $Default # Optional. Consumer group of event hub consumer. Default: $Default
 unprocessedEventThreshold: '64' # Optional. Target number of unprocessed events across all partitions in Event Hub for HPA. Default: 64 events.
 blobContainer: 'name_of_container' # Optional. Container name to store checkpoint. This is needed when a using an Event Hub application written in dotnet or java, and not an Azure function.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of event hub consumer. (Default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed when a using an Event Hub application written in dotnet or java, and not an Azure function.

💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of event hub consumer. (Default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed when a using an Event Hub application written in dotnet or java, and not an Azure function.

💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of event hub consumer. (Default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed when a using an Event Hub application written in dotnet or java, and not an Azure function.

💡 The Azure Storage connection string is not compatible with connection string created from a Shared Access Signature.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>. If the connection string does not end with EntityPath=<event_hub_name>, then the parameters eventHubName / eventHubNameFromEnv must be used to provide the name of the Event Hub.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage. (Only required when not using pod identity)
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
eventHubNamespace - Name of the Event Hub namespace which has the Event Hub. (Optional)
eventHubNamespaceFromEnv - Name of the environment variable that provides the name of the Event Hub namespace, which has the Event Hub. (Optional)
eventHubName - Name of the Event Hub containing the messages. (Optional)
eventHubNameFromEnv - Name of the environment variable that provides the name of the Event Hub, containing the messages. (Optional)
storageAccountName - Account name for blob storage used for checkpoints. (Required when storageConnectionFromEnv is not specified. The storage account name is the first part in the hostname of a Blob Storage endpoint. E.g.: for examplename.blob.core.windows.net the account name is examplename.)
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing.
- dapr - Suitable for older Dapr pubsub and bindings
  - Compatible Dapr versions:
    - pubsub components: 1.6, 1.7, 1.8, 1.9
    - bindings: 1.9
  - For newer Dapr versions, use the blobMetadata strategy.
  - For older Dapr versions, use the goSdk strategy.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
storageEndpointSuffix - Blob Storage endpoint of the cloud environment. (Required when cloud is set to Private, e.g. airgap.example. Do not include the blob part of the endpoint.)

When using pod identity, Microsoft Entra ID endpoint is recovered via AZURE_AUTHORITY_HOST env var provided by https://azure.github.io/azure-workload-identity/docs/installation/mutating-admission-webhook.html

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (default: "")
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.

💡 Learn more about the checkpointing behaviour in this section.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (default: "")
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.

💡 Learn more about the checkpointing behaviour in this section.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (default: "")
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.

💡 Learn more about the checkpointing behaviour in this section.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (default: "")
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.

💡 Learn more about the checkpointing behaviour in this section.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
activeDirectoryEndpoint - Active Directory endpoint of the cloud environment. (Required when cloud is set to Private, e.g. https://login.microsoftonline.de/ for AzureGermanCloud).
eventHubResourceURL - Event Hub resource URL of the cloud environment. (Required when cloud is set to Private, e.g. https://eventhubs.azure.net/ for known Azure Clouds).

💡 Learn more about the checkpointing behaviour in this section.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/

Parameter list:

connectionFromEnv - Name of the environment variable your deployment uses to get the connection string appended with EntityPath=<event_hub_name>.
storageConnectionFromEnv - Name of the environment variable that provides connection string for Azure Storage Account to store checkpoint. As of now the Event Hub scaler only reads from Azure Blob Storage.
consumerGroup - Consumer group of Azure Event Hub consumer. (default: $default, Optional)
unprocessedEventThreshold - Average target value to trigger scaling actions. (Default: 64, Optional)
activationUnprocessedEventThreshold - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
blobContainer - Container name to store checkpoint. This is needed for every checkpointStrategy except of AzureFunction. With Azure Functions the blobContainer is autogenerated and cannot be overridden.
checkpointStrategy - configure the checkpoint behaviour of different Event Hub SDKs. (Values: azureFunction, blobMetadata, goSdk, default: "", Optional)
- azureFunction - Suitable for Azure Functions & Azure WebJobs SDK. This is the default setting, when blobcontainer is not specified.
- blobMetadata - For all implementations that store checkpoint information on blob metadata such as current C#, Python, Java and JavaScript Event Hub SDKs.
- goSdk - For all implementations using the Golang SDK’s checkpointing, for example Dapr.
- When no checkpoint strategy is specified, the Event Hub scaler will use backwards compatibility and able to scale older implementations of C#, Python or Java Event Hub SDKs. (see “Legacy checkpointing”). If this behaviour should be used, blobContainer is also required.
cloud - Name of the cloud environment that the Event Hub belongs to. (Values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private, Default: AzurePublicCloud, Optional)
endpointSuffix - Service Bus endpoint suffix of the cloud environment. (Required when cloud is set to Private, e.g. servicebus.cloudapi.de for AzureGermanCloud).
activeDirectoryEndpoint - Active Directory endpoint of the cloud environment. (Required when cloud is set to Private, e.g. https://login.microsoftonline.de/ for AzureGermanCloud).
eventHubResourceURL - Event Hub resource URL of the cloud environment. (Required when cloud is set to Private, e.g. https://eventhubs.azure.net/ for known Azure Clouds).

💡 Learn more about the checkpointing behaviour in this section.

Azure Event Hubs

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-eventhub trigger for Azure Event Hubs.

triggers:
- type: azure-eventhub
 metadata:
 connectionFromEnv: EVENTHUB_CONNECTIONSTRING_ENV_NAME
 storageConnectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 consumerGroup: $Default
 unprocessedEventThreshold: '64'
 activationUnprocessedEventThreshold: '10'
 blobContainer: 'name_of_container'
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 endpointSuffix: servicebus.airgap.example
 # Required when cloud = Private
 storageEndpointSuffix: airgap.example
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/
 # Required when cloud = Private.
 eventHubResourceURL: https://eventhubs.airgap.example/
 # Required when using pod identity authentication with blob storage
 storageAccountName: 'name_of_account'

Parameter list:

Azure Key Vault secret

Mon, 01 Jan 0001 00:00:00 +0000

Mon, 01 Jan 0001 00:00:00 +0000

You can pull secrets from Azure Key Vault into the trigger by using the azureKeyVault key.

The secrets list defines the mapping between the key vault secret and the authentication parameter.

Currently pod identity providers are not supported for key vault.

You need to register an application with Azure Active Directory and specify its credentials. The clientId and tenantId for the application are to be provided as part of the spec. The clientSecret for the application is expected to be within a kubernetes secret in the same namespace as the authentication resource.

Azure Key Vault secret

Mon, 01 Jan 0001 00:00:00 +0000

You can pull secrets from Azure Key Vault into the trigger by using the azureKeyVault key.

The secrets list defines the mapping between the key vault secret and the authentication parameter.

Currently pod identity providers are not supported for key vault.

Azure Key Vault secret

Mon, 01 Jan 0001 00:00:00 +0000

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: CLIENT_ID_ENV_NAME
 activeDirectoryClientPassword: CLIENT_PASSWORD_ENV_NAME

Parameter list:

resourceURI - Shortened URI to the Azure resource. The format is "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Tenant id for the Azure resource. Used for authentication.
subscriptionId - Subscription id for the Azure resource. Used for determining the full resource URI.
resourceGroupName - Resource group for the Azure resource.
metricName - Name of the Azure Monitor metric. Must be an officially supported metric found in the official documentation.
metricFilter - Filter to define a more specific part of the resource. You can filter by supported dimensions of the metric found in the official documentation. (Optional)
metricAggregationInterval - Aggregation interval of the metric. Reported in the format "mm:hh:ss". (Default: "0:5:0", Optional)
metricAggregationType - Aggregation method of the Azure monitor metric. Some possible values include Average, Total, Maximum with a full list in the official documentation. No default.
targetValue - Target value for the Azure metric to use in the HPA.
activeDirectoryClientId - Name of the environment variable that contains the active directory client id. Should have the RBAC role of Monitoring Reader.
activeDirectoryClientPassword - Name of the environment variable that contains the active directory client password. Should have the RBAC role of Monitoring Reader.

Authentication Parameters

You can use TriggerAuthentication CRD to configure the authentication by providing a set of Azure Active Directory credentials.

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: CLIENT_ID_ENV_NAME
 activeDirectoryClientPassword: CLIENT_PASSWORD_ENV_NAME

Parameter list:

resourceURI - Shortened URI to the Azure resource. The format is "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Tenant id for the Azure resource. Used for authentication.
subscriptionId - Subscription id for the Azure resource. Used for determining the full resource URI.
resourceGroupName - Resource group for the Azure resource.
metricName - Name of the Azure Monitor metric. Must be an officially supported metric found in the official documentation.
metricFilter - Filter to define a more specific part of the resource. You can filter by supported dimensions of the metric found in the official documentation. (Optional)
metricAggregationInterval - Aggregation interval of the metric. Reported in the format "mm:hh:ss". (Default: "0:5:0", Optional)
metricAggregationType - Aggregation method of the Azure monitor metric. Some possible values include Average, Total, Maximum with a full list in the official documentation. No default.
targetValue - Target value for the Azure metric to use in the HPA.
activeDirectoryClientId - Name of the environment variable that contains the active directory client id. Should have the RBAC role of Monitoring Reader.
activeDirectoryClientPassword - Name of the environment variable that contains the active directory client password. Should have the RBAC role of Monitoring Reader.

Authentication Parameters

You can use TriggerAuthentication CRD to configure the authentication by providing a set of Azure Active Directory credentials.

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric which can be found in the official documentation.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Optionsinclude Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (optional)
metricAggregationInterval - Collection time of the metric in format "mm:hh:ss" (default: "0:5:0" which is 5 minutes)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. Optional. Required when TriggerAuthentication is not provided.
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric which can be found in the official documentation.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Optionsinclude Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (Optional)
metricAggregationInterval - Collection time of the metric in format "hh:mm:ss" (Default: "0:5:0", Optional)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. (Optional)
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric which can be found in the official documentation.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Optionsinclude Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (Optional)
metricAggregationInterval - Collection time of the metric in format "hh:mm:ss" (Default: "0:5:0", Optional)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. (Optional)
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric which can be found in the official documentation.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Optionsinclude Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (Optional)
metricAggregationInterval - Collection time of the metric in format "hh:mm:ss" (Default: "0:5:0", Optional)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. (Optional)
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric to query.
- Azure metrics are available as a list in the official documentation.
- Custom metric name when querying Azure Monitor custom metrics.
metricNamespace - Name of the metric namespace. Required when metricName is a custom metric.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Options include Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (Optional)
metricAggregationInterval - Collection time of the metric in format "hh:mm:ss" (Default: "0:5:0", Optional)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. (Optional)
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric to query.
- Azure metrics are available as a list in the official documentation.
- Custom metric name when querying Azure Monitor custom metrics.
metricNamespace - Name of the metric namespace. Required when metricName is a custom metric.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Options include Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (Optional)
metricAggregationInterval - Collection time of the metric in format "hh:mm:ss" (Default: "0:5:0", Optional)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. (Optional)
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well

Parameter list:

resourceURI - Shortened URI to the Azure resource with format "<resourceProviderNamespace>/<resourceType>/<resourceName>".
tenantId - Id of the tenant that contains the Azure resource. This is used for authentication.
subscriptionId - Id of Azure subscription that contains the Azure resource. This is used for determining the full resource URI.
resourceGroupName - Name of the resource group for the Azure resource.
metricName - Name of the metric to query.
- Azure metrics are available as a list in the official documentation.
- Custom metric name when querying Azure Monitor custom metrics.
metricNamespace - Name of the metric namespace. Required when metricName is a custom metric.
targetValue - Target value to trigger scaling actions.
metricAggregationType - Aggregation method of the Azure Monitor metric. Options include Average, Total, Maximum with a full list in the official documentation.
metricFilter - Name of the filter to be more specific by using dimensions listed in the official documentation. (Optional)
metricAggregationInterval - Collection time of the metric in format "hh:mm:ss" (Default: "0:5:0", Optional)
activeDirectoryClientId - Id of the Active Directory application which requires at least Monitoring Reader permissions. (Optional)
activeDirectoryClientPasswordFromEnv - Name of the environment variable that contains the active directory client password. (Optional)

Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "1"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Monitor

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-monitor trigger that scales based on an Azure Monitor metric.

triggers:
- type: azure-monitor
 metadata:
 resourceURI: Microsoft.ContainerService/managedClusters/azureMonitorCluster
 tenantId: xxx-xxx-xxx-xxx-xxx
 subscriptionId: yyy-yyy-yyy-yyy-yyy
 resourceGroupName: azureMonitor
 metricName: kube_pod_status_ready
 metricFilter: namespace eq 'default'
 metricAggregationInterval: "0:1:0"
 targetValue: "0.5"
 activationTargetValue: "3.5"
 activeDirectoryClientId: <client id value> # Optional, can use TriggerAuthentication as well
 activeDirectoryClientIdFromEnv: CLIENT_ID_ENV_NAME # Optional, can use TriggerAuthentication as well
 activeDirectoryClientPasswordFromEnv: CLIENT_PASSWORD_ENV_NAME # Optional, can use TriggerAuthentication as well
 # Optional (Default: AzurePublicCloud)
 cloud: Private
 # Required when cloud = Private
 azureResourceManagerEndpoint: https://management.azure.airgap.com/
 # Required when cloud = Private.
 activeDirectoryEndpoint: https://login.airgap.example/

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false 
 # Optional: Require jobs to include specified demands, ignoring any extra ones
 requireAllDemandsAndIgnoreOthers: false
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false
 # Optional: Require jobs to include specified demands, ignoring any extra ones
 requireAllDemandsAndIgnoreOthers: false
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 # Optional: Whether to only fetch unfinished jobs from the API (default: false)
 fetchUnfinishedJobsOnly: false
 # Optional: Property to enable case-insensitive comparison of pipeline job demands (default: false)
 caseInsensitiveDemandsProcessing: false
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false
 # Optional: Require jobs to include specified demands, ignoring any extra ones
 requireAllDemandsAndIgnoreOthers: false
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 # Optional: Whether to only fetch unfinished jobs from the API (default: false)
 fetchUnfinishedJobsOnly: false
 # Optional: Property to enable case-insensitive comparison of pipeline job demands (default: false)
 caseInsensitiveDemandsProcessing: false
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false
 # Optional: Require jobs to include specified demands, ignoring any extra ones
 requireAllDemandsAndIgnoreOthers: false
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 # Optional: Whether to only fetch unfinished jobs from the API (default: false)
 fetchUnfinishedJobsOnly: false
 # Optional: Property to enable case-insensitive comparison of pipeline job demands (default: false)
 caseInsensitiveDemandsProcessing: false
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 # Optional: Demands of jobs must exactly match the capabilities the trigger defines
 requireAllDemands: false
 # Optional: Require jobs to include specified demands, ignoring any extra ones
 requireAllDemandsAndIgnoreOthers: false
 # Optional: How many jobs to fetch for the pool in the API (default: 250)
 jobsToFetch: "{jobsToFetch}"
 # Optional: Whether to only fetch unfinished jobs from the API (default: false)
 fetchUnfinishedJobsOnly: false
 # Optional: Property to enable case-insensitive comparison of pipeline job demands (default: false)
 caseInsensitiveDemandsProcessing: false
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Required - Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Required - Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Required - Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pipelines

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-pipelines trigger for Azure Pipelines. It scales based on the amount of pipeline runs pending in a given agent pool.

triggers:
 - type: azure-pipelines
 metadata:
 # Optional: Name of the pool in Azure DevOps
 poolName: "{agentPoolName}"
 # Optional: Learn more in 'How to determine your pool ID'
 poolID: "{agentPoolId}"
 # Optional: Azure DevOps organization URL, can use TriggerAuthentication as well
 organizationURLFromEnv: "AZP_URL"
 # Optional: Azure DevOps Personal Access Token, can use TriggerAuthentication as well
 personalAccessTokenFromEnv: "AZP_TOKEN"
 # Optional: Target queue length
 targetPipelinesQueueLength: "1" # Default 1
 activationTargetPipelinesQueueLength: "5" # Default 0
 # Optional: Parent template to read demands from
 parent: "{parent ADO agent name}"
 # Optional: Demands string to read demands from ScaledObject
 demands: "{demands}"
 authenticationRef:
 name: pipeline-trigger-auth

Parameter list:

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Pod Identity

Mon, 01 Jan 0001 00:00:00 +0000

You can tell KEDA to use Azure AD Pod Identity via podIdentity.provider.

podIdentity:
 provider: azure # Optional. Default: none
 identityId: <identity-id> # Optional. Default: Identity linked with the label set when installing KEDA.

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connection: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 queueLength: "5" # Optional. Subscription length target for HPA. Default: 5 messages

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connection: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 queueLength: "5" # Optional. Subscription length target for HPA. Default: 5 messages

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME # This must be a connection string for a queue itself, and not a namespace level (e.g. RootAccessPolicy) connection string [#215](https://github.com/kedacore/keda/issues/215)
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Service Bus

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-servicebus trigger for Azure Service Bus Queue or Topic.

⚠️ WARNING: KEDA is not in charge of managing entities. If the queue, topic or subscription does not exist, it will not create them automatically.

triggers:
- type: azure-servicebus
 metadata:
 # Required: queueName OR topicName and subscriptionName
 queueName: functions-sbqueue
 # or
 topicName: functions-sbtopic
 subscriptionName: sbtopic-sub1
 # Optional, required when pod identity is used
 namespace: service-bus-namespace
 # Optional, can use TriggerAuthentication as well
 connectionFromEnv: SERVICEBUS_CONNECTIONSTRING_ENV_NAME
 # Optional
 messageCount: "5" # Optional. Count of messages to trigger scaling on. Default: 5 messages
 activationMessageCount: "2"
 cloud: Private # Optional. Default: AzurePublicCloud
 endpointSuffix: servicebus.airgap.example # Required when cloud=Private

Parameter list:

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: functionsqueue
 queueLength: '5' # Optional. Queue length target for HPA. Default: 5 messages
 connection: STORAGE_CONNECTIONSTRING_ENV_NAME

Authentication Parameters

You can authenticate by using pod identity or connection string authentication.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: functionsqueue
 queueLength: '5' # Optional. Queue length target for HPA. Default: 5 messages
 connection: STORAGE_CONNECTIONSTRING_ENV_NAME

Authentication Parameters

You can authenticate by using pod identity or connection string authentication.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.

Authentication Parameters

You can authenticate by using pod identity or connection string authentication.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.

Authentication Parameters

You can authenticate by using pod identity or connection string authentication.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.

Authentication Parameters

You can authenticate by using pod identity or connection string authentication.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

Azure Storage Queue

Mon, 01 Jan 0001 00:00:00 +0000

Trigger Specification

This specification describes the azure-queue trigger for Azure Storage Queue.

triggers:
- type: azure-queue
 metadata:
 queueName: orders
 queueLength: '5'
 queueLengthStrategy: all|visibleonly
 activationQueueLength: '50'
 connectionFromEnv: STORAGE_CONNECTIONSTRING_ENV_NAME
 accountName: storage-account-name
 cloud: AzureUSGovernmentCloud

Parameter list:

queueName - Name of the queue.
queueLength - Target value for queue length passed to the scaler. Example: if one pod can handle 10 messages, set the queue length target to 10. If the actual number of messages in the queue is 30, the scaler scales to 3 pods. (Default: 5, Optional)
queueLengthStrategy - all considers both visible and invisible messages, while visibleonly uses Peek to count only visible messages. In visibleonly, if the count of messages is 32 or higher, it falls back to the default all strategy, counting both visible and invisible messages. (Default: all, Optional)
activationQueueLength - Target value for activating the scaler. Learn more about activation here. (Default: 0, Optional)
connectionFromEnv - Name of the environment variable your deployment uses to get the connection string.
accountName - Name of the storage account that the queue belongs to.
cloud - Name of the cloud environment that the queue belongs to. Must be a known Azure cloud environment, or Private for Azure Stack Hub or Air Gapped clouds. (valid values: AzurePublicCloud, AzureUSGovernmentCloud, AzureChinaCloud, AzureGermanCloud, Private; default: AzurePublicCloud)

When cloud is set to Private, the endpointSuffix parameter is required. Otherwise, it is automatically generated based on the cloud environment. endpointSuffix represents the storage queue endpoint suffix of the cloud environment that the queue belongs to, e.g. queue.core.windows.net for AzurePublicCloud.

KEDA

Install the HTTP Add-on

Prerequisites

Install

Install the HTTP Add-on

Prerequisites

Install

Install the HTTP Add-on

Prerequisites

Install

Kubernetes Control plane is unable to communicate to Metric server?

Before you start

Check the status:

Why is Kubernetes unable to get metrics from KEDA?

Before you start

Check the status

Why is my `ScaledObject` paused?

Context Deadline Exceeded when `kubectl apply`?

Root cause

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

Admission Webhooks

Validation Enforcement

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

CloudEvent Support

Subscribing to events with CloudEventSource

Cluster

Requirements

Kubernetes

Cluster Capacity

Cluster

Requirements

Kubernetes

Cluster Capacity

Cluster

Requirements

Kubernetes Compatibility

Cluster

Requirements

Kubernetes Compatibility

Cluster

Requirements

Kubernetes Compatibility

Cluster

Requirements

Kubernetes Compatibility

Cluster

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`

Subscribing to events with `CloudEventSource`