Warning
You are currently viewing v"2.8" of the documentation and it is not the latest. For the most recent documentation, kindly click here.
Trigger Specification
This specification describes the nats-jetstream trigger for NATS JetStream.
triggers:
- type: nats-jetstream
metadata:
natsServerMonitoringEndpoint: "nats.nats.svc.cluster.local:8222"
account: "$G"
stream: "mystream"
consumer: "pull_consumer"
lagThreshold: "10"
activationLagThreshold: "15"
Parameter list:
natsServerMonitoringEndpoint- Location of the NATS server monitoring endpoint.account- Name of the NATS account. “$G” is default when no account is configured.stream- Name of the JS stream within the account.consumer- Name of the consumer for a given stream.lagThreshold- Average target value to trigger scaling actions.activationLagThreshold- Target value for activating the scaler. Learn more about activation here. (Default:0, Optional)
Authentication Parameters
Not supported yet.
Example
apiVersion: keda.sh/v1alpha1
kind: ScaledObject
metadata:
name: nats-jetstream-scaledobject
namespace: nats-jetstream
spec:
pollingInterval: 3 # Optional. Default: 30 seconds
cooldownPeriod: 10 # Optional. Default: 300 seconds
minReplicaCount: 0 # Optional. Default: 0
maxReplicaCount: 2 # Optional. Default: 100
scaleTargetRef:
name: sub
triggers:
- type: nats-jetstream
metadata:
natsServerMonitoringEndpoint: "nats.nats.svc.cluster.local:8222"
account: "$G"
stream: "mystream"
consumer: "pull_consumer"
lagThreshold: "10"
activationLagThreshold: "15"