diff --git a/content/docs/2.10/scalers/activemq.md b/content/docs/2.10/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.10/scalers/activemq.md +++ b/content/docs/2.10/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.10/scalers/apache-kafka.md b/content/docs/2.10/scalers/apache-kafka.md index c217e8471..af6bb2ba8 100644 --- a/content/docs/2.10/scalers/apache-kafka.md +++ b/content/docs/2.10/scalers/apache-kafka.md @@ -44,7 +44,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.10/scalers/arangodb.md b/content/docs/2.10/scalers/arangodb.md index 67f13dc7f..042e2efd5 100644 --- a/content/docs/2.10/scalers/arangodb.md +++ b/content/docs/2.10/scalers/arangodb.md @@ -33,7 +33,7 @@ triggers: - `dbName` - Name of the database. It can also be provided as an authentication parameter. - `collection` - Name of the collection. - `threshold` - A threshold that will define when scaling should occur. -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `serverID` - The unique ArangoDB server ID. Only required if bearer JWT is being used. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional) - `connectionLimit` - Specify the max size of the active connection pool. (Optional) diff --git a/content/docs/2.10/scalers/artemis.md b/content/docs/2.10/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.10/scalers/artemis.md +++ b/content/docs/2.10/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.10/scalers/aws-dynamodb-streams.md b/content/docs/2.10/scalers/aws-dynamodb-streams.md index 31f12013d..cf2f79c4e 100644 --- a/content/docs/2.10/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.10/scalers/aws-dynamodb-streams.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.10/scalers/aws-dynamodb.md b/content/docs/2.10/scalers/aws-dynamodb.md index c059327d1..535bd7b71 100644 --- a/content/docs/2.10/scalers/aws-dynamodb.md +++ b/content/docs/2.10/scalers/aws-dynamodb.md @@ -38,7 +38,7 @@ triggers: - `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional) - `tableName` - The target table where the scaler execute the query. - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.10/scalers/aws-kinesis.md b/content/docs/2.10/scalers/aws-kinesis.md index b5185abbc..a27a00cfc 100644 --- a/content/docs/2.10/scalers/aws-kinesis.md +++ b/content/docs/2.10/scalers/aws-kinesis.md @@ -29,7 +29,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.10/scalers/aws-sqs.md b/content/docs/2.10/scalers/aws-sqs.md index 75e968276..99c5d01b9 100644 --- a/content/docs/2.10/scalers/aws-sqs.md +++ b/content/docs/2.10/scalers/aws-sqs.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.10/scalers/azure-event-hub.md b/content/docs/2.10/scalers/azure-event-hub.md index e3da149a5..e19858754 100644 --- a/content/docs/2.10/scalers/azure-event-hub.md +++ b/content/docs/2.10/scalers/azure-event-hub.md @@ -40,7 +40,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.10/scalers/azure-pipelines.md b/content/docs/2.10/scalers/azure-pipelines.md index 151bf8e21..a8da05ed4 100644 --- a/content/docs/2.10/scalers/azure-pipelines.md +++ b/content/docs/2.10/scalers/azure-pipelines.md @@ -45,7 +45,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` - `jobsToFetch` - The number of the jobs that KEDA will fetch for the pool from Azure Pipeline API (Default: `250`, Optional) diff --git a/content/docs/2.10/scalers/azure-service-bus.md b/content/docs/2.10/scalers/azure-service-bus.md index ae14d0791..ae83166a6 100644 --- a/content/docs/2.10/scalers/azure-service-bus.md +++ b/content/docs/2.10/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.10/scalers/azure-storage-blob.md b/content/docs/2.10/scalers/azure-storage-blob.md index 674e234b6..a45c61bbd 100644 --- a/content/docs/2.10/scalers/azure-storage-blob.md +++ b/content/docs/2.10/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.10/scalers/azure-storage-queue.md b/content/docs/2.10/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.10/scalers/azure-storage-queue.md +++ b/content/docs/2.10/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.10/scalers/cassandra.md b/content/docs/2.10/scalers/cassandra.md index 8074bf7b8..82f572c91 100644 --- a/content/docs/2.10/scalers/cassandra.md +++ b/content/docs/2.10/scalers/cassandra.md @@ -36,7 +36,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `metricName` - Name to assign to the metric. (DEPRECATED: This parameter is deprecated as of KEDA v2.10 and will be removed in version `2.12`. Default: `s-cassandra-`, Optional, In case of `metricName` is specified, it will be used to generate the `metricName` like this: `s-cassandra-`, where `` is the index of the trigger in a ScaledObject) ### Authentication Parameters diff --git a/content/docs/2.10/scalers/couchdb.md b/content/docs/2.10/scalers/couchdb.md index 667a95bbe..eb8e39a3d 100644 --- a/content/docs/2.10/scalers/couchdb.md +++ b/content/docs/2.10/scalers/couchdb.md @@ -30,7 +30,7 @@ triggers: - `queryValue` - A threshold that will define when scaling should occur. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `port` - The port number of the CouchDB service. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `query` - A CouchDB query that should return single numeric value. (Optional) -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `connectionStringFromEnv` - Environment variable from workload with the connection string. (Optional, Required if `connectionString` and connection parameters aren't set) ### Authentication Parameters diff --git a/content/docs/2.10/scalers/gcp-storage.md b/content/docs/2.10/scalers/gcp-storage.md index eb9b6ecef..a4a0ccc03 100644 --- a/content/docs/2.10/scalers/gcp-storage.md +++ b/content/docs/2.10/scalers/gcp-storage.md @@ -28,7 +28,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) - `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) diff --git a/content/docs/2.10/scalers/ibm-mq.md b/content/docs/2.10/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.10/scalers/ibm-mq.md +++ b/content/docs/2.10/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.10/scalers/liiklus-topic.md b/content/docs/2.10/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.10/scalers/liiklus-topic.md +++ b/content/docs/2.10/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.10/scalers/mongodb.md b/content/docs/2.10/scalers/mongodb.md index 52a6f1bd9..9c4ee5093 100644 --- a/content/docs/2.10/scalers/mongodb.md +++ b/content/docs/2.10/scalers/mongodb.md @@ -68,7 +68,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.10/scalers/nats-jetstream.md b/content/docs/2.10/scalers/nats-jetstream.md index 0112dbd1f..5c34884bd 100644 --- a/content/docs/2.10/scalers/nats-jetstream.md +++ b/content/docs/2.10/scalers/nats-jetstream.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS server monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.10/scalers/nats-streaming.md b/content/docs/2.10/scalers/nats-streaming.md index 2be85d335..3a213bd5e 100644 --- a/content/docs/2.10/scalers/nats-streaming.md +++ b/content/docs/2.10/scalers/nats-streaming.md @@ -30,7 +30,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS Streaming monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.10/scalers/openstack-swift.md b/content/docs/2.10/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.10/scalers/openstack-swift.md +++ b/content/docs/2.10/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.10/scalers/pulsar.md b/content/docs/2.10/scalers/pulsar.md index b2c4f1e13..0c9d226bd 100644 --- a/content/docs/2.10/scalers/pulsar.md +++ b/content/docs/2.10/scalers/pulsar.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 diff --git a/content/docs/2.10/scalers/redis-cluster-lists.md b/content/docs/2.10/scalers/redis-cluster-lists.md index eb0fc77cb..4e720f40c 100644 --- a/content/docs/2.10/scalers/redis-cluster-lists.md +++ b/content/docs/2.10/scalers/redis-cluster-lists.md @@ -37,7 +37,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) diff --git a/content/docs/2.10/scalers/redis-lists.md b/content/docs/2.10/scalers/redis-lists.md index c736ade6b..b49774d4b 100644 --- a/content/docs/2.10/scalers/redis-lists.md +++ b/content/docs/2.10/scalers/redis-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.10/scalers/redis-sentinel-lists.md b/content/docs/2.10/scalers/redis-sentinel-lists.md index b37dfd0ab..fbdc2fd7a 100644 --- a/content/docs/2.10/scalers/redis-sentinel-lists.md +++ b/content/docs/2.10/scalers/redis-sentinel-lists.md @@ -43,7 +43,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) diff --git a/content/docs/2.10/scalers/selenium-grid-scaler.md b/content/docs/2.10/scalers/selenium-grid-scaler.md index 532169ee8..edeff1da7 100644 --- a/content/docs/2.10/scalers/selenium-grid-scaler.md +++ b/content/docs/2.10/scalers/selenium-grid-scaler.md @@ -33,7 +33,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `platformName` - Name of the browser platform. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Default: `Linux`, Optional) ### Example diff --git a/content/docs/2.10/scalers/solace-pub-sub.md b/content/docs/2.10/scalers/solace-pub-sub.md index 83df98f60..abf83add8 100644 --- a/content/docs/2.10/scalers/solace-pub-sub.md +++ b/content/docs/2.10/scalers/solace-pub-sub.md @@ -33,9 +33,9 @@ triggers: - `messageVpn` - Message VPN hosted on the Solace broker. - `queueName` - Message Queue to be monitored. - `messageCountTarget` - The target number of messages manageable by a pod. The scaler will cause the replicas to increase if the queue message backlog is greater than the target value per active replica. -- `activationMessageCountTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCountTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `messageSpoolUsageTarget` - Integer value expressed in Megabytes (MB). The target spool usage manageable by a pod. The scaler will cause the replicas to increase if the queue spool usage is greater than the target value per active replica. -- `activationMessageSpoolUsageTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageSpoolUsageTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `username` - User account with access to Solace SEMP RESTful endpoint. - `password` - Password for the user account. - `usernameFromEnv` - Environment variable set with SEMP user account. diff --git a/content/docs/2.11/scalers/activemq.md b/content/docs/2.11/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.11/scalers/activemq.md +++ b/content/docs/2.11/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.11/scalers/apache-kafka.md b/content/docs/2.11/scalers/apache-kafka.md index c29628e0b..2afa5b11c 100644 --- a/content/docs/2.11/scalers/apache-kafka.md +++ b/content/docs/2.11/scalers/apache-kafka.md @@ -44,7 +44,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.11/scalers/arangodb.md b/content/docs/2.11/scalers/arangodb.md index 67f13dc7f..042e2efd5 100644 --- a/content/docs/2.11/scalers/arangodb.md +++ b/content/docs/2.11/scalers/arangodb.md @@ -33,7 +33,7 @@ triggers: - `dbName` - Name of the database. It can also be provided as an authentication parameter. - `collection` - Name of the collection. - `threshold` - A threshold that will define when scaling should occur. -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `serverID` - The unique ArangoDB server ID. Only required if bearer JWT is being used. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional) - `connectionLimit` - Specify the max size of the active connection pool. (Optional) diff --git a/content/docs/2.11/scalers/artemis.md b/content/docs/2.11/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.11/scalers/artemis.md +++ b/content/docs/2.11/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.11/scalers/aws-dynamodb-streams.md b/content/docs/2.11/scalers/aws-dynamodb-streams.md index 31f12013d..cf2f79c4e 100644 --- a/content/docs/2.11/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.11/scalers/aws-dynamodb-streams.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.11/scalers/aws-dynamodb.md b/content/docs/2.11/scalers/aws-dynamodb.md index e7a7ceb37..a8b328be1 100644 --- a/content/docs/2.11/scalers/aws-dynamodb.md +++ b/content/docs/2.11/scalers/aws-dynamodb.md @@ -41,7 +41,7 @@ triggers: - `tableName` - The target table where the scaler execute the query. - `indexName` - The index used by the DynamoDB Query. (Optional) - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.11/scalers/aws-kinesis.md b/content/docs/2.11/scalers/aws-kinesis.md index b5185abbc..a27a00cfc 100644 --- a/content/docs/2.11/scalers/aws-kinesis.md +++ b/content/docs/2.11/scalers/aws-kinesis.md @@ -29,7 +29,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.11/scalers/aws-sqs.md b/content/docs/2.11/scalers/aws-sqs.md index 75e968276..99c5d01b9 100644 --- a/content/docs/2.11/scalers/aws-sqs.md +++ b/content/docs/2.11/scalers/aws-sqs.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.11/scalers/azure-event-hub.md b/content/docs/2.11/scalers/azure-event-hub.md index e3da149a5..e19858754 100644 --- a/content/docs/2.11/scalers/azure-event-hub.md +++ b/content/docs/2.11/scalers/azure-event-hub.md @@ -40,7 +40,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.11/scalers/azure-pipelines.md b/content/docs/2.11/scalers/azure-pipelines.md index 151bf8e21..a8da05ed4 100644 --- a/content/docs/2.11/scalers/azure-pipelines.md +++ b/content/docs/2.11/scalers/azure-pipelines.md @@ -45,7 +45,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` - `jobsToFetch` - The number of the jobs that KEDA will fetch for the pool from Azure Pipeline API (Default: `250`, Optional) diff --git a/content/docs/2.11/scalers/azure-service-bus.md b/content/docs/2.11/scalers/azure-service-bus.md index ae14d0791..ae83166a6 100644 --- a/content/docs/2.11/scalers/azure-service-bus.md +++ b/content/docs/2.11/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.11/scalers/azure-storage-blob.md b/content/docs/2.11/scalers/azure-storage-blob.md index 674e234b6..a45c61bbd 100644 --- a/content/docs/2.11/scalers/azure-storage-blob.md +++ b/content/docs/2.11/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.11/scalers/azure-storage-queue.md b/content/docs/2.11/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.11/scalers/azure-storage-queue.md +++ b/content/docs/2.11/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.11/scalers/cassandra.md b/content/docs/2.11/scalers/cassandra.md index 8074bf7b8..82f572c91 100644 --- a/content/docs/2.11/scalers/cassandra.md +++ b/content/docs/2.11/scalers/cassandra.md @@ -36,7 +36,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `metricName` - Name to assign to the metric. (DEPRECATED: This parameter is deprecated as of KEDA v2.10 and will be removed in version `2.12`. Default: `s-cassandra-`, Optional, In case of `metricName` is specified, it will be used to generate the `metricName` like this: `s-cassandra-`, where `` is the index of the trigger in a ScaledObject) ### Authentication Parameters diff --git a/content/docs/2.11/scalers/couchdb.md b/content/docs/2.11/scalers/couchdb.md index 667a95bbe..eb8e39a3d 100644 --- a/content/docs/2.11/scalers/couchdb.md +++ b/content/docs/2.11/scalers/couchdb.md @@ -30,7 +30,7 @@ triggers: - `queryValue` - A threshold that will define when scaling should occur. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `port` - The port number of the CouchDB service. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `query` - A CouchDB query that should return single numeric value. (Optional) -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `connectionStringFromEnv` - Environment variable from workload with the connection string. (Optional, Required if `connectionString` and connection parameters aren't set) ### Authentication Parameters diff --git a/content/docs/2.11/scalers/gcp-storage.md b/content/docs/2.11/scalers/gcp-storage.md index eb9b6ecef..a4a0ccc03 100644 --- a/content/docs/2.11/scalers/gcp-storage.md +++ b/content/docs/2.11/scalers/gcp-storage.md @@ -28,7 +28,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) - `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) diff --git a/content/docs/2.11/scalers/ibm-mq.md b/content/docs/2.11/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.11/scalers/ibm-mq.md +++ b/content/docs/2.11/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.11/scalers/liiklus-topic.md b/content/docs/2.11/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.11/scalers/liiklus-topic.md +++ b/content/docs/2.11/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.11/scalers/mongodb.md b/content/docs/2.11/scalers/mongodb.md index 52a6f1bd9..9c4ee5093 100644 --- a/content/docs/2.11/scalers/mongodb.md +++ b/content/docs/2.11/scalers/mongodb.md @@ -68,7 +68,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.11/scalers/nats-jetstream.md b/content/docs/2.11/scalers/nats-jetstream.md index 99d9f6a01..4cb8e812e 100644 --- a/content/docs/2.11/scalers/nats-jetstream.md +++ b/content/docs/2.11/scalers/nats-jetstream.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS server monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.11/scalers/nats-streaming.md b/content/docs/2.11/scalers/nats-streaming.md index 2be85d335..3a213bd5e 100644 --- a/content/docs/2.11/scalers/nats-streaming.md +++ b/content/docs/2.11/scalers/nats-streaming.md @@ -30,7 +30,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS Streaming monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.11/scalers/openstack-swift.md b/content/docs/2.11/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.11/scalers/openstack-swift.md +++ b/content/docs/2.11/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.11/scalers/pulsar.md b/content/docs/2.11/scalers/pulsar.md index b2c4f1e13..0c9d226bd 100644 --- a/content/docs/2.11/scalers/pulsar.md +++ b/content/docs/2.11/scalers/pulsar.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 diff --git a/content/docs/2.11/scalers/redis-cluster-lists.md b/content/docs/2.11/scalers/redis-cluster-lists.md index eb0fc77cb..4e720f40c 100644 --- a/content/docs/2.11/scalers/redis-cluster-lists.md +++ b/content/docs/2.11/scalers/redis-cluster-lists.md @@ -37,7 +37,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) diff --git a/content/docs/2.11/scalers/redis-lists.md b/content/docs/2.11/scalers/redis-lists.md index c736ade6b..b49774d4b 100644 --- a/content/docs/2.11/scalers/redis-lists.md +++ b/content/docs/2.11/scalers/redis-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.11/scalers/redis-sentinel-lists.md b/content/docs/2.11/scalers/redis-sentinel-lists.md index b37dfd0ab..fbdc2fd7a 100644 --- a/content/docs/2.11/scalers/redis-sentinel-lists.md +++ b/content/docs/2.11/scalers/redis-sentinel-lists.md @@ -43,7 +43,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) diff --git a/content/docs/2.11/scalers/selenium-grid-scaler.md b/content/docs/2.11/scalers/selenium-grid-scaler.md index 532169ee8..edeff1da7 100644 --- a/content/docs/2.11/scalers/selenium-grid-scaler.md +++ b/content/docs/2.11/scalers/selenium-grid-scaler.md @@ -33,7 +33,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `platformName` - Name of the browser platform. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Default: `Linux`, Optional) ### Example diff --git a/content/docs/2.11/scalers/solr.md b/content/docs/2.11/scalers/solr.md index 1082cd198..a4fafb7f6 100644 --- a/content/docs/2.11/scalers/solr.md +++ b/content/docs/2.11/scalers/solr.md @@ -27,7 +27,7 @@ triggers: - `query`- A Solr query that should return single numeric value. (Default: `*:*`, Optional) - `collection` - Your collection name on Solr. - `targetQueryValue` - A threshold that is used as targetValue or targetAverageValue (depending on the trigger metric type) in HPA. (This value can be a float) -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.12/scalers/activemq.md b/content/docs/2.12/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.12/scalers/activemq.md +++ b/content/docs/2.12/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.12/scalers/apache-kafka-go.md b/content/docs/2.12/scalers/apache-kafka-go.md index 93fc70130..d885a6996 100644 --- a/content/docs/2.12/scalers/apache-kafka-go.md +++ b/content/docs/2.12/scalers/apache-kafka-go.md @@ -47,7 +47,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.12/scalers/apache-kafka.md b/content/docs/2.12/scalers/apache-kafka.md index 7e12e62e5..9b50bb9b6 100644 --- a/content/docs/2.12/scalers/apache-kafka.md +++ b/content/docs/2.12/scalers/apache-kafka.md @@ -45,7 +45,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.12/scalers/arangodb.md b/content/docs/2.12/scalers/arangodb.md index 67f13dc7f..042e2efd5 100644 --- a/content/docs/2.12/scalers/arangodb.md +++ b/content/docs/2.12/scalers/arangodb.md @@ -33,7 +33,7 @@ triggers: - `dbName` - Name of the database. It can also be provided as an authentication parameter. - `collection` - Name of the collection. - `threshold` - A threshold that will define when scaling should occur. -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `serverID` - The unique ArangoDB server ID. Only required if bearer JWT is being used. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional) - `connectionLimit` - Specify the max size of the active connection pool. (Optional) diff --git a/content/docs/2.12/scalers/artemis.md b/content/docs/2.12/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.12/scalers/artemis.md +++ b/content/docs/2.12/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.12/scalers/aws-dynamodb-streams.md b/content/docs/2.12/scalers/aws-dynamodb-streams.md index 31f12013d..cf2f79c4e 100644 --- a/content/docs/2.12/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.12/scalers/aws-dynamodb-streams.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.12/scalers/aws-dynamodb.md b/content/docs/2.12/scalers/aws-dynamodb.md index e7a7ceb37..a8b328be1 100644 --- a/content/docs/2.12/scalers/aws-dynamodb.md +++ b/content/docs/2.12/scalers/aws-dynamodb.md @@ -41,7 +41,7 @@ triggers: - `tableName` - The target table where the scaler execute the query. - `indexName` - The index used by the DynamoDB Query. (Optional) - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.12/scalers/aws-kinesis.md b/content/docs/2.12/scalers/aws-kinesis.md index b5185abbc..a27a00cfc 100644 --- a/content/docs/2.12/scalers/aws-kinesis.md +++ b/content/docs/2.12/scalers/aws-kinesis.md @@ -29,7 +29,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.12/scalers/aws-sqs.md b/content/docs/2.12/scalers/aws-sqs.md index 91e187a85..f405c2e64 100644 --- a/content/docs/2.12/scalers/aws-sqs.md +++ b/content/docs/2.12/scalers/aws-sqs.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.12/scalers/azure-event-hub.md b/content/docs/2.12/scalers/azure-event-hub.md index e3da149a5..e19858754 100644 --- a/content/docs/2.12/scalers/azure-event-hub.md +++ b/content/docs/2.12/scalers/azure-event-hub.md @@ -40,7 +40,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.12/scalers/azure-pipelines.md b/content/docs/2.12/scalers/azure-pipelines.md index a678c0849..42e2a7b7e 100644 --- a/content/docs/2.12/scalers/azure-pipelines.md +++ b/content/docs/2.12/scalers/azure-pipelines.md @@ -45,7 +45,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` - `jobsToFetch` - The number of the jobs that KEDA will fetch for the pool from Azure Pipeline API (Default: `250`, Optional) diff --git a/content/docs/2.12/scalers/azure-service-bus.md b/content/docs/2.12/scalers/azure-service-bus.md index 5668b83d7..01d4ebd5a 100644 --- a/content/docs/2.12/scalers/azure-service-bus.md +++ b/content/docs/2.12/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.12/scalers/azure-storage-blob.md b/content/docs/2.12/scalers/azure-storage-blob.md index 73f75b707..70f16b950 100644 --- a/content/docs/2.12/scalers/azure-storage-blob.md +++ b/content/docs/2.12/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.12/scalers/azure-storage-queue.md b/content/docs/2.12/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.12/scalers/azure-storage-queue.md +++ b/content/docs/2.12/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.12/scalers/cassandra.md b/content/docs/2.12/scalers/cassandra.md index 9b2147493..ccf2e9e0a 100644 --- a/content/docs/2.12/scalers/cassandra.md +++ b/content/docs/2.12/scalers/cassandra.md @@ -35,7 +35,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.12/scalers/couchdb.md b/content/docs/2.12/scalers/couchdb.md index 9da7c02f2..07a868ab9 100644 --- a/content/docs/2.12/scalers/couchdb.md +++ b/content/docs/2.12/scalers/couchdb.md @@ -30,7 +30,7 @@ triggers: - `queryValue` - A threshold that will define when scaling should occur. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `port` - The port number of the CouchDB service. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `query` - A CouchDB query that should return single numeric value. (Optional) -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `connectionStringFromEnv` - Environment variable from workload with the connection string. (Optional, Required if `connectionString` and connection parameters aren't set) ### Authentication Parameters diff --git a/content/docs/2.12/scalers/gcp-storage.md b/content/docs/2.12/scalers/gcp-storage.md index eb9b6ecef..a4a0ccc03 100644 --- a/content/docs/2.12/scalers/gcp-storage.md +++ b/content/docs/2.12/scalers/gcp-storage.md @@ -28,7 +28,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) - `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) diff --git a/content/docs/2.12/scalers/ibm-mq.md b/content/docs/2.12/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.12/scalers/ibm-mq.md +++ b/content/docs/2.12/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.12/scalers/liiklus-topic.md b/content/docs/2.12/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.12/scalers/liiklus-topic.md +++ b/content/docs/2.12/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.12/scalers/mongodb.md b/content/docs/2.12/scalers/mongodb.md index 4f7916b08..b8d8869a2 100644 --- a/content/docs/2.12/scalers/mongodb.md +++ b/content/docs/2.12/scalers/mongodb.md @@ -62,7 +62,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.12/scalers/nats-jetstream.md b/content/docs/2.12/scalers/nats-jetstream.md index 99d9f6a01..4cb8e812e 100644 --- a/content/docs/2.12/scalers/nats-jetstream.md +++ b/content/docs/2.12/scalers/nats-jetstream.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS server monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.12/scalers/nats-streaming.md b/content/docs/2.12/scalers/nats-streaming.md index 2be85d335..3a213bd5e 100644 --- a/content/docs/2.12/scalers/nats-streaming.md +++ b/content/docs/2.12/scalers/nats-streaming.md @@ -30,7 +30,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS Streaming monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.12/scalers/openstack-swift.md b/content/docs/2.12/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.12/scalers/openstack-swift.md +++ b/content/docs/2.12/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.12/scalers/pulsar.md b/content/docs/2.12/scalers/pulsar.md index 98f1eec07..4455bcbb9 100644 --- a/content/docs/2.12/scalers/pulsar.md +++ b/content/docs/2.12/scalers/pulsar.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.12/scalers/redis-cluster-lists.md b/content/docs/2.12/scalers/redis-cluster-lists.md index d8e7fc095..38d1960d8 100644 --- a/content/docs/2.12/scalers/redis-cluster-lists.md +++ b/content/docs/2.12/scalers/redis-cluster-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.12/scalers/redis-lists.md b/content/docs/2.12/scalers/redis-lists.md index bca9cb7d9..45f2979fc 100644 --- a/content/docs/2.12/scalers/redis-lists.md +++ b/content/docs/2.12/scalers/redis-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.12/scalers/redis-sentinel-lists.md b/content/docs/2.12/scalers/redis-sentinel-lists.md index 0c14ca69e..852ab00d7 100644 --- a/content/docs/2.12/scalers/redis-sentinel-lists.md +++ b/content/docs/2.12/scalers/redis-sentinel-lists.md @@ -44,7 +44,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.12/scalers/selenium-grid-scaler.md b/content/docs/2.12/scalers/selenium-grid-scaler.md index 532169ee8..edeff1da7 100644 --- a/content/docs/2.12/scalers/selenium-grid-scaler.md +++ b/content/docs/2.12/scalers/selenium-grid-scaler.md @@ -33,7 +33,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `platformName` - Name of the browser platform. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Default: `Linux`, Optional) ### Example diff --git a/content/docs/2.12/scalers/solr.md b/content/docs/2.12/scalers/solr.md index 1082cd198..a4fafb7f6 100644 --- a/content/docs/2.12/scalers/solr.md +++ b/content/docs/2.12/scalers/solr.md @@ -27,7 +27,7 @@ triggers: - `query`- A Solr query that should return single numeric value. (Default: `*:*`, Optional) - `collection` - Your collection name on Solr. - `targetQueryValue` - A threshold that is used as targetValue or targetAverageValue (depending on the trigger metric type) in HPA. (This value can be a float) -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.13/scalers/activemq.md b/content/docs/2.13/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.13/scalers/activemq.md +++ b/content/docs/2.13/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.13/scalers/apache-kafka-go.md b/content/docs/2.13/scalers/apache-kafka-go.md index e3ef7abf6..8c69ca0de 100644 --- a/content/docs/2.13/scalers/apache-kafka-go.md +++ b/content/docs/2.13/scalers/apache-kafka-go.md @@ -49,7 +49,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.13/scalers/apache-kafka.md b/content/docs/2.13/scalers/apache-kafka.md index 2dbb9e4bd..d4117dce1 100644 --- a/content/docs/2.13/scalers/apache-kafka.md +++ b/content/docs/2.13/scalers/apache-kafka.md @@ -46,7 +46,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.13/scalers/arangodb.md b/content/docs/2.13/scalers/arangodb.md index 67f13dc7f..042e2efd5 100644 --- a/content/docs/2.13/scalers/arangodb.md +++ b/content/docs/2.13/scalers/arangodb.md @@ -33,7 +33,7 @@ triggers: - `dbName` - Name of the database. It can also be provided as an authentication parameter. - `collection` - Name of the collection. - `threshold` - A threshold that will define when scaling should occur. -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `serverID` - The unique ArangoDB server ID. Only required if bearer JWT is being used. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional) - `connectionLimit` - Specify the max size of the active connection pool. (Optional) diff --git a/content/docs/2.13/scalers/artemis.md b/content/docs/2.13/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.13/scalers/artemis.md +++ b/content/docs/2.13/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.13/scalers/aws-dynamodb-streams.md b/content/docs/2.13/scalers/aws-dynamodb-streams.md index 0d2f9aa4a..06f0ec19d 100644 --- a/content/docs/2.13/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.13/scalers/aws-dynamodb-streams.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.13/scalers/aws-dynamodb.md b/content/docs/2.13/scalers/aws-dynamodb.md index dc6471782..e91c4b8d9 100644 --- a/content/docs/2.13/scalers/aws-dynamodb.md +++ b/content/docs/2.13/scalers/aws-dynamodb.md @@ -41,7 +41,7 @@ triggers: - `tableName` - The target table where the scaler execute the query. - `indexName` - The index used by the DynamoDB Query. (Optional) - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.13/scalers/aws-kinesis.md b/content/docs/2.13/scalers/aws-kinesis.md index e1731d87e..a4e10444e 100644 --- a/content/docs/2.13/scalers/aws-kinesis.md +++ b/content/docs/2.13/scalers/aws-kinesis.md @@ -30,7 +30,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.13/scalers/aws-sqs.md b/content/docs/2.13/scalers/aws-sqs.md index 49d26ef61..8fd0ab305 100644 --- a/content/docs/2.13/scalers/aws-sqs.md +++ b/content/docs/2.13/scalers/aws-sqs.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.13/scalers/azure-event-hub.md b/content/docs/2.13/scalers/azure-event-hub.md index e3da149a5..e19858754 100644 --- a/content/docs/2.13/scalers/azure-event-hub.md +++ b/content/docs/2.13/scalers/azure-event-hub.md @@ -40,7 +40,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.13/scalers/azure-pipelines.md b/content/docs/2.13/scalers/azure-pipelines.md index 4c3fa4126..af6d1818f 100644 --- a/content/docs/2.13/scalers/azure-pipelines.md +++ b/content/docs/2.13/scalers/azure-pipelines.md @@ -45,7 +45,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` - `jobsToFetch` - The number of the jobs that KEDA will fetch for the pool from Azure Pipeline API (Default: `250`, Optional) diff --git a/content/docs/2.13/scalers/azure-service-bus.md b/content/docs/2.13/scalers/azure-service-bus.md index 5668b83d7..01d4ebd5a 100644 --- a/content/docs/2.13/scalers/azure-service-bus.md +++ b/content/docs/2.13/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.13/scalers/azure-storage-blob.md b/content/docs/2.13/scalers/azure-storage-blob.md index 73f75b707..70f16b950 100644 --- a/content/docs/2.13/scalers/azure-storage-blob.md +++ b/content/docs/2.13/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.13/scalers/azure-storage-queue.md b/content/docs/2.13/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.13/scalers/azure-storage-queue.md +++ b/content/docs/2.13/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.13/scalers/cassandra.md b/content/docs/2.13/scalers/cassandra.md index 9b2147493..ccf2e9e0a 100644 --- a/content/docs/2.13/scalers/cassandra.md +++ b/content/docs/2.13/scalers/cassandra.md @@ -35,7 +35,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.13/scalers/couchdb.md b/content/docs/2.13/scalers/couchdb.md index 9da7c02f2..07a868ab9 100644 --- a/content/docs/2.13/scalers/couchdb.md +++ b/content/docs/2.13/scalers/couchdb.md @@ -30,7 +30,7 @@ triggers: - `queryValue` - A threshold that will define when scaling should occur. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `port` - The port number of the CouchDB service. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `query` - A CouchDB query that should return single numeric value. (Optional) -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `connectionStringFromEnv` - Environment variable from workload with the connection string. (Optional, Required if `connectionString` and connection parameters aren't set) ### Authentication Parameters diff --git a/content/docs/2.13/scalers/gcp-storage.md b/content/docs/2.13/scalers/gcp-storage.md index eb9b6ecef..a4a0ccc03 100644 --- a/content/docs/2.13/scalers/gcp-storage.md +++ b/content/docs/2.13/scalers/gcp-storage.md @@ -28,7 +28,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) - `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) diff --git a/content/docs/2.13/scalers/ibm-mq.md b/content/docs/2.13/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.13/scalers/ibm-mq.md +++ b/content/docs/2.13/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.13/scalers/liiklus-topic.md b/content/docs/2.13/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.13/scalers/liiklus-topic.md +++ b/content/docs/2.13/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.13/scalers/mongodb.md b/content/docs/2.13/scalers/mongodb.md index 4f7916b08..b8d8869a2 100644 --- a/content/docs/2.13/scalers/mongodb.md +++ b/content/docs/2.13/scalers/mongodb.md @@ -62,7 +62,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.13/scalers/nats-jetstream.md b/content/docs/2.13/scalers/nats-jetstream.md index 99d9f6a01..4cb8e812e 100644 --- a/content/docs/2.13/scalers/nats-jetstream.md +++ b/content/docs/2.13/scalers/nats-jetstream.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS server monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.13/scalers/nats-streaming.md b/content/docs/2.13/scalers/nats-streaming.md index 2be85d335..3a213bd5e 100644 --- a/content/docs/2.13/scalers/nats-streaming.md +++ b/content/docs/2.13/scalers/nats-streaming.md @@ -30,7 +30,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS Streaming monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.13/scalers/openstack-swift.md b/content/docs/2.13/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.13/scalers/openstack-swift.md +++ b/content/docs/2.13/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.13/scalers/pulsar.md b/content/docs/2.13/scalers/pulsar.md index e13d63c27..4f6141c16 100644 --- a/content/docs/2.13/scalers/pulsar.md +++ b/content/docs/2.13/scalers/pulsar.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.13/scalers/redis-cluster-lists.md b/content/docs/2.13/scalers/redis-cluster-lists.md index d8e7fc095..38d1960d8 100644 --- a/content/docs/2.13/scalers/redis-cluster-lists.md +++ b/content/docs/2.13/scalers/redis-cluster-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.13/scalers/redis-lists.md b/content/docs/2.13/scalers/redis-lists.md index bca9cb7d9..45f2979fc 100644 --- a/content/docs/2.13/scalers/redis-lists.md +++ b/content/docs/2.13/scalers/redis-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.13/scalers/redis-sentinel-lists.md b/content/docs/2.13/scalers/redis-sentinel-lists.md index 0c14ca69e..852ab00d7 100644 --- a/content/docs/2.13/scalers/redis-sentinel-lists.md +++ b/content/docs/2.13/scalers/redis-sentinel-lists.md @@ -44,7 +44,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.13/scalers/selenium-grid-scaler.md b/content/docs/2.13/scalers/selenium-grid-scaler.md index 532169ee8..edeff1da7 100644 --- a/content/docs/2.13/scalers/selenium-grid-scaler.md +++ b/content/docs/2.13/scalers/selenium-grid-scaler.md @@ -33,7 +33,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `platformName` - Name of the browser platform. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Default: `Linux`, Optional) ### Example diff --git a/content/docs/2.13/scalers/solr.md b/content/docs/2.13/scalers/solr.md index 1082cd198..a4fafb7f6 100644 --- a/content/docs/2.13/scalers/solr.md +++ b/content/docs/2.13/scalers/solr.md @@ -27,7 +27,7 @@ triggers: - `query`- A Solr query that should return single numeric value. (Default: `*:*`, Optional) - `collection` - Your collection name on Solr. - `targetQueryValue` - A threshold that is used as targetValue or targetAverageValue (depending on the trigger metric type) in HPA. (This value can be a float) -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/activemq.md b/content/docs/2.14/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.14/scalers/activemq.md +++ b/content/docs/2.14/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.14/scalers/apache-kafka-go.md b/content/docs/2.14/scalers/apache-kafka-go.md index e3ef7abf6..8c69ca0de 100644 --- a/content/docs/2.14/scalers/apache-kafka-go.md +++ b/content/docs/2.14/scalers/apache-kafka-go.md @@ -49,7 +49,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.14/scalers/apache-kafka.md b/content/docs/2.14/scalers/apache-kafka.md index 2dbb9e4bd..d4117dce1 100644 --- a/content/docs/2.14/scalers/apache-kafka.md +++ b/content/docs/2.14/scalers/apache-kafka.md @@ -46,7 +46,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.14/scalers/arangodb.md b/content/docs/2.14/scalers/arangodb.md index 67f13dc7f..042e2efd5 100644 --- a/content/docs/2.14/scalers/arangodb.md +++ b/content/docs/2.14/scalers/arangodb.md @@ -33,7 +33,7 @@ triggers: - `dbName` - Name of the database. It can also be provided as an authentication parameter. - `collection` - Name of the collection. - `threshold` - A threshold that will define when scaling should occur. -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `serverID` - The unique ArangoDB server ID. Only required if bearer JWT is being used. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional) - `connectionLimit` - Specify the max size of the active connection pool. (Optional) diff --git a/content/docs/2.14/scalers/artemis.md b/content/docs/2.14/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.14/scalers/artemis.md +++ b/content/docs/2.14/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.14/scalers/aws-dynamodb-streams.md b/content/docs/2.14/scalers/aws-dynamodb-streams.md index 0d2f9aa4a..06f0ec19d 100644 --- a/content/docs/2.14/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.14/scalers/aws-dynamodb-streams.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.14/scalers/aws-dynamodb.md b/content/docs/2.14/scalers/aws-dynamodb.md index dc6471782..e91c4b8d9 100644 --- a/content/docs/2.14/scalers/aws-dynamodb.md +++ b/content/docs/2.14/scalers/aws-dynamodb.md @@ -41,7 +41,7 @@ triggers: - `tableName` - The target table where the scaler execute the query. - `indexName` - The index used by the DynamoDB Query. (Optional) - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.14/scalers/aws-kinesis.md b/content/docs/2.14/scalers/aws-kinesis.md index e1731d87e..a4e10444e 100644 --- a/content/docs/2.14/scalers/aws-kinesis.md +++ b/content/docs/2.14/scalers/aws-kinesis.md @@ -30,7 +30,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.14/scalers/aws-sqs.md b/content/docs/2.14/scalers/aws-sqs.md index 49d26ef61..8fd0ab305 100644 --- a/content/docs/2.14/scalers/aws-sqs.md +++ b/content/docs/2.14/scalers/aws-sqs.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.14/scalers/azure-event-hub.md b/content/docs/2.14/scalers/azure-event-hub.md index e3da149a5..e19858754 100644 --- a/content/docs/2.14/scalers/azure-event-hub.md +++ b/content/docs/2.14/scalers/azure-event-hub.md @@ -40,7 +40,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.14/scalers/azure-pipelines.md b/content/docs/2.14/scalers/azure-pipelines.md index 4c3fa4126..af6d1818f 100644 --- a/content/docs/2.14/scalers/azure-pipelines.md +++ b/content/docs/2.14/scalers/azure-pipelines.md @@ -45,7 +45,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` - `jobsToFetch` - The number of the jobs that KEDA will fetch for the pool from Azure Pipeline API (Default: `250`, Optional) diff --git a/content/docs/2.14/scalers/azure-service-bus.md b/content/docs/2.14/scalers/azure-service-bus.md index 5668b83d7..01d4ebd5a 100644 --- a/content/docs/2.14/scalers/azure-service-bus.md +++ b/content/docs/2.14/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.14/scalers/azure-storage-blob.md b/content/docs/2.14/scalers/azure-storage-blob.md index 73f75b707..70f16b950 100644 --- a/content/docs/2.14/scalers/azure-storage-blob.md +++ b/content/docs/2.14/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.14/scalers/azure-storage-queue.md b/content/docs/2.14/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.14/scalers/azure-storage-queue.md +++ b/content/docs/2.14/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.14/scalers/cassandra.md b/content/docs/2.14/scalers/cassandra.md index 9b2147493..ccf2e9e0a 100644 --- a/content/docs/2.14/scalers/cassandra.md +++ b/content/docs/2.14/scalers/cassandra.md @@ -35,7 +35,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/couchdb.md b/content/docs/2.14/scalers/couchdb.md index 9da7c02f2..07a868ab9 100644 --- a/content/docs/2.14/scalers/couchdb.md +++ b/content/docs/2.14/scalers/couchdb.md @@ -30,7 +30,7 @@ triggers: - `queryValue` - A threshold that will define when scaling should occur. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `port` - The port number of the CouchDB service. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `query` - A CouchDB query that should return single numeric value. (Optional) -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `connectionStringFromEnv` - Environment variable from workload with the connection string. (Optional, Required if `connectionString` and connection parameters aren't set) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/gcp-storage.md b/content/docs/2.14/scalers/gcp-storage.md index eb9b6ecef..a4a0ccc03 100644 --- a/content/docs/2.14/scalers/gcp-storage.md +++ b/content/docs/2.14/scalers/gcp-storage.md @@ -28,7 +28,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) - `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) diff --git a/content/docs/2.14/scalers/ibm-mq.md b/content/docs/2.14/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.14/scalers/ibm-mq.md +++ b/content/docs/2.14/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.14/scalers/liiklus-topic.md b/content/docs/2.14/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.14/scalers/liiklus-topic.md +++ b/content/docs/2.14/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/mongodb.md b/content/docs/2.14/scalers/mongodb.md index 4f7916b08..b8d8869a2 100644 --- a/content/docs/2.14/scalers/mongodb.md +++ b/content/docs/2.14/scalers/mongodb.md @@ -62,7 +62,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.14/scalers/nats-jetstream.md b/content/docs/2.14/scalers/nats-jetstream.md index 99d9f6a01..4cb8e812e 100644 --- a/content/docs/2.14/scalers/nats-jetstream.md +++ b/content/docs/2.14/scalers/nats-jetstream.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS server monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/nats-streaming.md b/content/docs/2.14/scalers/nats-streaming.md index 2be85d335..3a213bd5e 100644 --- a/content/docs/2.14/scalers/nats-streaming.md +++ b/content/docs/2.14/scalers/nats-streaming.md @@ -30,7 +30,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS Streaming monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/openstack-swift.md b/content/docs/2.14/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.14/scalers/openstack-swift.md +++ b/content/docs/2.14/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.14/scalers/pulsar.md b/content/docs/2.14/scalers/pulsar.md index e13d63c27..4f6141c16 100644 --- a/content/docs/2.14/scalers/pulsar.md +++ b/content/docs/2.14/scalers/pulsar.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.14/scalers/redis-cluster-lists.md b/content/docs/2.14/scalers/redis-cluster-lists.md index d8e7fc095..38d1960d8 100644 --- a/content/docs/2.14/scalers/redis-cluster-lists.md +++ b/content/docs/2.14/scalers/redis-cluster-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.14/scalers/redis-lists.md b/content/docs/2.14/scalers/redis-lists.md index bca9cb7d9..45f2979fc 100644 --- a/content/docs/2.14/scalers/redis-lists.md +++ b/content/docs/2.14/scalers/redis-lists.md @@ -38,7 +38,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.14/scalers/redis-sentinel-lists.md b/content/docs/2.14/scalers/redis-sentinel-lists.md index 0c14ca69e..852ab00d7 100644 --- a/content/docs/2.14/scalers/redis-sentinel-lists.md +++ b/content/docs/2.14/scalers/redis-sentinel-lists.md @@ -44,7 +44,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.14/scalers/selenium-grid-scaler.md b/content/docs/2.14/scalers/selenium-grid-scaler.md index 532169ee8..edeff1da7 100644 --- a/content/docs/2.14/scalers/selenium-grid-scaler.md +++ b/content/docs/2.14/scalers/selenium-grid-scaler.md @@ -33,7 +33,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `platformName` - Name of the browser platform. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Default: `Linux`, Optional) ### Example diff --git a/content/docs/2.14/scalers/solr.md b/content/docs/2.14/scalers/solr.md index 1082cd198..a4fafb7f6 100644 --- a/content/docs/2.14/scalers/solr.md +++ b/content/docs/2.14/scalers/solr.md @@ -27,7 +27,7 @@ triggers: - `query`- A Solr query that should return single numeric value. (Default: `*:*`, Optional) - `collection` - Your collection name on Solr. - `targetQueryValue` - A threshold that is used as targetValue or targetAverageValue (depending on the trigger metric type) in HPA. (This value can be a float) -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.8/scalers/activemq.md b/content/docs/2.8/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.8/scalers/activemq.md +++ b/content/docs/2.8/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.8/scalers/apache-kafka.md b/content/docs/2.8/scalers/apache-kafka.md index a8197feaf..736048d39 100644 --- a/content/docs/2.8/scalers/apache-kafka.md +++ b/content/docs/2.8/scalers/apache-kafka.md @@ -40,7 +40,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.8/scalers/artemis.md b/content/docs/2.8/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.8/scalers/artemis.md +++ b/content/docs/2.8/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.8/scalers/aws-dynamodb-streams.md b/content/docs/2.8/scalers/aws-dynamodb-streams.md index c30329f93..5aeab4b7b 100644 --- a/content/docs/2.8/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.8/scalers/aws-dynamodb-streams.md @@ -29,7 +29,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.8/scalers/aws-dynamodb.md b/content/docs/2.8/scalers/aws-dynamodb.md index 9626d1995..97edce79f 100644 --- a/content/docs/2.8/scalers/aws-dynamodb.md +++ b/content/docs/2.8/scalers/aws-dynamodb.md @@ -35,7 +35,7 @@ triggers: - `awsRegion` - AWS Region for the DynamoDB Table. - `tableName` - The target table where the scaler execute the query. - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.8/scalers/aws-kinesis.md b/content/docs/2.8/scalers/aws-kinesis.md index c4f6b1286..cf9658b70 100644 --- a/content/docs/2.8/scalers/aws-kinesis.md +++ b/content/docs/2.8/scalers/aws-kinesis.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.8/scalers/aws-sqs.md b/content/docs/2.8/scalers/aws-sqs.md index dc1b02074..85265b0fa 100644 --- a/content/docs/2.8/scalers/aws-sqs.md +++ b/content/docs/2.8/scalers/aws-sqs.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.8/scalers/azure-event-hub.md b/content/docs/2.8/scalers/azure-event-hub.md index d958c621c..c3866a894 100644 --- a/content/docs/2.8/scalers/azure-event-hub.md +++ b/content/docs/2.8/scalers/azure-event-hub.md @@ -36,7 +36,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.8/scalers/azure-pipelines.md b/content/docs/2.8/scalers/azure-pipelines.md index c068422f6..8c90aeb0f 100644 --- a/content/docs/2.8/scalers/azure-pipelines.md +++ b/content/docs/2.8/scalers/azure-pipelines.md @@ -41,7 +41,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` diff --git a/content/docs/2.8/scalers/azure-service-bus.md b/content/docs/2.8/scalers/azure-service-bus.md index cbecc4771..8c33a34d5 100644 --- a/content/docs/2.8/scalers/azure-service-bus.md +++ b/content/docs/2.8/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.8/scalers/azure-storage-blob.md b/content/docs/2.8/scalers/azure-storage-blob.md index 96f1e853e..b97f3a512 100644 --- a/content/docs/2.8/scalers/azure-storage-blob.md +++ b/content/docs/2.8/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.8/scalers/azure-storage-queue.md b/content/docs/2.8/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.8/scalers/azure-storage-queue.md +++ b/content/docs/2.8/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.8/scalers/cassandra.md b/content/docs/2.8/scalers/cassandra.md index 9efc4e94b..88c4f80db 100644 --- a/content/docs/2.8/scalers/cassandra.md +++ b/content/docs/2.8/scalers/cassandra.md @@ -36,7 +36,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `metricName` - Name to assign to the metric. (Default: `s-cassandra-`, Optional, In case of `metricName` is specified, it will be used to generate the `metricName` like this: `s-cassandra-`, where `` is the index of the trigger in a ScaledObject) ### Authentication Parameters diff --git a/content/docs/2.8/scalers/gcp-pub-sub.md b/content/docs/2.8/scalers/gcp-pub-sub.md index 97f06e7bc..0465a06e6 100644 --- a/content/docs/2.8/scalers/gcp-pub-sub.md +++ b/content/docs/2.8/scalers/gcp-pub-sub.md @@ -26,7 +26,7 @@ The Google Cloud Platform‎ (GCP) Pub/Sub trigger allows you to scale based on The `credentialsFromEnv` property maps to the name of an environment variable in the scale target (`scaleTargetRef`) that contains the service account credentials (JSON). KEDA will use those to connect to Google Cloud Platform and collect the required stack driver metrics in order to read the number of messages in the Pub/Sub subscription. -- `activationValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) `subscriptionName` defines the subscription that should be monitored. You can use different formulas: diff --git a/content/docs/2.8/scalers/gcp-stackdriver.md b/content/docs/2.8/scalers/gcp-stackdriver.md index fac692249..e2d7111f2 100644 --- a/content/docs/2.8/scalers/gcp-stackdriver.md +++ b/content/docs/2.8/scalers/gcp-stackdriver.md @@ -29,7 +29,7 @@ triggers: - `projectId` - GCP project Id that contains the metric. - `filter` - The stackdriver query filter for obtaining the metric. The metric is for the last minute and if multiple values are returned, the first one is used. - `targetValue` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) The `credentialsFromEnv` property maps to the name of an environment variable in the scale target (`scaleTargetRef`) that contains the service account credentials (JSON). KEDA will use those to connect to Google Cloud Platform and collect the configured stack driver metrics. diff --git a/content/docs/2.8/scalers/gcp-storage.md b/content/docs/2.8/scalers/gcp-storage.md index dc11b95db..d240316e8 100644 --- a/content/docs/2.8/scalers/gcp-storage.md +++ b/content/docs/2.8/scalers/gcp-storage.md @@ -26,7 +26,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) As counting the number of objects involves iterating over their metadata it is advised to set this number to the value of `targetObjectCount` * `maxReplicaCount`. diff --git a/content/docs/2.8/scalers/ibm-mq.md b/content/docs/2.8/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.8/scalers/ibm-mq.md +++ b/content/docs/2.8/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.8/scalers/liiklus-topic.md b/content/docs/2.8/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.8/scalers/liiklus-topic.md +++ b/content/docs/2.8/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.8/scalers/mongodb.md b/content/docs/2.8/scalers/mongodb.md index 03e90fccf..d6972b943 100644 --- a/content/docs/2.8/scalers/mongodb.md +++ b/content/docs/2.8/scalers/mongodb.md @@ -68,7 +68,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.8/scalers/nats-jetstream.md b/content/docs/2.8/scalers/nats-jetstream.md index 43c34724c..2f0d8f1ef 100644 --- a/content/docs/2.8/scalers/nats-jetstream.md +++ b/content/docs/2.8/scalers/nats-jetstream.md @@ -30,7 +30,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.8/scalers/nats-streaming.md b/content/docs/2.8/scalers/nats-streaming.md index ae9c3221a..fdc4492d8 100644 --- a/content/docs/2.8/scalers/nats-streaming.md +++ b/content/docs/2.8/scalers/nats-streaming.md @@ -29,7 +29,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.8/scalers/openstack-swift.md b/content/docs/2.8/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.8/scalers/openstack-swift.md +++ b/content/docs/2.8/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.8/scalers/pulsar.md b/content/docs/2.8/scalers/pulsar.md index 04678af14..57f3186ec 100644 --- a/content/docs/2.8/scalers/pulsar.md +++ b/content/docs/2.8/scalers/pulsar.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.8/scalers/redis-cluster-lists.md b/content/docs/2.8/scalers/redis-cluster-lists.md index 592094dfa..2fa9ba8b0 100644 --- a/content/docs/2.8/scalers/redis-cluster-lists.md +++ b/content/docs/2.8/scalers/redis-cluster-lists.md @@ -36,7 +36,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) > ⚠️ **WARNING:** In this version, `enableTLS: true` automatically skips the certificate verification which is insecure. Use v2.9 or above to properly verify the server certificate. diff --git a/content/docs/2.8/scalers/redis-lists.md b/content/docs/2.8/scalers/redis-lists.md index 98bad827a..dba72620d 100644 --- a/content/docs/2.8/scalers/redis-lists.md +++ b/content/docs/2.8/scalers/redis-lists.md @@ -37,7 +37,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.8/scalers/redis-sentinel-lists.md b/content/docs/2.8/scalers/redis-sentinel-lists.md index e7116b66c..94f5baae9 100644 --- a/content/docs/2.8/scalers/redis-sentinel-lists.md +++ b/content/docs/2.8/scalers/redis-sentinel-lists.md @@ -42,7 +42,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) > ⚠️ **WARNING:** In this version, `enableTLS: true` automatically skips the certificate verification which is insecure. Use v2.9 or above to properly verify the server certificate. diff --git a/content/docs/2.8/scalers/selenium-grid-scaler.md b/content/docs/2.8/scalers/selenium-grid-scaler.md index 97292e417..96f6dd81a 100644 --- a/content/docs/2.8/scalers/selenium-grid-scaler.md +++ b/content/docs/2.8/scalers/selenium-grid-scaler.md @@ -32,7 +32,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Example diff --git a/content/docs/2.8/scalers/solace-pub-sub.md b/content/docs/2.8/scalers/solace-pub-sub.md index 83df98f60..abf83add8 100644 --- a/content/docs/2.8/scalers/solace-pub-sub.md +++ b/content/docs/2.8/scalers/solace-pub-sub.md @@ -33,9 +33,9 @@ triggers: - `messageVpn` - Message VPN hosted on the Solace broker. - `queueName` - Message Queue to be monitored. - `messageCountTarget` - The target number of messages manageable by a pod. The scaler will cause the replicas to increase if the queue message backlog is greater than the target value per active replica. -- `activationMessageCountTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCountTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `messageSpoolUsageTarget` - Integer value expressed in Megabytes (MB). The target spool usage manageable by a pod. The scaler will cause the replicas to increase if the queue spool usage is greater than the target value per active replica. -- `activationMessageSpoolUsageTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageSpoolUsageTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `username` - User account with access to Solace SEMP RESTful endpoint. - `password` - Password for the user account. - `usernameFromEnv` - Environment variable set with SEMP user account. diff --git a/content/docs/2.9/scalers/activemq.md b/content/docs/2.9/scalers/activemq.md index 9c6a2a379..a970f9566 100644 --- a/content/docs/2.9/scalers/activemq.md +++ b/content/docs/2.9/scalers/activemq.md @@ -27,7 +27,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueueSize` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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://<>"`, Optional) diff --git a/content/docs/2.9/scalers/apache-kafka.md b/content/docs/2.9/scalers/apache-kafka.md index 2ded7dd9c..f3413f1e6 100644 --- a/content/docs/2.9/scalers/apache-kafka.md +++ b/content/docs/2.9/scalers/apache-kafka.md @@ -42,7 +42,7 @@ triggers: - `consumerGroup` - Name of the consumer group used for checking the offset on the topic and processing the related lag. - `topic` - Name of the topic on which processing the offset lag. (Optional, see note below) - `lagThreshold` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `offsetResetPolicy` - The offset reset policy for the consumer. (Values: `latest`, `earliest`, Default: `latest`, Optional) - `allowIdleConsumers` - When set to `true`, the number of replicas can exceed the number of partitions on a topic, allowing for idle consumers. (Default: `false`, Optional) diff --git a/content/docs/2.9/scalers/artemis.md b/content/docs/2.9/scalers/artemis.md index 08491cd52..08613af50 100644 --- a/content/docs/2.9/scalers/artemis.md +++ b/content/docs/2.9/scalers/artemis.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `restApiTemplate` - Template to build REST API url to get queue size. (Default: `"http://<>/console/jolokia/read/org.apache.activemq.artemis:broker=\"<>\",component=addresses,address=\"<>\",subcomponent=queues,routing-type=\"anycast\",queue=\"<>\"/MessageCount"`, Optional) - `corsHeader` - Value to populate the Origin header field for CORS filtering. (Default: `"http://<>"`, Optional) diff --git a/content/docs/2.9/scalers/aws-dynamodb-streams.md b/content/docs/2.9/scalers/aws-dynamodb-streams.md index 31f12013d..cf2f79c4e 100644 --- a/content/docs/2.9/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.9/scalers/aws-dynamodb-streams.md @@ -32,7 +32,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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. diff --git a/content/docs/2.9/scalers/aws-dynamodb.md b/content/docs/2.9/scalers/aws-dynamodb.md index c059327d1..535bd7b71 100644 --- a/content/docs/2.9/scalers/aws-dynamodb.md +++ b/content/docs/2.9/scalers/aws-dynamodb.md @@ -38,7 +38,7 @@ triggers: - `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional) - `tableName` - The target table where the scaler execute the query. - `targetValue` - The target value for the number of items retrieved by the query. -- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `expressionAttributeNames` - one or more substitution tokens for attribute names in an expression. Defined as JSON. - `keyConditionExpression` - the condition that specifies the key values for items to be retrieved by the Query action. - `expressionAttributeValues` - one or more values that can be substituted in an expression. Defined as JSON. diff --git a/content/docs/2.9/scalers/aws-kinesis.md b/content/docs/2.9/scalers/aws-kinesis.md index b5185abbc..a27a00cfc 100644 --- a/content/docs/2.9/scalers/aws-kinesis.md +++ b/content/docs/2.9/scalers/aws-kinesis.md @@ -29,7 +29,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationShardCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.9/scalers/aws-sqs.md b/content/docs/2.9/scalers/aws-sqs.md index 75e968276..99c5d01b9 100644 --- a/content/docs/2.9/scalers/aws-sqs.md +++ b/content/docs/2.9/scalers/aws-sqs.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`. diff --git a/content/docs/2.9/scalers/azure-event-hub.md b/content/docs/2.9/scalers/azure-event-hub.md index e3da149a5..e19858754 100644 --- a/content/docs/2.9/scalers/azure-event-hub.md +++ b/content/docs/2.9/scalers/azure-event-hub.md @@ -40,7 +40,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationUnprocessedEventThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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) diff --git a/content/docs/2.9/scalers/azure-pipelines.md b/content/docs/2.9/scalers/azure-pipelines.md index c068422f6..8c90aeb0f 100644 --- a/content/docs/2.9/scalers/azure-pipelines.md +++ b/content/docs/2.9/scalers/azure-pipelines.md @@ -41,7 +41,7 @@ triggers: - `personalAccessTokenFromEnv` - Name of the environment variable that provides the personal access token (PAT) for Azure DevOps. Learn more about how to create one [in the official docs](https://docs.microsoft.com/en-us/azure/devops/organizations/accounts/use-personal-access-tokens-to-authenticate?view=azure-devops&tabs=preview-page). - `targetPipelinesQueueLength` - Target value for the amount of pending jobs in the queue to scale on. (Default: `1`, Optional) - Example - If one pod can handle 10 jobs, set the queue length target to 10. If the actual number of jobs in the queue is 30, the scaler scales to 3 pods. -- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetPipelinesQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `parent` - Put the name of the ADO agent that matched the ScaledObject. e.g. mavenagent-scaledobject may have an initial deployment called "mavenagent-keda-template"; this is the deployment that is made offline. This name is provided to the initial deployment as the environment variable "AZP_NAME" - `demands` - Put the demands string that was provided to the ScaledObject. This MUST be a subset of the actual capability list the agent has. e.g. `maven,docker` diff --git a/content/docs/2.9/scalers/azure-service-bus.md b/content/docs/2.9/scalers/azure-service-bus.md index ae14d0791..ae83166a6 100644 --- a/content/docs/2.9/scalers/azure-service-bus.md +++ b/content/docs/2.9/scalers/azure-service-bus.md @@ -35,7 +35,7 @@ triggers: **Parameter list:** - `messageCount` - Amount of active messages in your Azure Service Bus queue or topic to scale on. -- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `queueName` - Name of the Azure Service Bus queue to scale on. (Optional) - `topicName` - Name of the Azure Service Bus topic to scale on. (Optional) - `subscriptionName` - Name of the Azure Service Bus queue to scale on. (Optional*, Required when `topicName` is specified) diff --git a/content/docs/2.9/scalers/azure-storage-blob.md b/content/docs/2.9/scalers/azure-storage-blob.md index 96f1e853e..b97f3a512 100644 --- a/content/docs/2.9/scalers/azure-storage-blob.md +++ b/content/docs/2.9/scalers/azure-storage-blob.md @@ -32,7 +32,7 @@ triggers: - `blobContainerName` - Name of container in an Azure Storage account. - `blobCount` - Average target value to trigger scaling actions. (Default: `5`, Optional) -- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationBlobCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 container belongs to. - `blobPrefix` - Prefix for the Blob. Use this to specify sub path for the blobs if required. (Default: `""`, Optional) diff --git a/content/docs/2.9/scalers/azure-storage-queue.md b/content/docs/2.9/scalers/azure-storage-queue.md index d59f71ca9..5e6066b1c 100644 --- a/content/docs/2.9/scalers/azure-storage-queue.md +++ b/content/docs/2.9/scalers/azure-storage-queue.md @@ -26,7 +26,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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`) diff --git a/content/docs/2.9/scalers/cassandra.md b/content/docs/2.9/scalers/cassandra.md index 9efc4e94b..88c4f80db 100644 --- a/content/docs/2.9/scalers/cassandra.md +++ b/content/docs/2.9/scalers/cassandra.md @@ -36,7 +36,7 @@ triggers: - `keyspace` - The name of the keyspace used in Cassandra. - `query` - A Cassandra query that should return single numeric value. - `targetQueryValue` - The threshold value that is provided by the user and used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). -- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `metricName` - Name to assign to the metric. (Default: `s-cassandra-`, Optional, In case of `metricName` is specified, it will be used to generate the `metricName` like this: `s-cassandra-`, where `` is the index of the trigger in a ScaledObject) ### Authentication Parameters diff --git a/content/docs/2.9/scalers/couchdb.md b/content/docs/2.9/scalers/couchdb.md index 77f0bba1a..52672192e 100644 --- a/content/docs/2.9/scalers/couchdb.md +++ b/content/docs/2.9/scalers/couchdb.md @@ -30,7 +30,7 @@ triggers: - `queryValue` - A threshold that will define when scaling should occur. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `port` - The port number of the CouchDB service. (Optional, Required if `connectionString` and `connectionStringFromEnv` is not set) - `query` - A CouchDB query that should return single numeric value. (Optional) -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `connectionStringFromEnv` - Environment variable from workload with the connection string. (Optional, Required if `connectionString` and connection parameters aren't set) ### Authentication Parameters diff --git a/content/docs/2.9/scalers/gcp-storage.md b/content/docs/2.9/scalers/gcp-storage.md index eb9b6ecef..a4a0ccc03 100644 --- a/content/docs/2.9/scalers/gcp-storage.md +++ b/content/docs/2.9/scalers/gcp-storage.md @@ -28,7 +28,7 @@ triggers: - `bucketName` - Name of the bucket in GCS. - `targetObjectCount` - Average target value to trigger scaling actions. (Default: `100`, Optional) -- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationTargetObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `maxBucketItemsToScan` - When to stop counting how many objects are in the bucket. (Default: `1000`, Optional) - `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) diff --git a/content/docs/2.9/scalers/ibm-mq.md b/content/docs/2.9/scalers/ibm-mq.md index 703930d1a..f3aceaf3a 100644 --- a/content/docs/2.9/scalers/ibm-mq.md +++ b/content/docs/2.9/scalers/ibm-mq.md @@ -31,7 +31,7 @@ triggers: - `queueName` - Name of the Queue within the Queue Manager defined from which messages will be consumed. - `tlsDisabled` - Can be set to 'true' to disable TLS. (Values: `true`, `false` , Default: `false`, Optional) - `queueDepth` - Queue depth Target for HPA. (Default: `5`, Optional) -- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueueDepth` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `usernameFromEnv` - Provide admin username from env instead of as a secret. (Optional) - `passwordFromEnv` - Provide admin password from env instead of as a secret. (Optional) diff --git a/content/docs/2.9/scalers/liiklus-topic.md b/content/docs/2.9/scalers/liiklus-topic.md index 58d858553..5741a0df3 100644 --- a/content/docs/2.9/scalers/liiklus-topic.md +++ b/content/docs/2.9/scalers/liiklus-topic.md @@ -31,7 +31,7 @@ triggers: - `group` - Name of consumer group. - `topic` - Topic to monitor and scale based on `lagThreshold`. - `lagThreshold` - Value to trigger scaling actions for. (Default: `10`, Optional) -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `groupVersion` - Version of the group to consider when looking at messages. See [docs](https://github.com/bsideup/liiklus/blob/22efb7049ebcdd0dcf6f7f5735cdb5af1ae014de/app/src/test/java/com/github/bsideup/liiklus/GroupVersionTest.java). (Default: `0`, Optional) ### Authentication Parameters diff --git a/content/docs/2.9/scalers/mongodb.md b/content/docs/2.9/scalers/mongodb.md index 03e90fccf..d6972b943 100644 --- a/content/docs/2.9/scalers/mongodb.md +++ b/content/docs/2.9/scalers/mongodb.md @@ -68,7 +68,7 @@ The `mongodb` trigger always requires the following information: - `collection` - Name of the collection. - `query` - A MongoDB query that should return single numeric value. - `queryValue` - A threshold that will define when scaling should occur. -- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) To connect to the MongoDB server, you can provide either: diff --git a/content/docs/2.9/scalers/nats-jetstream.md b/content/docs/2.9/scalers/nats-jetstream.md index 0112dbd1f..5c34884bd 100644 --- a/content/docs/2.9/scalers/nats-jetstream.md +++ b/content/docs/2.9/scalers/nats-jetstream.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS server monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.9/scalers/nats-streaming.md b/content/docs/2.9/scalers/nats-streaming.md index 2be85d335..3a213bd5e 100644 --- a/content/docs/2.9/scalers/nats-streaming.md +++ b/content/docs/2.9/scalers/nats-streaming.md @@ -30,7 +30,7 @@ triggers: - `durableName` - Name of durability used by subscribers. - `subject` - Name of the channel. - `lagThreshold` - Average target value to trigger scaling actions. -- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationLagThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `useHttps` - Specifies if the NATS Streaming monitoring endpoint is using HTTPS. (Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.9/scalers/openstack-swift.md b/content/docs/2.9/scalers/openstack-swift.md index 690d113b4..392dc5b1b 100644 --- a/content/docs/2.9/scalers/openstack-swift.md +++ b/content/docs/2.9/scalers/openstack-swift.md @@ -32,7 +32,7 @@ triggers: - `swiftURL` - The URL to query the Swift API. If not provided, the scaler will try to find the Swift public URL for a certain region, using the OpenStack catalog, which is returned when requesting an authentication token. (Optional) - `containerName` - Name of Swift container in an OpenStack account. - `objectCount` - Average target value to trigger scaling actions. (Default: `2`, Optional) -- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationObjectCount` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `objectPrefix` - Prefix for the object. Only objects with this prefix will be returned. Use this prefix to specify sub-paths for the objects. (Default: `""`, Optional) - `objectDelimiter` - Delimiter for identifying the object prefix. It is the character used to split object names. (Default: `""`, Optional) - `objectLimit` - The maximum number of objects returned by the API. By default, the Swift API only returns up to 10000 names. (Default: `""`, Optional) diff --git a/content/docs/2.9/scalers/pulsar.md b/content/docs/2.9/scalers/pulsar.md index b2c4f1e13..0c9d226bd 100644 --- a/content/docs/2.9/scalers/pulsar.md +++ b/content/docs/2.9/scalers/pulsar.md @@ -31,7 +31,7 @@ triggers: - `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](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMsgBacklogThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (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 diff --git a/content/docs/2.9/scalers/redis-cluster-lists.md b/content/docs/2.9/scalers/redis-cluster-lists.md index 6dfd26222..de1858cdf 100644 --- a/content/docs/2.9/scalers/redis-cluster-lists.md +++ b/content/docs/2.9/scalers/redis-cluster-lists.md @@ -36,7 +36,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, 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: diff --git a/content/docs/2.9/scalers/redis-lists.md b/content/docs/2.9/scalers/redis-lists.md index 6e99cf312..b9cb80111 100644 --- a/content/docs/2.9/scalers/redis-lists.md +++ b/content/docs/2.9/scalers/redis-lists.md @@ -37,7 +37,7 @@ triggers: - Both the hostname, username and password fields need to be set to the names of the environment variables in the target deployment that contain the host name, username and password respectively. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. diff --git a/content/docs/2.9/scalers/redis-sentinel-lists.md b/content/docs/2.9/scalers/redis-sentinel-lists.md index 34a82d9fa..558c948c8 100644 --- a/content/docs/2.9/scalers/redis-sentinel-lists.md +++ b/content/docs/2.9/scalers/redis-sentinel-lists.md @@ -42,7 +42,7 @@ triggers: - `sentinelMaster` - The name of the master in Sentinel to get the Redis server address for. - `listName` - Name of the Redis List that you want to monitor. - `listLength` - Average target value to trigger scaling actions. -- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, 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: diff --git a/content/docs/2.9/scalers/selenium-grid-scaler.md b/content/docs/2.9/scalers/selenium-grid-scaler.md index 8f1765c09..ecf91eecc 100644 --- a/content/docs/2.9/scalers/selenium-grid-scaler.md +++ b/content/docs/2.9/scalers/selenium-grid-scaler.md @@ -32,7 +32,7 @@ triggers: - `sessionBrowserName` - Name of the browser when it is an active session, only set if `BrowserName` changes between the queue and the active session. See the Edge example below for further detail. (Optional) - `browserVersion` - Version of browser that usually gets passed in the browser capability. Refer to the [Selenium Grid's](https://www.selenium.dev/documentation/en/getting_started_with_webdriver/browsers/) and [WebdriverIO's](https://webdriver.io/docs/options/#capabilities) documentation for more info. (Optional) - `unsafeSsl` - Skip certificate validation when connecting over HTTPS. (Values: `true`, `false`, Default: `false`, Optional) -- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) ### Example diff --git a/content/docs/2.9/scalers/solace-pub-sub.md b/content/docs/2.9/scalers/solace-pub-sub.md index 83df98f60..abf83add8 100644 --- a/content/docs/2.9/scalers/solace-pub-sub.md +++ b/content/docs/2.9/scalers/solace-pub-sub.md @@ -33,9 +33,9 @@ triggers: - `messageVpn` - Message VPN hosted on the Solace broker. - `queueName` - Message Queue to be monitored. - `messageCountTarget` - The target number of messages manageable by a pod. The scaler will cause the replicas to increase if the queue message backlog is greater than the target value per active replica. -- `activationMessageCountTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageCountTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `messageSpoolUsageTarget` - Integer value expressed in Megabytes (MB). The target spool usage manageable by a pod. The scaler will cause the replicas to increase if the queue spool usage is greater than the target value per active replica. -- `activationMessageSpoolUsageTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) +- `activationMessageSpoolUsageTarget` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds). (Default: `0`, Optional) - `username` - User account with access to Solace SEMP RESTful endpoint. - `password` - Password for the user account. - `usernameFromEnv` - Environment variable set with SEMP user account.