From 9691cdaa439cd7ffb9e6622f559dae564a1abfed Mon Sep 17 00:00:00 2001 From: Ty Brown Date: Fri, 12 Mar 2021 16:45:23 -0600 Subject: [PATCH] AWS SQS Scaler: Document additions of NotVisible messages in scaling calculations Signed-off-by: Ty Brown --- content/docs/2.2/scalers/aws-sqs.md | 9 ++++++--- 1 file changed, 6 insertions(+), 3 deletions(-) diff --git a/content/docs/2.2/scalers/aws-sqs.md b/content/docs/2.2/scalers/aws-sqs.md index 9b0412002..b52f77ead 100644 --- a/content/docs/2.2/scalers/aws-sqs.md +++ b/content/docs/2.2/scalers/aws-sqs.md @@ -26,7 +26,10 @@ triggers: **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) +- `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` + `ApproximateNumberOfMessagesNotVislble`, since `NotVisible` in SQS terms means the message is still in-flight/processing. + - `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). @@ -34,7 +37,7 @@ triggers: ### Authentication Parameters -> These parameters are relevant only when `identityOwner` is set to `pod`. +> These parameters are relevant only when `identityOwner` is set to `pod`. You can use `TriggerAuthentication` CRD to configure the authenticate by providing either a role ARN or a set of IAM credentials. @@ -63,7 +66,7 @@ metadata: data: AWS_ACCESS_KEY_ID: AWS_SECRET_ACCESS_KEY: ---- +--- apiVersion: keda.sh/v1alpha1 kind: TriggerAuthentication metadata: