From 3a8a77372970b76ad8c880a7f0b976fcd7e250b3 Mon Sep 17 00:00:00 2001 From: Jorge Turrado Ferrero Date: Tue, 7 May 2024 22:23:53 +0200 Subject: [PATCH 01/31] chore: Remove deprecated AAD-Pod-Identity and AWS-KIAM auths (#1388) Signed-off-by: Jorge Turrado Signed-off-by: shubhusion --- .../2.15/authentication-providers/aws-kiam.md | 14 ---- .../azure-ad-pod-identity.md | 19 ----- content/docs/2.15/concepts/authentication.md | 37 +-------- content/docs/2.15/scalers/aws-cloudwatch.md | 4 +- .../docs/2.15/scalers/aws-dynamodb-streams.md | 6 +- content/docs/2.15/scalers/aws-dynamodb.md | 6 +- content/docs/2.15/scalers/aws-kinesis.md | 4 +- content/docs/2.15/scalers/aws-sqs.md | 8 +- .../docs/2.15/scalers/azure-log-analytics.md | 80 ------------------- 9 files changed, 17 insertions(+), 161 deletions(-) delete mode 100644 content/docs/2.15/authentication-providers/aws-kiam.md delete mode 100644 content/docs/2.15/authentication-providers/azure-ad-pod-identity.md diff --git a/content/docs/2.15/authentication-providers/aws-kiam.md b/content/docs/2.15/authentication-providers/aws-kiam.md deleted file mode 100644 index a37939bab..000000000 --- a/content/docs/2.15/authentication-providers/aws-kiam.md +++ /dev/null @@ -1,14 +0,0 @@ -+++ -title = "AWS Kiam Pod Identity" -+++ - -[**Kiam**](https://github.com/uswitch/kiam/) lets you bind an AWS IAM Role to a pod using an annotation on the pod. - -> ⚠️ **WARNING:** `aws-kiam` auth has been deprecated given [AWS KIAM is no longer maintained](https://github.com/uswitch/kiam/#-%EF%B8%8Fthis-project-is-now-being-abandoned-%EF%B8%8F-). As a result, [support for it will be removed from KEDA on v2.15](https://github.com/kedacore/keda/discussions/5342). We strongly encourage the migration to [`aws` auth](./aws.md). - -You can tell KEDA to use Kiam via `podIdentity.provider`. - -```yaml -podIdentity: - provider: aws-kiam # Optional. Default: none -``` diff --git a/content/docs/2.15/authentication-providers/azure-ad-pod-identity.md b/content/docs/2.15/authentication-providers/azure-ad-pod-identity.md deleted file mode 100644 index 7e86f88be..000000000 --- a/content/docs/2.15/authentication-providers/azure-ad-pod-identity.md +++ /dev/null @@ -1,19 +0,0 @@ -+++ -title = "Azure AD Pod Identity" -+++ - -Azure Pod Identity is an implementation of [**Azure AD Pod Identity**](https://github.com/Azure/aad-pod-identity) which lets you bind an [**Azure Managed Identity**](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) to a Pod in a Kubernetes cluster as delegated access - *Don't manage secrets, let Azure AD do the hard work*. - -> ⚠️ **WARNING:** [Azure AD Pod Identity was archived](https://github.com/Azure/aad-pod-identity#-announcement) and support for it will be removed from KEDA on v2.15. We strongly encourage the migration to [Azure Workload Identity](https://azure.github.io/azure-workload-identity). - -You can tell KEDA to use Azure AD Pod Identity via `podIdentity.provider`. - -```yaml -podIdentity: - provider: azure # Optional. Default: none - identityId: # Optional. Default: Identity linked with the label set when installing KEDA. -``` - -Azure AD Pod Identity will give access to containers with a defined label for `aadpodidbinding`. You can set this label on the KEDA operator deployment. This can be done for you during deployment with Helm with `--set podIdentity.activeDirectory.identity={your-label-name}`. - -You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. diff --git a/content/docs/2.15/concepts/authentication.md b/content/docs/2.15/concepts/authentication.md index 70010086d..6b602a8c4 100644 --- a/content/docs/2.15/concepts/authentication.md +++ b/content/docs/2.15/concepts/authentication.md @@ -92,7 +92,7 @@ metadata: namespace: default # must be same namespace as the ScaledObject spec: podIdentity: - provider: none | azure | azure-workload | aws | aws-eks | aws-kiam | gcp # Optional. Default: none + provider: none | azure-workload | aws | aws-eks | gcp # Optional. Default: none identityId: # Optional. Only used by azure & azure-workload providers. roleArn: # Optional. Only used by aws provider. identityOwner: keda|workload # Optional. Only used by aws provider. @@ -332,30 +332,12 @@ Currently we support the following: ```yaml podIdentity: - provider: none | azure | azure-workload | aws | aws-eks | aws-kiam # Optional. Default: none + provider: none | azure-workload | aws | aws-eks | gcp # Optional. Default: none identityId: # Optional. Only used by azure & azure-workload providers. roleArn: # Optional. Only used by aws provider. identityOwner: keda|workload # Optional. Only used by aws provider. ``` -#### Azure Pod Identity - -> [DEPRECATED: This will be removed in KEDA v2.15](https://github.com/kedacore/keda/discussions/5362) - -Azure Pod Identity is an implementation of [**Azure AD Pod Identity**](https://github.com/Azure/aad-pod-identity) which lets you bind an [**Azure Managed Identity**](https://docs.microsoft.com/en-us/azure/active-directory/managed-identities-azure-resources/) to a Pod in a Kubernetes cluster as delegated access - *Don't manage secrets, let Azure AD do the hard work*. - -You can tell KEDA to use Azure AD Pod Identity via `podIdentity.provider`. - -```yaml -podIdentity: - provider: azure # Optional. Default: none - identityId: # Optional. Default: Identity linked with the label set when installing KEDA. -``` - -Azure AD Pod Identity will give access to containers with a defined label for `aadpodidbinding`. You can set this label on the KEDA operator deployment. This can be done for you during deployment with Helm with `--set podIdentity.activeDirectory.identity={your-label-name}`. - -You can override the identity that was assigned to KEDA during installation, by specifying an `identityId` parameter under the `podIdentity` field. This allows end-users to use different identities to access various resources which is more secure than using a single identity that has access to multiple resources. - #### Azure Workload Identity [**Azure AD Workload Identity**](https://github.com/Azure/azure-workload-identity) is the newer version of [**Azure AD Pod Identity**](https://github.com/Azure/aad-pod-identity). It lets your Kubernetes workloads access Azure resources using an @@ -443,17 +425,4 @@ You can tell KEDA to use EKS Pod Identity Webhook via `podIdentity.provider`. ```yaml podIdentity: provider: aws-eks # Optional. Default: none -``` - -#### AWS Kiam Pod Identity - -> [DEPRECATED: This will be removed in KEDA v2.15](https://github.com/kedacore/keda/discussions/5342) - -[**Kiam**](https://github.com/uswitch/kiam/) lets you bind an AWS IAM Role to a pod using an annotation on the pod. - -You can tell KEDA to use Kiam via `podIdentity.provider`. - -```yaml -podIdentity: - provider: aws-kiam # Optional. Default: none -``` +``` \ No newline at end of file diff --git a/content/docs/2.15/scalers/aws-cloudwatch.md b/content/docs/2.15/scalers/aws-cloudwatch.md index 45998d394..f3ac9f2ea 100644 --- a/content/docs/2.15/scalers/aws-cloudwatch.md +++ b/content/docs/2.15/scalers/aws-cloudwatch.md @@ -58,7 +58,7 @@ triggers: - `dimensionValue` - Supports specifying multiple dimension values by using ";" as a separator i.e. dimensionValue: queue1;queue2 (Optional, Required when `expression` is not specified) - `expression` - Supports query with [expression](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch-metrics-insights-querylanguage.html) (Optional, Required when `dimensionName` & `dimensionValue` are not specified) -- `identityOwner` - Receive permissions for CloudWatch 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) +- `identityOwner` - Receive permissions for CloudWatch via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version `3`, Values: `pod`, `operator`, Default: `pod`, Optional, This field only applies for `aws-eks` authentication) > When `identityOwner` set to `operator` - the only requirement is that the KEDA operator has the correct IAM permissions on the CloudWatch. Additional Authentication Parameters are not required. @@ -81,7 +81,7 @@ You can use `TriggerAuthentication` CRD to configure authentication by providing **Role based authentication:** -- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated only applies for `aws-eks` and `aws-kiam` authentications, for `aws` is set in the auth) +- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated and only applies for `aws-eks` authentication, for `aws` is set in the auth) **Credential based authentication:** diff --git a/content/docs/2.15/scalers/aws-dynamodb-streams.md b/content/docs/2.15/scalers/aws-dynamodb-streams.md index 06f0ec19d..0b9cb4d2d 100644 --- a/content/docs/2.15/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.15/scalers/aws-dynamodb-streams.md @@ -33,7 +33,7 @@ triggers: - `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) -- `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) +- `identityOwner` - Receive permissions on the DynamoDB and DynamoDB Streams via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version `3`, Values: `pod`, `operator`, Default: `pod`, Optional, This field only applies for `aws-eks` authentication) > When `identityOwner` set to `operator` - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB and Dynamodb Streams. Additional Authentication Parameters are not required. @@ -43,11 +43,11 @@ You can use `TriggerAuthentication` CRD to configure the authenticate by providi **Pod identity based authentication:** -- `podIdentity.provider` - Needs to be set to either `aws-kiam` or `aws-eks` on the `TriggerAuthentication` and the pod/service account must be configured correctly for your pod identity provider. +- `podIdentity.provider` - Needs to be set on the `TriggerAuthentication` and the pod/service account must be configured correctly for your pod identity provider. **Role based authentication:** -- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated only applies for `aws-eks` and `aws-kiam` authentications, for `aws` is set in the auth) +- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated and only applies for `aws-eks` authentication, for `aws` is set in the auth) **Credential based authentication:** diff --git a/content/docs/2.15/scalers/aws-dynamodb.md b/content/docs/2.15/scalers/aws-dynamodb.md index e91c4b8d9..ca5c72df4 100644 --- a/content/docs/2.15/scalers/aws-dynamodb.md +++ b/content/docs/2.15/scalers/aws-dynamodb.md @@ -45,7 +45,7 @@ triggers: - `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. -- `identityOwner` - Receive permissions on the DynamoDB Table 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) +- `identityOwner` - Receive permissions on the DynamoDB Table via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version `3`, Values: `pod`, `operator`, Default: `pod`, Optional, This field only applies for `aws-eks` authentication) > When `identityOwner` set to `operator` - the only requirement is that the KEDA operator has the correct IAM permissions on the DynamoDB Table. Additional Authentication Parameters are not required. @@ -55,11 +55,11 @@ You can use `TriggerAuthentication` CRD to configure the authenticate by providi **Pod identity based authentication:** -- `podIdentity.provider` - Needs to be set to either `aws-kiam` or `aws-eks` on the `TriggerAuthentication` and the pod/service account must be configured correctly for your pod identity provider. +- `podIdentity.provider` - Needs to be set on the `TriggerAuthentication` and the pod/service account must be configured correctly for your pod identity provider. **Role based authentication:** -- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated only applies for `aws-eks` and `aws-kiam` authentications, for `aws` is set in the auth) +- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated and only applies for `aws-eks` authentication, for `aws` is set in the auth) **Credential based authentication:** diff --git a/content/docs/2.15/scalers/aws-kinesis.md b/content/docs/2.15/scalers/aws-kinesis.md index a4e10444e..f13d878cb 100644 --- a/content/docs/2.15/scalers/aws-kinesis.md +++ b/content/docs/2.15/scalers/aws-kinesis.md @@ -33,7 +33,7 @@ triggers: - `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) +- `identityOwner` - Receive permissions on the Kinesis Stream via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version `3`, Values: `pod`, `operator`, Default: `pod`, Optional, This field only applies for `aws-eks` authentication) > When `identityOwner` set to `operator` - the only requirement is that the KEDA operator has the correct IAM permissions on the Kinesis Stream. Additional Authentication Parameters are not required. @@ -45,7 +45,7 @@ You can use `TriggerAuthentication` CRD to configure the authenticate by providi **Role based authentication:** -- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated only applies for `aws-eks` and `aws-kiam` authentications, for `aws` is set in the auth) +- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated and only applies for `aws-eks` authentication, for `aws` is set in the auth) **Credential based authentication:** diff --git a/content/docs/2.15/scalers/aws-sqs.md b/content/docs/2.15/scalers/aws-sqs.md index 8fd0ab305..aba7bbec6 100644 --- a/content/docs/2.15/scalers/aws-sqs.md +++ b/content/docs/2.15/scalers/aws-sqs.md @@ -40,7 +40,7 @@ triggers: - `scaleOfDelayed` - Indication of whether or not to include delayed messages when calculating the number of SQS messages. (default: false, Optional) - `awsRegion` - AWS Region for the SQS Queue. - `awsEndpoint` - Endpoint URL to override the default AWS endpoint. (Default: `""`, Optional) -- `identityOwner` - Receive permissions on the SQS Queue 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) +- `identityOwner` - Receive permissions on the SQS Queue via Pod Identity or from the KEDA operator itself (see below). (DEPRECATED: This parameter is deprecated as of KEDA v2.13 and will be removed in version `3`, Values: `pod`, `operator`, Default: `pod`, Optional, This field only applies for `aws-eks` authentication) > When `identityOwner` set to `operator` - the only requirement is that the KEDA operator has the correct IAM permissions on the SQS queue. Additional Authentication Parameters are not required. @@ -50,11 +50,11 @@ You can use `TriggerAuthentication` CRD to configure the authenticate by providi **Pod identity based authentication:** -- `podIdentity.provider` - Needs to be set to either `aws-kiam` or `aws-eks` on the `TriggerAuthentication` and the pod/service account must be configured correctly for your pod identity provider. +- `podIdentity.provider` - Needs to be set on the `TriggerAuthentication` and the pod/service account must be configured correctly for your pod identity provider. **Role based authentication:** -- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated only applies for `aws-eks` and `aws-kiam` authentications, for `aws` is set in the auth) +- `awsRoleArn` - Amazon Resource Names (ARNs) uniquely identify AWS resource. (This field is deprecated and only applies for `aws-eks` authentication, for `aws` is set in the auth) **Credential based authentication:** @@ -76,7 +76,7 @@ metadata: namespace: keda-test spec: podIdentity: - provider: aws-kiam # or aws-eks when using IRSA + provider: aws --- apiVersion: keda.sh/v1alpha1 kind: ScaledObject diff --git a/content/docs/2.15/scalers/azure-log-analytics.md b/content/docs/2.15/scalers/azure-log-analytics.md index 7debd7e80..fb49826b9 100644 --- a/content/docs/2.15/scalers/azure-log-analytics.md +++ b/content/docs/2.15/scalers/azure-log-analytics.md @@ -297,88 +297,8 @@ spec: ### Guides -#### Enabling managed identity authentication for Log Analytics scaler - -Use the following commands to create user defined identity, role assignment to Azure Log Analytics and deploy\update KEDA: - -```sh -export SUBSCRIPTION_ID="" -export RESOURCE_GROUP="" -export CLUSTER_NAME="" -export CLUSTER_LOCATION="" # "westeurope", "northeurope"... -export IDENTITY_NAME="" #Any name -export LOG_ANALYTICS_RESOURCE_ID="" - -# Login to Azure, set subscription, get AKS credentials -az login -az account set -s "${SUBSCRIPTION_ID}" -az aks get-credentials -n ${CLUSTER_NAME} -g ${RESOURCE_GROUP} - -# ------- Cluster preparation. Run this block only once for fresh cluster. -# Clone repo and run initial role assignment -git clone https://github.com/Azure/aad-pod-identity.git -./aad-pod-identity/hack/role-assignment.sh - -#Deploy aad-pod-identity using Helm 3 -helm repo add aad-pod-identity https://raw.githubusercontent.com/Azure/aad-pod-identity/master/charts -helm repo update -helm install aad-pod-identity aad-pod-identity/aad-pod-identity --namespace=kube-system -# ------------------------------------------------------------------------------------------- - -#Create identity -az identity create -g ${RESOURCE_GROUP} -n ${IDENTITY_NAME} -export IDENTITY_CLIENT_ID="$(az identity show -g ${RESOURCE_GROUP} -n ${IDENTITY_NAME} --query clientId -otsv)" -export IDENTITY_RESOURCE_ID="$(az identity show -g ${RESOURCE_GROUP} -n ${IDENTITY_NAME} --query id -otsv)" - -#Assign reader permissions for your identity to Log Analytics workspace -#WARNING: It can take some time while identity will be provisioned. -#If you see an error: "Principal SOME_ID does not exist in the directory SOME_ID", just wait couple of minutes and then retry. -az role assignment create --role "Log Analytics Reader" --assignee ${IDENTITY_CLIENT_ID} --scope ${LOG_ANALYTICS_RESOURCE_ID} - -# Allow cluster to control identity created earlier. -ID="$(az aks show -g ${RESOURCE_GROUP} -n ${CLUSTER_NAME} --query servicePrincipalProfile.clientId -otsv)" -if [[ "${ID:-}" == "msi" ]]; then - ID="$(az aks show -g ${RESOURCE_GROUP} -n ${CLUSTER_NAME} --query identityProfile.kubeletidentity.clientId -otsv)" -fi -az role assignment create --role "Managed Identity Operator" --assignee "${ID}" --scope "${IDENTITY_RESOURCE_ID}" - -# Create AzureIdentity and AzureIdentityBinding -cat < Date: Fri, 17 May 2024 09:55:14 +0200 Subject: [PATCH 02/31] potential typo in Keda documentation (#1392) Signed-off-by: shubhusion --- content/docs/2.14/concepts/scaling-deployments.md | 6 +++--- content/docs/2.15/concepts/scaling-deployments.md | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/2.14/concepts/scaling-deployments.md b/content/docs/2.14/concepts/scaling-deployments.md index a21a79277..e28392ed9 100644 --- a/content/docs/2.14/concepts/scaling-deployments.md +++ b/content/docs/2.14/concepts/scaling-deployments.md @@ -113,13 +113,13 @@ The `cooldownPeriod` only applies after a trigger occurs; when you first create --- #### initialCooldownPeriod ```yaml - InitialCooldownPeriod: 120 # Optional. Default: 0 seconds + initialCooldownPeriod: 120 # Optional. Default: 0 seconds ``` The delay before the `cooldownPeriod` starts after the initial creation of the `ScaledObject`. By default, this is 0 seconds, meaning the `cooldownPeriod` begins immediately upon creation. If set to a value such as 120 seconds, the `cooldownPeriod` will only start after the `ScaledObject` has been active for that duration. -This parameter is particularly useful for managing the scale-down behavior during the initial phase of a `ScaledObject`. For instance, if `InitialCooldownPeriod` is set to 120 seconds, KEDA will not scale the resource back to 0 until 120 seconds have passed since the `ScaledObject` creation, regardless of the activity triggers. This allows for a grace period in situations where immediate scaling down after creation is not desirable. +This parameter is particularly useful for managing the scale-down behavior during the initial phase of a `ScaledObject`. For instance, if `initialCooldownPeriod` is set to 120 seconds, KEDA will not scale the resource back to 0 until 120 seconds have passed since the `ScaledObject` creation, regardless of the activity triggers. This allows for a grace period in situations where immediate scaling down after creation is not desirable. -**Example:** Wait 120 seconds after the `ScaledObject` is created before starting the `cooldownPeriod`. For instance, if the `InitialCooldownPeriod` is set to 120 seconds, KEDA will not initiate the cooldown process until 120 seconds have passed since the `ScaledObject` was first created, regardless of the triggers' activity. This ensures a buffer period where the resource won’t be scaled down immediately after creation. (Note: This setting is independent of the `pollingInterval`.) +**Example:** Wait 120 seconds after the `ScaledObject` is created before starting the `cooldownPeriod`. For instance, if the `initialCooldownPeriod` is set to 120 seconds, KEDA will not initiate the cooldown process until 120 seconds have passed since the `ScaledObject` was first created, regardless of the triggers' activity. This ensures a buffer period where the resource won’t be scaled down immediately after creation. (Note: This setting is independent of the `pollingInterval`.) --- #### idleReplicaCount diff --git a/content/docs/2.15/concepts/scaling-deployments.md b/content/docs/2.15/concepts/scaling-deployments.md index a21a79277..e28392ed9 100644 --- a/content/docs/2.15/concepts/scaling-deployments.md +++ b/content/docs/2.15/concepts/scaling-deployments.md @@ -113,13 +113,13 @@ The `cooldownPeriod` only applies after a trigger occurs; when you first create --- #### initialCooldownPeriod ```yaml - InitialCooldownPeriod: 120 # Optional. Default: 0 seconds + initialCooldownPeriod: 120 # Optional. Default: 0 seconds ``` The delay before the `cooldownPeriod` starts after the initial creation of the `ScaledObject`. By default, this is 0 seconds, meaning the `cooldownPeriod` begins immediately upon creation. If set to a value such as 120 seconds, the `cooldownPeriod` will only start after the `ScaledObject` has been active for that duration. -This parameter is particularly useful for managing the scale-down behavior during the initial phase of a `ScaledObject`. For instance, if `InitialCooldownPeriod` is set to 120 seconds, KEDA will not scale the resource back to 0 until 120 seconds have passed since the `ScaledObject` creation, regardless of the activity triggers. This allows for a grace period in situations where immediate scaling down after creation is not desirable. +This parameter is particularly useful for managing the scale-down behavior during the initial phase of a `ScaledObject`. For instance, if `initialCooldownPeriod` is set to 120 seconds, KEDA will not scale the resource back to 0 until 120 seconds have passed since the `ScaledObject` creation, regardless of the activity triggers. This allows for a grace period in situations where immediate scaling down after creation is not desirable. -**Example:** Wait 120 seconds after the `ScaledObject` is created before starting the `cooldownPeriod`. For instance, if the `InitialCooldownPeriod` is set to 120 seconds, KEDA will not initiate the cooldown process until 120 seconds have passed since the `ScaledObject` was first created, regardless of the triggers' activity. This ensures a buffer period where the resource won’t be scaled down immediately after creation. (Note: This setting is independent of the `pollingInterval`.) +**Example:** Wait 120 seconds after the `ScaledObject` is created before starting the `cooldownPeriod`. For instance, if the `initialCooldownPeriod` is set to 120 seconds, KEDA will not initiate the cooldown process until 120 seconds have passed since the `ScaledObject` was first created, regardless of the triggers' activity. This ensures a buffer period where the resource won’t be scaled down immediately after creation. (Note: This setting is independent of the `pollingInterval`.) --- #### idleReplicaCount From e73a64a42824c1e45708c8faaaf531076f9a4e53 Mon Sep 17 00:00:00 2001 From: Rob Pickerill Date: Mon, 20 May 2024 12:09:24 +0100 Subject: [PATCH 03/31] update postgres docs for nulls and coalesce (#1393) Signed-off-by: Rob Pickerill Signed-off-by: shubhusion --- content/docs/1.4/scalers/postgresql.md | 2 ++ content/docs/1.5/scalers/postgresql.md | 2 ++ content/docs/2.0/scalers/postgresql.md | 2 ++ content/docs/2.1/scalers/postgresql.md | 2 ++ content/docs/2.10/scalers/postgresql.md | 2 ++ content/docs/2.11/scalers/postgresql.md | 2 ++ content/docs/2.12/scalers/postgresql.md | 2 ++ content/docs/2.13/scalers/postgresql.md | 2 ++ content/docs/2.14/scalers/postgresql.md | 2 ++ content/docs/2.15/scalers/postgresql.md | 4 ++++ content/docs/2.2/scalers/postgresql.md | 2 ++ content/docs/2.3/scalers/postgresql.md | 2 ++ content/docs/2.4/scalers/postgresql.md | 2 ++ content/docs/2.5/scalers/postgresql.md | 2 ++ content/docs/2.6/scalers/postgresql.md | 2 ++ content/docs/2.7/scalers/postgresql.md | 2 ++ content/docs/2.8/scalers/postgresql.md | 2 ++ content/docs/2.9/scalers/postgresql.md | 2 ++ 18 files changed, 38 insertions(+) diff --git a/content/docs/1.4/scalers/postgresql.md b/content/docs/1.4/scalers/postgresql.md index ff52f5df5..d7afbc939 100644 --- a/content/docs/1.4/scalers/postgresql.md +++ b/content/docs/1.4/scalers/postgresql.md @@ -33,6 +33,8 @@ Finally, a user inserts a query that returns the desired value. - `query` - What query to poll postgresql with. Query must return an integer. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string: ```yaml diff --git a/content/docs/1.5/scalers/postgresql.md b/content/docs/1.5/scalers/postgresql.md index ff52f5df5..d7afbc939 100644 --- a/content/docs/1.5/scalers/postgresql.md +++ b/content/docs/1.5/scalers/postgresql.md @@ -33,6 +33,8 @@ Finally, a user inserts a query that returns the desired value. - `query` - What query to poll postgresql with. Query must return an integer. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string: ```yaml diff --git a/content/docs/2.0/scalers/postgresql.md b/content/docs/2.0/scalers/postgresql.md index 21aaae123..a55d9c5e5 100644 --- a/content/docs/2.0/scalers/postgresql.md +++ b/content/docs/2.0/scalers/postgresql.md @@ -31,6 +31,8 @@ Finally, a user inserts a query that returns the desired value. - `query` - What query to poll postgresql with. Query must return an integer. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string: ```yaml diff --git a/content/docs/2.1/scalers/postgresql.md b/content/docs/2.1/scalers/postgresql.md index be36e965b..e7ea26738 100644 --- a/content/docs/2.1/scalers/postgresql.md +++ b/content/docs/2.1/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.10/scalers/postgresql.md b/content/docs/2.10/scalers/postgresql.md index 2bbd57339..2c2d81085 100644 --- a/content/docs/2.10/scalers/postgresql.md +++ b/content/docs/2.10/scalers/postgresql.md @@ -35,6 +35,8 @@ Finally, a user inserts a query that returns the desired value. - `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (DEPRECATED: This parameter is deprecated as of KEDA v2.10 and will be removed in version `2.12`) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.11/scalers/postgresql.md b/content/docs/2.11/scalers/postgresql.md index 2bbd57339..2c2d81085 100644 --- a/content/docs/2.11/scalers/postgresql.md +++ b/content/docs/2.11/scalers/postgresql.md @@ -35,6 +35,8 @@ Finally, a user inserts a query that returns the desired value. - `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (DEPRECATED: This parameter is deprecated as of KEDA v2.10 and will be removed in version `2.12`) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.12/scalers/postgresql.md b/content/docs/2.12/scalers/postgresql.md index eb3147e73..88c3971b2 100644 --- a/content/docs/2.12/scalers/postgresql.md +++ b/content/docs/2.12/scalers/postgresql.md @@ -36,6 +36,8 @@ Finally, a user inserts a query that returns the desired value. This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + ```yaml triggers: - type: postgresql diff --git a/content/docs/2.13/scalers/postgresql.md b/content/docs/2.13/scalers/postgresql.md index eb3147e73..bc55a40b3 100644 --- a/content/docs/2.13/scalers/postgresql.md +++ b/content/docs/2.13/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `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, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.14/scalers/postgresql.md b/content/docs/2.14/scalers/postgresql.md index eb3147e73..bc55a40b3 100644 --- a/content/docs/2.14/scalers/postgresql.md +++ b/content/docs/2.14/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `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, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.15/scalers/postgresql.md b/content/docs/2.15/scalers/postgresql.md index eb3147e73..51b9b9194 100644 --- a/content/docs/2.15/scalers/postgresql.md +++ b/content/docs/2.15/scalers/postgresql.md @@ -34,6 +34,10 @@ Finally, a user inserts a query that returns the desired value. - `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, This value can be a float) + +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.2/scalers/postgresql.md b/content/docs/2.2/scalers/postgresql.md index be36e965b..e7ea26738 100644 --- a/content/docs/2.2/scalers/postgresql.md +++ b/content/docs/2.2/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.3/scalers/postgresql.md b/content/docs/2.3/scalers/postgresql.md index be36e965b..e7ea26738 100644 --- a/content/docs/2.3/scalers/postgresql.md +++ b/content/docs/2.3/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.4/scalers/postgresql.md b/content/docs/2.4/scalers/postgresql.md index be36e965b..e7ea26738 100644 --- a/content/docs/2.4/scalers/postgresql.md +++ b/content/docs/2.4/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.5/scalers/postgresql.md b/content/docs/2.5/scalers/postgresql.md index 2ccdb8cf0..e0caf3a67 100644 --- a/content/docs/2.5/scalers/postgresql.md +++ b/content/docs/2.5/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.6/scalers/postgresql.md b/content/docs/2.6/scalers/postgresql.md index 2ccdb8cf0..e0caf3a67 100644 --- a/content/docs/2.6/scalers/postgresql.md +++ b/content/docs/2.6/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetAverageValue` in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.7/scalers/postgresql.md b/content/docs/2.7/scalers/postgresql.md index 6342cebf8..1d2e88df3 100644 --- a/content/docs/2.7/scalers/postgresql.md +++ b/content/docs/2.7/scalers/postgresql.md @@ -34,6 +34,8 @@ Finally, a user inserts a query that returns the desired value. - `targetQueryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.8/scalers/postgresql.md b/content/docs/2.8/scalers/postgresql.md index 10dffca3f..ab963e4b5 100644 --- a/content/docs/2.8/scalers/postgresql.md +++ b/content/docs/2.8/scalers/postgresql.md @@ -35,6 +35,8 @@ Finally, a user inserts a query that returns the desired value. - `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml diff --git a/content/docs/2.9/scalers/postgresql.md b/content/docs/2.9/scalers/postgresql.md index 10dffca3f..ab963e4b5 100644 --- a/content/docs/2.9/scalers/postgresql.md +++ b/content/docs/2.9/scalers/postgresql.md @@ -35,6 +35,8 @@ Finally, a user inserts a query that returns the desired value. - `activationTargetQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `metricName` - Name to assign to the metric. If not set KEDA will generate a name based on either the connection string if set or the db name. If using more than one trigger it is required that all metricNames be unique. (Optional) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [PostgreSQL documentation](https://www.postgresql.org/docs/current/functions-conditional.html#FUNCTIONS-COALESCE-NVL-IFNULL) for more information on the `COALESCE` function. + This is an example of using a full connection string with `AIRFLOW_CONN_AIRFLOW_DB` set as `postgresql://test@localhost`: ```yaml From a3c88edc43b2cc62dee8ddc8cef37ead3e4066ba Mon Sep 17 00:00:00 2001 From: Rob Pickerill Date: Thu, 23 May 2024 09:49:15 +0100 Subject: [PATCH 04/31] add note for null and coalesce for mysql (#1396) Signed-off-by: robpickerill Signed-off-by: shubhusion --- content/docs/1.4/scalers/mysql.md | 2 ++ content/docs/1.5/scalers/mysql.md | 2 ++ content/docs/2.0/scalers/mysql.md | 2 ++ content/docs/2.1/scalers/mysql.md | 2 ++ content/docs/2.10/scalers/mysql.md | 2 ++ content/docs/2.11/scalers/mysql.md | 2 ++ content/docs/2.12/scalers/mysql.md | 2 ++ content/docs/2.13/scalers/mysql.md | 2 ++ content/docs/2.14/scalers/mysql.md | 2 ++ content/docs/2.15/scalers/mysql.md | 2 ++ content/docs/2.2/scalers/mysql.md | 2 ++ content/docs/2.3/scalers/mysql.md | 2 ++ content/docs/2.4/scalers/mysql.md | 2 ++ content/docs/2.5/scalers/mysql.md | 2 ++ content/docs/2.6/scalers/mysql.md | 2 ++ content/docs/2.7/scalers/mysql.md | 2 ++ content/docs/2.8/scalers/mysql.md | 2 ++ content/docs/2.9/scalers/mysql.md | 2 ++ 18 files changed, 36 insertions(+) diff --git a/content/docs/1.4/scalers/mysql.md b/content/docs/1.4/scalers/mysql.md index b2f5eafdd..4e8c611e0 100644 --- a/content/docs/1.4/scalers/mysql.md +++ b/content/docs/1.4/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionString` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/1.5/scalers/mysql.md b/content/docs/1.5/scalers/mysql.md index b2f5eafdd..4e8c611e0 100644 --- a/content/docs/1.5/scalers/mysql.md +++ b/content/docs/1.5/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionString` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.0/scalers/mysql.md b/content/docs/2.0/scalers/mysql.md index 80703b21f..aa5931b4e 100644 --- a/content/docs/2.0/scalers/mysql.md +++ b/content/docs/2.0/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` MySQL connection string that should point to environment variable with valid value diff --git a/content/docs/2.1/scalers/mysql.md b/content/docs/2.1/scalers/mysql.md index 80703b21f..aa5931b4e 100644 --- a/content/docs/2.1/scalers/mysql.md +++ b/content/docs/2.1/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` MySQL connection string that should point to environment variable with valid value diff --git a/content/docs/2.10/scalers/mysql.md b/content/docs/2.10/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.10/scalers/mysql.md +++ b/content/docs/2.10/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.11/scalers/mysql.md b/content/docs/2.11/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.11/scalers/mysql.md +++ b/content/docs/2.11/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.12/scalers/mysql.md b/content/docs/2.12/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.12/scalers/mysql.md +++ b/content/docs/2.12/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.13/scalers/mysql.md b/content/docs/2.13/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.13/scalers/mysql.md +++ b/content/docs/2.13/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.14/scalers/mysql.md b/content/docs/2.14/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.14/scalers/mysql.md +++ b/content/docs/2.14/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.15/scalers/mysql.md b/content/docs/2.15/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.15/scalers/mysql.md +++ b/content/docs/2.15/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.2/scalers/mysql.md b/content/docs/2.2/scalers/mysql.md index 80703b21f..aa5931b4e 100644 --- a/content/docs/2.2/scalers/mysql.md +++ b/content/docs/2.2/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` MySQL connection string that should point to environment variable with valid value diff --git a/content/docs/2.3/scalers/mysql.md b/content/docs/2.3/scalers/mysql.md index 80703b21f..aa5931b4e 100644 --- a/content/docs/2.3/scalers/mysql.md +++ b/content/docs/2.3/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` MySQL connection string that should point to environment variable with valid value diff --git a/content/docs/2.4/scalers/mysql.md b/content/docs/2.4/scalers/mysql.md index 80703b21f..aa5931b4e 100644 --- a/content/docs/2.4/scalers/mysql.md +++ b/content/docs/2.4/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` MySQL connection string that should point to environment variable with valid value diff --git a/content/docs/2.5/scalers/mysql.md b/content/docs/2.5/scalers/mysql.md index 1866bd303..750bfde77 100644 --- a/content/docs/2.5/scalers/mysql.md +++ b/content/docs/2.5/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.6/scalers/mysql.md b/content/docs/2.6/scalers/mysql.md index 1866bd303..750bfde77 100644 --- a/content/docs/2.6/scalers/mysql.md +++ b/content/docs/2.6/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetAverageValue` in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.7/scalers/mysql.md b/content/docs/2.7/scalers/mysql.md index 53ede114c..7191ed86b 100644 --- a/content/docs/2.7/scalers/mysql.md +++ b/content/docs/2.7/scalers/mysql.md @@ -15,6 +15,8 @@ The trigger always requires the following information: - `query` - A MySQL query that should return single numeric value. - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.8/scalers/mysql.md b/content/docs/2.8/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.8/scalers/mysql.md +++ b/content/docs/2.8/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. diff --git a/content/docs/2.9/scalers/mysql.md b/content/docs/2.9/scalers/mysql.md index 1720a3fb9..2ac08c531 100644 --- a/content/docs/2.9/scalers/mysql.md +++ b/content/docs/2.9/scalers/mysql.md @@ -16,6 +16,8 @@ The trigger always requires the following information: - `queryValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in HPA. (This value can be a float) - `activationQueryValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MySQL documentation](https://dev.mysql.com/doc/refman/8.4/en/comparison-operators.html#function_coalesce) for more information on the `COALESCE` function. + To provide information about how to connect to MySQL you can provide: - `connectionStringFromEnv` - MySQL connection string that should point to environment variable with valid value. From b629da7f174be3eba45315a9138147ed2c252195 Mon Sep 17 00:00:00 2001 From: Rob Pickerill Date: Thu, 23 May 2024 09:49:37 +0100 Subject: [PATCH 05/31] add note for null and coalesce for mssql (#1397) Signed-off-by: robpickerill Signed-off-by: shubhusion --- content/docs/2.10/scalers/mssql.md | 2 ++ content/docs/2.11/scalers/mssql.md | 2 ++ content/docs/2.12/scalers/mssql.md | 2 ++ content/docs/2.13/scalers/mssql.md | 2 ++ content/docs/2.14/scalers/mssql.md | 2 ++ content/docs/2.15/scalers/mssql.md | 2 ++ content/docs/2.2/scalers/mssql.md | 2 ++ content/docs/2.3/scalers/mssql.md | 2 ++ content/docs/2.4/scalers/mssql.md | 2 ++ content/docs/2.5/scalers/mssql.md | 2 ++ content/docs/2.6/scalers/mssql.md | 2 ++ content/docs/2.7/scalers/mssql.md | 2 ++ content/docs/2.8/scalers/mssql.md | 2 ++ content/docs/2.9/scalers/mssql.md | 2 ++ 14 files changed, 28 insertions(+) diff --git a/content/docs/2.10/scalers/mssql.md b/content/docs/2.10/scalers/mssql.md index 3adf8ab04..4ee555e77 100644 --- a/content/docs/2.10/scalers/mssql.md +++ b/content/docs/2.10/scalers/mssql.md @@ -45,6 +45,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.11/scalers/mssql.md b/content/docs/2.11/scalers/mssql.md index 3adf8ab04..4ee555e77 100644 --- a/content/docs/2.11/scalers/mssql.md +++ b/content/docs/2.11/scalers/mssql.md @@ -45,6 +45,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.12/scalers/mssql.md b/content/docs/2.12/scalers/mssql.md index 2bea2852d..98839f2d2 100644 --- a/content/docs/2.12/scalers/mssql.md +++ b/content/docs/2.12/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.13/scalers/mssql.md b/content/docs/2.13/scalers/mssql.md index 2bea2852d..98839f2d2 100644 --- a/content/docs/2.13/scalers/mssql.md +++ b/content/docs/2.13/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.14/scalers/mssql.md b/content/docs/2.14/scalers/mssql.md index 2bea2852d..98839f2d2 100644 --- a/content/docs/2.14/scalers/mssql.md +++ b/content/docs/2.14/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.15/scalers/mssql.md b/content/docs/2.15/scalers/mssql.md index 2bea2852d..98839f2d2 100644 --- a/content/docs/2.15/scalers/mssql.md +++ b/content/docs/2.15/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.2/scalers/mssql.md b/content/docs/2.2/scalers/mssql.md index de20b3593..e7542a3f5 100644 --- a/content/docs/2.2/scalers/mssql.md +++ b/content/docs/2.2/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `query` - A [T-SQL](https://docs.microsoft.com/sql/t-sql/language-reference) query that returns a single numeric value. This can be a regular query or the name of a stored procedure. - `targetValue` - A threshold that is used as `targetAverageValue` in the Horizontal Pod Autoscaler (HPA). +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.3/scalers/mssql.md b/content/docs/2.3/scalers/mssql.md index de20b3593..e7542a3f5 100644 --- a/content/docs/2.3/scalers/mssql.md +++ b/content/docs/2.3/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `query` - A [T-SQL](https://docs.microsoft.com/sql/t-sql/language-reference) query that returns a single numeric value. This can be a regular query or the name of a stored procedure. - `targetValue` - A threshold that is used as `targetAverageValue` in the Horizontal Pod Autoscaler (HPA). +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.4/scalers/mssql.md b/content/docs/2.4/scalers/mssql.md index de20b3593..e7542a3f5 100644 --- a/content/docs/2.4/scalers/mssql.md +++ b/content/docs/2.4/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `query` - A [T-SQL](https://docs.microsoft.com/sql/t-sql/language-reference) query that returns a single numeric value. This can be a regular query or the name of a stored procedure. - `targetValue` - A threshold that is used as `targetAverageValue` in the Horizontal Pod Autoscaler (HPA). +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.5/scalers/mssql.md b/content/docs/2.5/scalers/mssql.md index 846047e84..5c6d17a54 100644 --- a/content/docs/2.5/scalers/mssql.md +++ b/content/docs/2.5/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `query` - A [T-SQL](https://docs.microsoft.com/sql/t-sql/language-reference) query that returns a single numeric value. This can be a regular query or the name of a stored procedure. - `targetValue` - A threshold that is used as `targetAverageValue` in the Horizontal Pod Autoscaler (HPA). +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.6/scalers/mssql.md b/content/docs/2.6/scalers/mssql.md index 846047e84..5c6d17a54 100644 --- a/content/docs/2.6/scalers/mssql.md +++ b/content/docs/2.6/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `query` - A [T-SQL](https://docs.microsoft.com/sql/t-sql/language-reference) query that returns a single numeric value. This can be a regular query or the name of a stored procedure. - `targetValue` - A threshold that is used as `targetAverageValue` in the Horizontal Pod Autoscaler (HPA). +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.7/scalers/mssql.md b/content/docs/2.7/scalers/mssql.md index acd3fcb3d..517e4cc52 100644 --- a/content/docs/2.7/scalers/mssql.md +++ b/content/docs/2.7/scalers/mssql.md @@ -43,6 +43,8 @@ The `mssql` trigger always requires the following information: - `query` - A [T-SQL](https://docs.microsoft.com/sql/t-sql/language-reference) query that returns a single numeric value. This can be a regular query or the name of a stored procedure. - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.8/scalers/mssql.md b/content/docs/2.8/scalers/mssql.md index d1af07b9e..b0b7ca14a 100644 --- a/content/docs/2.8/scalers/mssql.md +++ b/content/docs/2.8/scalers/mssql.md @@ -45,6 +45,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. diff --git a/content/docs/2.9/scalers/mssql.md b/content/docs/2.9/scalers/mssql.md index d1af07b9e..b0b7ca14a 100644 --- a/content/docs/2.9/scalers/mssql.md +++ b/content/docs/2.9/scalers/mssql.md @@ -45,6 +45,8 @@ The `mssql` trigger always requires the following information: - `targetValue` - A threshold that is used as `targetValue` or `targetAverageValue` (depending on the trigger metric type) in the Horizontal Pod Autoscaler (HPA). (This value can be a float) - `activationTargetValue` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) +> Note that the query must return a single integer value. If the query has a possibility of returning `null`, a default value can be set using the `COALESCE` function. For example, `SELECT COALESCE(column_name, 0) FROM table_name;`. See [MSSQL documentation](https://learn.microsoft.com/en-us/sql/t-sql/language-elements/coalesce-transact-sql) for more information on the `COALESCE` function. + To connect to the MSSQL instance, you can provide either: - `connectionStringFromEnv` - The name of an environment variable containing a valid MSSQL connection string. From 6145ce397864a29302a56f0a17c2ed4e55cdb6e8 Mon Sep 17 00:00:00 2001 From: Alon Gluz Date: Wed, 29 May 2024 13:56:56 +0300 Subject: [PATCH 06/31] fix a typo (#1399) Signed-off-by: Alon Gluz Signed-off-by: shubhusion --- content/docs/2.12/concepts/scaling-deployments.md | 4 ++-- content/docs/2.13/concepts/scaling-deployments.md | 4 ++-- content/docs/2.14/concepts/scaling-deployments.md | 4 ++-- content/docs/2.15/concepts/scaling-deployments.md | 4 ++-- 4 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/docs/2.12/concepts/scaling-deployments.md b/content/docs/2.12/concepts/scaling-deployments.md index 8d2ceb83a..eccb41e4b 100644 --- a/content/docs/2.12/concepts/scaling-deployments.md +++ b/content/docs/2.12/concepts/scaling-deployments.md @@ -345,7 +345,7 @@ advanced: formula: "count([trig_one,trig_two,trig_three],{#>1}) > 1 ? 5 : 0" ``` -If atleast 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 +If at least 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 **Example: nested conditions and operators** @@ -356,7 +356,7 @@ advanced: ``` Conditions can be used within another condition as well. -If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is atleast 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. +If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is at least 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. Complete language definition of `expr` package can be found [here](https://expr.medv.io/docs/Language-Definition). Formula must return a single value (not boolean) ### Activating and Scaling thresholds diff --git a/content/docs/2.13/concepts/scaling-deployments.md b/content/docs/2.13/concepts/scaling-deployments.md index f791c7f0e..248e17148 100644 --- a/content/docs/2.13/concepts/scaling-deployments.md +++ b/content/docs/2.13/concepts/scaling-deployments.md @@ -345,7 +345,7 @@ advanced: formula: "count([trig_one,trig_two,trig_three],{#>1}) > 1 ? 5 : 0" ``` -If atleast 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 +If at least 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 **Example: nested conditions and operators** @@ -356,7 +356,7 @@ advanced: ``` Conditions can be used within another condition as well. -If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is atleast 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. +If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is at least 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. Complete language definition of `expr` package can be found [here](https://expr.medv.io/docs/Language-Definition). Formula must return a single value (not boolean). All formulas are internally wrapped with float cast. ### Activating and Scaling thresholds diff --git a/content/docs/2.14/concepts/scaling-deployments.md b/content/docs/2.14/concepts/scaling-deployments.md index e28392ed9..94594d562 100644 --- a/content/docs/2.14/concepts/scaling-deployments.md +++ b/content/docs/2.14/concepts/scaling-deployments.md @@ -356,7 +356,7 @@ advanced: formula: "count([trig_one,trig_two,trig_three],{#>1}) > 1 ? 5 : 0" ``` -If atleast 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 +If at least 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 **Example: nested conditions and operators** @@ -367,7 +367,7 @@ advanced: ``` Conditions can be used within another condition as well. -If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is atleast 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. +If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is at least 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. Complete language definition of `expr` package can be found [here](https://expr.medv.io/docs/Language-Definition). Formula must return a single value (not boolean). All formulas are internally wrapped with float cast. ### Activating and Scaling thresholds diff --git a/content/docs/2.15/concepts/scaling-deployments.md b/content/docs/2.15/concepts/scaling-deployments.md index e28392ed9..94594d562 100644 --- a/content/docs/2.15/concepts/scaling-deployments.md +++ b/content/docs/2.15/concepts/scaling-deployments.md @@ -356,7 +356,7 @@ advanced: formula: "count([trig_one,trig_two,trig_three],{#>1}) > 1 ? 5 : 0" ``` -If atleast 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 +If at least 2 metrics (from the list `trig_one`,`trig_two`,`trig_three`) have value of more than 1, then return 5, otherwise return 0 **Example: nested conditions and operators** @@ -367,7 +367,7 @@ advanced: ``` Conditions can be used within another condition as well. -If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is atleast 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. +If value of `trig_one` is less than 2 AND `trig_one`+`trig_two` is at least 2 then return 5, if only the first is true return 10, if the first condition is false then return 0. Complete language definition of `expr` package can be found [here](https://expr.medv.io/docs/Language-Definition). Formula must return a single value (not boolean). All formulas are internally wrapped with float cast. ### Activating and Scaling thresholds From dbd66c1d22fb52664359670414abb7c62fcd3fba Mon Sep 17 00:00:00 2001 From: Alec Hinh Date: Wed, 29 May 2024 05:57:51 -0500 Subject: [PATCH 07/31] Prometheus: Mark queryParameters as an optional field instead of an required field (#1395) * Move queryParameters down to the optional field list Signed-off-by: Alec Hinh * Move the query parameters list entries down to optional in the other versions Signed-off-by: Alec Hinh --------- Signed-off-by: Alec Hinh Signed-off-by: shubhusion --- content/docs/2.13/scalers/prometheus.md | 4 ++-- content/docs/2.14/scalers/prometheus.md | 4 ++-- content/docs/2.15/scalers/prometheus.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/content/docs/2.13/scalers/prometheus.md b/content/docs/2.13/scalers/prometheus.md index 889524132..a84d40f8a 100644 --- a/content/docs/2.13/scalers/prometheus.md +++ b/content/docs/2.13/scalers/prometheus.md @@ -17,7 +17,6 @@ triggers: # Required fields: serverAddress: http://:9090 query: sum(rate(http_requests_total{deployment="my-deployment"}[2m])) # Note: query must return a vector/scalar single element response - queryParameters: key-1=value-1,key-2=value-2 threshold: '100.50' activationThreshold: '5.5' # Optional fields: @@ -25,6 +24,7 @@ triggers: cortexOrgID: my-org # DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of customHeaders and will be removed in version 2.12. Use custom headers instead to set X-Scope-OrgID header for Cortex. (see below) customHeaders: X-Client-Id=cid,X-Tenant-Id=tid,X-Organization-Id=oid # Optional. Custom headers to include in query. In case of auth header, use the custom authentication or relevant authModes. ignoreNullValues: false # Default is `true`, which means ignoring the empty value list from Prometheus. Set to `false` the scaler will return error when Prometheus target is lost + queryParameters: key-1=value-1,key-2=value-2 unsafeSsl: "false" # Default is `false`, Used for skipping certificate check when having self-signed certs for Prometheus endpoint ``` @@ -33,13 +33,13 @@ triggers: - `serverAddress` - Address of Prometheus server. If using VictoriaMetrics cluster version, set full URL to Prometheus querying API, e.g. `http://:8481/select/0/prometheus` - `query` - Query to run. -- `queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. - `threshold` - Value to start scaling for. (This value can be a float) - `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional) - `cortexOrgID` - DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of `customHeaders` and will be removed in version 2.12. Use `customHeaders: X-Scope-OrgID=##` instead to query multi tenant [Cortex](https://cortexmetrics.io/) or [Mimir](https://grafana.com/oss/mimir/). (Optional) - `customHeaders` - Custom headers to include while querying the prometheus endpoint. In case of authentication headers, use custom authentication or relevant `authModes` instead. (Optional) - `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional) +- `queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs (Values: `true`,`false`, Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.14/scalers/prometheus.md b/content/docs/2.14/scalers/prometheus.md index 889524132..a84d40f8a 100644 --- a/content/docs/2.14/scalers/prometheus.md +++ b/content/docs/2.14/scalers/prometheus.md @@ -17,7 +17,6 @@ triggers: # Required fields: serverAddress: http://:9090 query: sum(rate(http_requests_total{deployment="my-deployment"}[2m])) # Note: query must return a vector/scalar single element response - queryParameters: key-1=value-1,key-2=value-2 threshold: '100.50' activationThreshold: '5.5' # Optional fields: @@ -25,6 +24,7 @@ triggers: cortexOrgID: my-org # DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of customHeaders and will be removed in version 2.12. Use custom headers instead to set X-Scope-OrgID header for Cortex. (see below) customHeaders: X-Client-Id=cid,X-Tenant-Id=tid,X-Organization-Id=oid # Optional. Custom headers to include in query. In case of auth header, use the custom authentication or relevant authModes. ignoreNullValues: false # Default is `true`, which means ignoring the empty value list from Prometheus. Set to `false` the scaler will return error when Prometheus target is lost + queryParameters: key-1=value-1,key-2=value-2 unsafeSsl: "false" # Default is `false`, Used for skipping certificate check when having self-signed certs for Prometheus endpoint ``` @@ -33,13 +33,13 @@ triggers: - `serverAddress` - Address of Prometheus server. If using VictoriaMetrics cluster version, set full URL to Prometheus querying API, e.g. `http://:8481/select/0/prometheus` - `query` - Query to run. -- `queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. - `threshold` - Value to start scaling for. (This value can be a float) - `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional) - `cortexOrgID` - DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of `customHeaders` and will be removed in version 2.12. Use `customHeaders: X-Scope-OrgID=##` instead to query multi tenant [Cortex](https://cortexmetrics.io/) or [Mimir](https://grafana.com/oss/mimir/). (Optional) - `customHeaders` - Custom headers to include while querying the prometheus endpoint. In case of authentication headers, use custom authentication or relevant `authModes` instead. (Optional) - `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional) +- `queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs (Values: `true`,`false`, Default: `false`, Optional) ### Authentication Parameters diff --git a/content/docs/2.15/scalers/prometheus.md b/content/docs/2.15/scalers/prometheus.md index 889524132..a84d40f8a 100644 --- a/content/docs/2.15/scalers/prometheus.md +++ b/content/docs/2.15/scalers/prometheus.md @@ -17,7 +17,6 @@ triggers: # Required fields: serverAddress: http://:9090 query: sum(rate(http_requests_total{deployment="my-deployment"}[2m])) # Note: query must return a vector/scalar single element response - queryParameters: key-1=value-1,key-2=value-2 threshold: '100.50' activationThreshold: '5.5' # Optional fields: @@ -25,6 +24,7 @@ triggers: cortexOrgID: my-org # DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of customHeaders and will be removed in version 2.12. Use custom headers instead to set X-Scope-OrgID header for Cortex. (see below) customHeaders: X-Client-Id=cid,X-Tenant-Id=tid,X-Organization-Id=oid # Optional. Custom headers to include in query. In case of auth header, use the custom authentication or relevant authModes. ignoreNullValues: false # Default is `true`, which means ignoring the empty value list from Prometheus. Set to `false` the scaler will return error when Prometheus target is lost + queryParameters: key-1=value-1,key-2=value-2 unsafeSsl: "false" # Default is `false`, Used for skipping certificate check when having self-signed certs for Prometheus endpoint ``` @@ -33,13 +33,13 @@ triggers: - `serverAddress` - Address of Prometheus server. If using VictoriaMetrics cluster version, set full URL to Prometheus querying API, e.g. `http://:8481/select/0/prometheus` - `query` - Query to run. -- `queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. - `threshold` - Value to start scaling for. (This value can be a float) - `activationThreshold` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional, This value can be a float) - `namespace` - A namespace that should be used for namespaced queries. These are required by some highly available Prometheus setups, such as [Thanos](https://thanos.io). (Optional) - `cortexOrgID` - DEPRECATED: This parameter is deprecated as of KEDA v2.10 in favor of `customHeaders` and will be removed in version 2.12. Use `customHeaders: X-Scope-OrgID=##` instead to query multi tenant [Cortex](https://cortexmetrics.io/) or [Mimir](https://grafana.com/oss/mimir/). (Optional) - `customHeaders` - Custom headers to include while querying the prometheus endpoint. In case of authentication headers, use custom authentication or relevant `authModes` instead. (Optional) - `ignoreNullValues` - Value to reporting error when Prometheus target is lost (Values: `true`,`false`, Default: `true`, Optional) +- `queryParameters` - A comma-separated list of query Parameters to include while querying the Prometheus endpoint. (Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs (Values: `true`,`false`, Default: `false`, Optional) ### Authentication Parameters From 7cb0055eda6ea72c71890dbb640583f9bfebd62b Mon Sep 17 00:00:00 2001 From: Tom Kerkhove Date: Tue, 11 Jun 2024 09:47:48 +0200 Subject: [PATCH 08/31] feat: Introduce category per scale (2.14+) (#1405) Signed-off-by: shubhusion --- content/docs/2.14/scalers/activemq.md | 1 + content/docs/2.14/scalers/apache-kafka-go.md | 1 + content/docs/2.14/scalers/apache-kafka.md | 1 + content/docs/2.14/scalers/arangodb.md | 1 + content/docs/2.14/scalers/artemis.md | 1 + content/docs/2.14/scalers/aws-cloudwatch.md | 1 + content/docs/2.14/scalers/aws-dynamodb-streams.md | 1 + content/docs/2.14/scalers/aws-dynamodb.md | 1 + content/docs/2.14/scalers/aws-kinesis.md | 1 + content/docs/2.14/scalers/aws-sqs.md | 1 + content/docs/2.14/scalers/azure-app-insights.md | 1 + content/docs/2.14/scalers/azure-data-explorer.md | 1 + content/docs/2.14/scalers/azure-event-hub.md | 1 + content/docs/2.14/scalers/azure-log-analytics.md | 1 + content/docs/2.14/scalers/azure-monitor.md | 1 + content/docs/2.14/scalers/azure-pipelines.md | 1 + content/docs/2.14/scalers/azure-service-bus.md | 1 + content/docs/2.14/scalers/azure-storage-blob.md | 1 + content/docs/2.14/scalers/azure-storage-queue.md | 1 + content/docs/2.14/scalers/cassandra.md | 1 + content/docs/2.14/scalers/couchdb.md | 1 + content/docs/2.14/scalers/cpu.md | 1 + content/docs/2.14/scalers/cron.md | 1 + content/docs/2.14/scalers/datadog.md | 1 + content/docs/2.14/scalers/elasticsearch.md | 1 + content/docs/2.14/scalers/etcd.md | 1 + content/docs/2.14/scalers/external-push.md | 1 + content/docs/2.14/scalers/external.md | 1 + content/docs/2.14/scalers/gcp-cloud-tasks.md | 8 ++++---- content/docs/2.14/scalers/gcp-pub-sub.md | 9 +++++---- content/docs/2.14/scalers/gcp-stackdriver.md | 1 + content/docs/2.14/scalers/gcp-storage.md | 1 + content/docs/2.14/scalers/github-runner.md | 1 + content/docs/2.14/scalers/graphite.md | 1 + content/docs/2.14/scalers/huawei-cloudeye.md | 1 + content/docs/2.14/scalers/ibm-mq.md | 1 + content/docs/2.14/scalers/influxdb.md | 1 + content/docs/2.14/scalers/kubernetes-workload.md | 1 + content/docs/2.14/scalers/liiklus-topic.md | 1 + content/docs/2.14/scalers/memory.md | 1 + content/docs/2.14/scalers/metrics-api.md | 1 + content/docs/2.14/scalers/mongodb.md | 1 + content/docs/2.14/scalers/mssql.md | 1 + content/docs/2.14/scalers/mysql.md | 1 + content/docs/2.14/scalers/nats-jetstream.md | 1 + content/docs/2.14/scalers/nats-streaming.md | 1 + content/docs/2.14/scalers/new-relic.md | 1 + content/docs/2.14/scalers/openstack-metric.md | 1 + content/docs/2.14/scalers/openstack-swift.md | 1 + content/docs/2.14/scalers/postgresql.md | 1 + content/docs/2.14/scalers/predictkube.md | 1 + content/docs/2.14/scalers/prometheus.md | 1 + content/docs/2.14/scalers/pulsar.md | 1 + content/docs/2.14/scalers/rabbitmq-queue.md | 1 + content/docs/2.14/scalers/redis-cluster-lists.md | 1 + content/docs/2.14/scalers/redis-cluster-streams.md | 1 + content/docs/2.14/scalers/redis-lists.md | 1 + content/docs/2.14/scalers/redis-sentinel-lists.md | 1 + content/docs/2.14/scalers/redis-sentinel-streams.md | 1 + content/docs/2.14/scalers/redis-streams.md | 1 + content/docs/2.14/scalers/selenium-grid-scaler.md | 1 + content/docs/2.14/scalers/solace-pub-sub.md | 1 + content/docs/2.14/scalers/solr.md | 1 + content/docs/2.15/scalers/activemq.md | 1 + content/docs/2.15/scalers/apache-kafka-go.md | 1 + content/docs/2.15/scalers/apache-kafka.md | 1 + content/docs/2.15/scalers/arangodb.md | 1 + content/docs/2.15/scalers/artemis.md | 1 + content/docs/2.15/scalers/aws-cloudwatch.md | 1 + content/docs/2.15/scalers/aws-dynamodb-streams.md | 1 + content/docs/2.15/scalers/aws-dynamodb.md | 1 + content/docs/2.15/scalers/aws-kinesis.md | 1 + content/docs/2.15/scalers/aws-sqs.md | 1 + content/docs/2.15/scalers/azure-app-insights.md | 1 + content/docs/2.15/scalers/azure-data-explorer.md | 1 + content/docs/2.15/scalers/azure-event-hub.md | 1 + content/docs/2.15/scalers/azure-log-analytics.md | 1 + content/docs/2.15/scalers/azure-monitor.md | 1 + content/docs/2.15/scalers/azure-pipelines.md | 1 + content/docs/2.15/scalers/azure-service-bus.md | 1 + content/docs/2.15/scalers/azure-storage-blob.md | 1 + content/docs/2.15/scalers/azure-storage-queue.md | 1 + content/docs/2.15/scalers/cassandra.md | 1 + content/docs/2.15/scalers/couchdb.md | 1 + content/docs/2.15/scalers/cpu.md | 1 + content/docs/2.15/scalers/cron.md | 1 + content/docs/2.15/scalers/datadog.md | 1 + content/docs/2.15/scalers/elasticsearch.md | 1 + content/docs/2.15/scalers/etcd.md | 1 + content/docs/2.15/scalers/external-push.md | 1 + content/docs/2.15/scalers/external.md | 1 + content/docs/2.15/scalers/gcp-cloud-tasks.md | 8 ++++---- content/docs/2.15/scalers/gcp-pub-sub.md | 9 +++++---- content/docs/2.15/scalers/gcp-stackdriver.md | 1 + content/docs/2.15/scalers/gcp-storage.md | 1 + content/docs/2.15/scalers/github-runner.md | 1 + content/docs/2.15/scalers/graphite.md | 1 + content/docs/2.15/scalers/huawei-cloudeye.md | 1 + content/docs/2.15/scalers/ibm-mq.md | 1 + content/docs/2.15/scalers/influxdb.md | 1 + content/docs/2.15/scalers/kubernetes-workload.md | 1 + content/docs/2.15/scalers/liiklus-topic.md | 1 + content/docs/2.15/scalers/loki.md | 1 + content/docs/2.15/scalers/memory.md | 1 + content/docs/2.15/scalers/metrics-api.md | 1 + content/docs/2.15/scalers/mongodb.md | 1 + content/docs/2.15/scalers/mssql.md | 1 + content/docs/2.15/scalers/mysql.md | 1 + content/docs/2.15/scalers/nats-jetstream.md | 1 + content/docs/2.15/scalers/nats-streaming.md | 1 + content/docs/2.15/scalers/new-relic.md | 1 + content/docs/2.15/scalers/openstack-metric.md | 1 + content/docs/2.15/scalers/openstack-swift.md | 1 + content/docs/2.15/scalers/postgresql.md | 1 + content/docs/2.15/scalers/predictkube.md | 1 + content/docs/2.15/scalers/prometheus.md | 1 + content/docs/2.15/scalers/pulsar.md | 1 + content/docs/2.15/scalers/rabbitmq-queue.md | 1 + content/docs/2.15/scalers/redis-cluster-lists.md | 1 + content/docs/2.15/scalers/redis-cluster-streams.md | 1 + content/docs/2.15/scalers/redis-lists.md | 1 + content/docs/2.15/scalers/redis-sentinel-lists.md | 1 + content/docs/2.15/scalers/redis-sentinel-streams.md | 1 + content/docs/2.15/scalers/redis-streams.md | 1 + content/docs/2.15/scalers/selenium-grid-scaler.md | 1 + content/docs/2.15/scalers/solace-pub-sub.md | 1 + content/docs/2.15/scalers/solr.md | 1 + 127 files changed, 141 insertions(+), 16 deletions(-) diff --git a/content/docs/2.14/scalers/activemq.md b/content/docs/2.14/scalers/activemq.md index a970f9566..b9c012798 100644 --- a/content/docs/2.14/scalers/activemq.md +++ b/content/docs/2.14/scalers/activemq.md @@ -2,6 +2,7 @@ title = "ActiveMQ" availability = "v2.6+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on ActiveMQ Queue." go_file = "activemq_scaler" +++ diff --git a/content/docs/2.14/scalers/apache-kafka-go.md b/content/docs/2.14/scalers/apache-kafka-go.md index 8c69ca0de..e2c7b7fd8 100644 --- a/content/docs/2.14/scalers/apache-kafka-go.md +++ b/content/docs/2.14/scalers/apache-kafka-go.md @@ -2,6 +2,7 @@ title = "Apache Kafka (Experimental)" availability = "v2.12+" maintainer = "Community" +category = "Messaging" description = "Experimental scaler based on 'segmentio/kafka-go' library. Scale applications based on an Apache Kafka topic or other services that support Kafka protocol." go_file = "apache_kafka_scaler" +++ diff --git a/content/docs/2.14/scalers/apache-kafka.md b/content/docs/2.14/scalers/apache-kafka.md index 5a66cae58..15414f5d5 100644 --- a/content/docs/2.14/scalers/apache-kafka.md +++ b/content/docs/2.14/scalers/apache-kafka.md @@ -2,6 +2,7 @@ title = "Apache Kafka" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on an Apache Kafka topic or other services that support Kafka protocol." go_file = "kafka_scaler" +++ diff --git a/content/docs/2.14/scalers/arangodb.md b/content/docs/2.14/scalers/arangodb.md index 81ac3cec3..53b527850 100644 --- a/content/docs/2.14/scalers/arangodb.md +++ b/content/docs/2.14/scalers/arangodb.md @@ -2,6 +2,7 @@ title = "ArangoDB" availability = "v2.10+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on ArangoDB query result." go_file = "arangodb_scaler" +++ diff --git a/content/docs/2.14/scalers/artemis.md b/content/docs/2.14/scalers/artemis.md index 08613af50..19500e25c 100644 --- a/content/docs/2.14/scalers/artemis.md +++ b/content/docs/2.14/scalers/artemis.md @@ -2,6 +2,7 @@ title = "ActiveMQ Artemis" availability = "v1.5+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on ActiveMQ Artemis queues" go_file = "artemis_scaler" +++ diff --git a/content/docs/2.14/scalers/aws-cloudwatch.md b/content/docs/2.14/scalers/aws-cloudwatch.md index 45998d394..60596d4fc 100644 --- a/content/docs/2.14/scalers/aws-cloudwatch.md +++ b/content/docs/2.14/scalers/aws-cloudwatch.md @@ -2,6 +2,7 @@ title = "AWS CloudWatch" availability = "v1.0+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on AWS CloudWatch." go_file = "aws_cloudwatch_scaler" +++ diff --git a/content/docs/2.14/scalers/aws-dynamodb-streams.md b/content/docs/2.14/scalers/aws-dynamodb-streams.md index 06f0ec19d..6f38ffe43 100644 --- a/content/docs/2.14/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.14/scalers/aws-dynamodb-streams.md @@ -2,6 +2,7 @@ title = "AWS DynamoDB Streams" availability = "v2.8+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on AWS DynamoDB Streams" go_file = "aws_dynamodb_streams_scaler" +++ diff --git a/content/docs/2.14/scalers/aws-dynamodb.md b/content/docs/2.14/scalers/aws-dynamodb.md index e91c4b8d9..41e8bebcf 100644 --- a/content/docs/2.14/scalers/aws-dynamodb.md +++ b/content/docs/2.14/scalers/aws-dynamodb.md @@ -2,6 +2,7 @@ title = "AWS DynamoDB" availability = "v2.7+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on the records count in AWS DynamoDB" go_file = "aws_dynamodb_scaler" +++ diff --git a/content/docs/2.14/scalers/aws-kinesis.md b/content/docs/2.14/scalers/aws-kinesis.md index a4e10444e..0e43938c9 100644 --- a/content/docs/2.14/scalers/aws-kinesis.md +++ b/content/docs/2.14/scalers/aws-kinesis.md @@ -2,6 +2,7 @@ title = "AWS Kinesis Stream" availability = "v1.1+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on AWS Kinesis Stream." go_file = "aws_kinesis_stream_scaler" +++ diff --git a/content/docs/2.14/scalers/aws-sqs.md b/content/docs/2.14/scalers/aws-sqs.md index 8fd0ab305..6ea97465d 100644 --- a/content/docs/2.14/scalers/aws-sqs.md +++ b/content/docs/2.14/scalers/aws-sqs.md @@ -2,6 +2,7 @@ title = "AWS SQS Queue" availability = "v1.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on AWS SQS Queue." go_file = "aws_sqs_queue_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-app-insights.md b/content/docs/2.14/scalers/azure-app-insights.md index 7a9891ab1..234a00f32 100644 --- a/content/docs/2.14/scalers/azure-app-insights.md +++ b/content/docs/2.14/scalers/azure-app-insights.md @@ -2,6 +2,7 @@ title = "Azure Application Insights" availability = "v2.6+" maintainer = "Microsoft" +category = "Metrics" description = "Scale applications based on Azure Application Insights metrics." go_file = "azure_app_insights_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-data-explorer.md b/content/docs/2.14/scalers/azure-data-explorer.md index 0a3e408c8..6493bafd1 100644 --- a/content/docs/2.14/scalers/azure-data-explorer.md +++ b/content/docs/2.14/scalers/azure-data-explorer.md @@ -2,6 +2,7 @@ title = "Azure Data Explorer" availability = "v2.7+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on Azure Data Explorer query result." go_file = "azure_data_explorer_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-event-hub.md b/content/docs/2.14/scalers/azure-event-hub.md index e19858754..54135b492 100644 --- a/content/docs/2.14/scalers/azure-event-hub.md +++ b/content/docs/2.14/scalers/azure-event-hub.md @@ -2,6 +2,7 @@ title = "Azure Event Hubs" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on Azure Event Hubs." go_file = "azure_eventhub_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-log-analytics.md b/content/docs/2.14/scalers/azure-log-analytics.md index 7debd7e80..fe5187fd4 100644 --- a/content/docs/2.14/scalers/azure-log-analytics.md +++ b/content/docs/2.14/scalers/azure-log-analytics.md @@ -2,6 +2,7 @@ title = "Azure Log Analytics" availability = "v2.0+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on Azure Log Analytics query result" go_file = "azure_log_analytics_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-monitor.md b/content/docs/2.14/scalers/azure-monitor.md index 86d94747f..156aa1099 100644 --- a/content/docs/2.14/scalers/azure-monitor.md +++ b/content/docs/2.14/scalers/azure-monitor.md @@ -2,6 +2,7 @@ title = "Azure Monitor" availability = "v1.3+" maintainer = "Microsoft" +category = "Metrics" description = "Scale applications based on Azure Monitor metrics." go_file = "azure_monitor_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-pipelines.md b/content/docs/2.14/scalers/azure-pipelines.md index af6d1818f..4933bfae4 100644 --- a/content/docs/2.14/scalers/azure-pipelines.md +++ b/content/docs/2.14/scalers/azure-pipelines.md @@ -2,6 +2,7 @@ title = "Azure Pipelines" availability = "v2.3+" maintainer = "Microsoft" +category = "CI/CD" description = "Scale applications based on agent pool queues for Azure Pipelines." go_file = "azure_pipelines_scaler" +++ diff --git a/content/docs/2.14/scalers/azure-service-bus.md b/content/docs/2.14/scalers/azure-service-bus.md index 01d4ebd5a..ca498fbc9 100644 --- a/content/docs/2.14/scalers/azure-service-bus.md +++ b/content/docs/2.14/scalers/azure-service-bus.md @@ -1,6 +1,7 @@ +++ title = "Azure Service Bus" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on Azure Service Bus Queues or Topics." availability = "v1.0+" go_file = "azure_servicebus_scaler" diff --git a/content/docs/2.14/scalers/azure-storage-blob.md b/content/docs/2.14/scalers/azure-storage-blob.md index 70f16b950..05bdbb220 100644 --- a/content/docs/2.14/scalers/azure-storage-blob.md +++ b/content/docs/2.14/scalers/azure-storage-blob.md @@ -2,6 +2,7 @@ title = "Azure Blob Storage" availability = "v1.1+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on the count of blobs in a given Azure Blob Storage container." notice = "As of now, this Azure Blob Storage scaler scales based on the count of the blobs in a container as opposed to the Azure Functions behavior where code is only triggered on new blobs." go_file = "azure_blob_scaler" diff --git a/content/docs/2.14/scalers/azure-storage-queue.md b/content/docs/2.14/scalers/azure-storage-queue.md index 5e6066b1c..76402c14a 100644 --- a/content/docs/2.14/scalers/azure-storage-queue.md +++ b/content/docs/2.14/scalers/azure-storage-queue.md @@ -2,6 +2,7 @@ title = "Azure Storage Queue" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on Azure Storage Queues." go_file = "azure_queue_scaler" +++ diff --git a/content/docs/2.14/scalers/cassandra.md b/content/docs/2.14/scalers/cassandra.md index ccf2e9e0a..d662388d3 100644 --- a/content/docs/2.14/scalers/cassandra.md +++ b/content/docs/2.14/scalers/cassandra.md @@ -2,6 +2,7 @@ title = "Cassandra" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on Cassandra query results." go_file = "cassandra_scaler" +++ diff --git a/content/docs/2.14/scalers/couchdb.md b/content/docs/2.14/scalers/couchdb.md index 07a868ab9..444126c19 100644 --- a/content/docs/2.14/scalers/couchdb.md +++ b/content/docs/2.14/scalers/couchdb.md @@ -2,6 +2,7 @@ title = "CouchDB" availability = "v2.9+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on CouchDB query results." go_file = "couchdb_scaler" +++ diff --git a/content/docs/2.14/scalers/cpu.md b/content/docs/2.14/scalers/cpu.md index 5051a22ab..ad4efa3e2 100644 --- a/content/docs/2.14/scalers/cpu.md +++ b/content/docs/2.14/scalers/cpu.md @@ -2,6 +2,7 @@ title = "CPU" availability = "v2.0+" maintainer = "Community" +category = "Apps" description = "Scale applications based on cpu metrics." go_file = "cpu_memory_scaler" +++ diff --git a/content/docs/2.14/scalers/cron.md b/content/docs/2.14/scalers/cron.md index 8a5f63821..3a526742d 100644 --- a/content/docs/2.14/scalers/cron.md +++ b/content/docs/2.14/scalers/cron.md @@ -2,6 +2,7 @@ title = "Cron" availability = "v1.5+" maintainer = "Community" +category = "Scheduling" description = "Scale applications based on a cron schedule." go_file = "cron_scaler" +++ diff --git a/content/docs/2.14/scalers/datadog.md b/content/docs/2.14/scalers/datadog.md index 49115a514..cf7e01d24 100644 --- a/content/docs/2.14/scalers/datadog.md +++ b/content/docs/2.14/scalers/datadog.md @@ -2,6 +2,7 @@ title = "Datadog" availability = "v2.6+" maintainer = "Datadog" +category = "Metrics" description = "Scale applications based on Datadog." go_file = "datadog_scaler" +++ diff --git a/content/docs/2.14/scalers/elasticsearch.md b/content/docs/2.14/scalers/elasticsearch.md index aa432c0bc..95ee76d6c 100644 --- a/content/docs/2.14/scalers/elasticsearch.md +++ b/content/docs/2.14/scalers/elasticsearch.md @@ -2,6 +2,7 @@ title = "Elasticsearch" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on elasticsearch search template query result." go_file = "elasticsearch_scaler" +++ diff --git a/content/docs/2.14/scalers/etcd.md b/content/docs/2.14/scalers/etcd.md index 27a236b57..f02da9ba3 100644 --- a/content/docs/2.14/scalers/etcd.md +++ b/content/docs/2.14/scalers/etcd.md @@ -2,6 +2,7 @@ title = "Etcd" availability = "v2.9+" maintainer = "Huawei Cloud" +category = "Data & Storage" description = "Scale applications based on an etcd key-value pair. By watching an etcd key, a passively received push mode, the scaler can activate applications with lower load usage than frequent pull mode" go_file = "etcd_scaler" +++ diff --git a/content/docs/2.14/scalers/external-push.md b/content/docs/2.14/scalers/external-push.md index b659d860e..ffabbc0fe 100644 --- a/content/docs/2.14/scalers/external-push.md +++ b/content/docs/2.14/scalers/external-push.md @@ -2,6 +2,7 @@ title = "External Push" availability = "v2.0+" maintainer = "Microsoft" +category = "Extensibility" description = "Scale applications based on an external push scaler." go_file = "external_scaler" +++ diff --git a/content/docs/2.14/scalers/external.md b/content/docs/2.14/scalers/external.md index b011700f5..ec785073d 100644 --- a/content/docs/2.14/scalers/external.md +++ b/content/docs/2.14/scalers/external.md @@ -2,6 +2,7 @@ title = "External" availability = "v1.0+" maintainer = "Microsoft" +category = "Extensibility" description = "Scale applications based on an external scaler." go_file = "external_scaler" +++ diff --git a/content/docs/2.14/scalers/gcp-cloud-tasks.md b/content/docs/2.14/scalers/gcp-cloud-tasks.md index 6b5aa49b6..a2c83b6a5 100644 --- a/content/docs/2.14/scalers/gcp-cloud-tasks.md +++ b/content/docs/2.14/scalers/gcp-cloud-tasks.md @@ -1,14 +1,14 @@ +++ -title = "Google Cloud Platform‎ Cloud Tasks" +title = "Google Cloud Platform Cloud Tasks" availability = "v2.12+" maintainer = "Community" -description = "Scale applications based on Google Cloud Platform‎ Cloud Tasks." +description = "Scale applications based on Google Cloud Platform Cloud Tasks." go_file = "gcp_cloud_tasks_scaler" +++ ### Trigger Specification -This specification describes the `gcp-cloudtasks` trigger for Google Cloud Platform‎ Cloud Tasks. +This specification describes the `gcp-cloudtasks` trigger for Google Cloud Platform Cloud Tasks. ```yaml triggers: @@ -21,7 +21,7 @@ triggers: credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required ``` -The Google Cloud Platform‎ (GCP) Cloud Tasks trigger allows you to scale based on the number of tasks queued in you queue. +The Google Cloud Platform (GCP) Cloud Tasks trigger allows you to scale based on the number of tasks queued in you queue. 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 Cloud Task queue. diff --git a/content/docs/2.14/scalers/gcp-pub-sub.md b/content/docs/2.14/scalers/gcp-pub-sub.md index b2ca1388c..650c07a58 100644 --- a/content/docs/2.14/scalers/gcp-pub-sub.md +++ b/content/docs/2.14/scalers/gcp-pub-sub.md @@ -1,14 +1,15 @@ +++ -title = "Google Cloud Platform‎ Pub/Sub" +title = "Google Cloud Platform Pub/Sub" availability = "v1.0+" maintainer = "Community" -description = "Scale applications based on Google Cloud Platform‎ Pub/Sub." +category = "Messaging" +description = "Scale applications based on Google Cloud Platform Pub/Sub." go_file = "gcp_pubsub_scaler" +++ ### Trigger Specification -This specification describes the `gcp-pubsub` trigger for Google Cloud Platform‎ Pub/Sub. +This specification describes the `gcp-pubsub` trigger for Google Cloud Platform Pub/Sub. ```yaml triggers: @@ -27,7 +28,7 @@ triggers: credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required ``` -The Google Cloud Platform‎ (GCP) Pub/Sub trigger allows you to scale based on any metrics from your Pub/Sub subscription or topic, such as number of messages or oldest unacked message age, etc. +The Google Cloud Platform (GCP) Pub/Sub trigger allows you to scale based on any metrics from your Pub/Sub subscription or topic, such as number of messages or oldest unacked message age, etc. - `credentialsFromEnv` - This 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. diff --git a/content/docs/2.14/scalers/gcp-stackdriver.md b/content/docs/2.14/scalers/gcp-stackdriver.md index de97b9c57..0ff287fec 100644 --- a/content/docs/2.14/scalers/gcp-stackdriver.md +++ b/content/docs/2.14/scalers/gcp-stackdriver.md @@ -2,6 +2,7 @@ title = "Google Cloud Platform Stackdriver" availability = "2.7+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on a metric obtained from Stackdriver." go_file = "gcp_stackdriver_scaler" +++ diff --git a/content/docs/2.14/scalers/gcp-storage.md b/content/docs/2.14/scalers/gcp-storage.md index a4a0ccc03..e32b5c912 100644 --- a/content/docs/2.14/scalers/gcp-storage.md +++ b/content/docs/2.14/scalers/gcp-storage.md @@ -2,6 +2,7 @@ title = "Google Cloud Platform Storage" availability = "2.7+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on the count of objects in a given Google Cloud Storage (GCS) bucket." go_file = "gcp_storage_scaler" +++ diff --git a/content/docs/2.14/scalers/github-runner.md b/content/docs/2.14/scalers/github-runner.md index 56719eba4..f8da2f8ce 100644 --- a/content/docs/2.14/scalers/github-runner.md +++ b/content/docs/2.14/scalers/github-runner.md @@ -2,6 +2,7 @@ title = "Github Runner Scaler" availability = "v2.10+" maintainer = "GitHub" +category = "CI/CD" description = "Scale GitHub Runners based on the number of queued jobs in GitHub Actions" go_file = "github_runner_scaler" +++ diff --git a/content/docs/2.14/scalers/graphite.md b/content/docs/2.14/scalers/graphite.md index 88bd21097..08fa4d5f0 100644 --- a/content/docs/2.14/scalers/graphite.md +++ b/content/docs/2.14/scalers/graphite.md @@ -2,6 +2,7 @@ title = "Graphite" availability = "v2.5+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on metrics in Graphite." go_file = "graphite_scaler" +++ diff --git a/content/docs/2.14/scalers/huawei-cloudeye.md b/content/docs/2.14/scalers/huawei-cloudeye.md index 97863f25c..2ddfadaba 100644 --- a/content/docs/2.14/scalers/huawei-cloudeye.md +++ b/content/docs/2.14/scalers/huawei-cloudeye.md @@ -2,6 +2,7 @@ title = "Huawei Cloudeye" availability = "v1.1+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a Huawei Cloudeye." go_file = "huawei_cloudeye_scaler" +++ diff --git a/content/docs/2.14/scalers/ibm-mq.md b/content/docs/2.14/scalers/ibm-mq.md index f3aceaf3a..786e66ee2 100644 --- a/content/docs/2.14/scalers/ibm-mq.md +++ b/content/docs/2.14/scalers/ibm-mq.md @@ -2,6 +2,7 @@ title = "IBM MQ" availability = "v2.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on IBM MQ Queue" go_file = "ibmmq_scaler" +++ diff --git a/content/docs/2.14/scalers/influxdb.md b/content/docs/2.14/scalers/influxdb.md index 7aafafb87..2be2f830b 100644 --- a/content/docs/2.14/scalers/influxdb.md +++ b/content/docs/2.14/scalers/influxdb.md @@ -2,6 +2,7 @@ title = "InfluxDB" availability = "v2.1+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on InfluxDB queries" go_file = "influxdb_scaler" +++ diff --git a/content/docs/2.14/scalers/kubernetes-workload.md b/content/docs/2.14/scalers/kubernetes-workload.md index 365b2f878..bb0d18159 100644 --- a/content/docs/2.14/scalers/kubernetes-workload.md +++ b/content/docs/2.14/scalers/kubernetes-workload.md @@ -2,6 +2,7 @@ title = "Kubernetes Workload" availability = "v2.4+" maintainer = "Community" +category = "Apps" description = "Scale applications based on the count of running pods that match the given selectors." go_file = "kubernetes_workload_scaler" +++ diff --git a/content/docs/2.14/scalers/liiklus-topic.md b/content/docs/2.14/scalers/liiklus-topic.md index 5741a0df3..4ef51a7c6 100644 --- a/content/docs/2.14/scalers/liiklus-topic.md +++ b/content/docs/2.14/scalers/liiklus-topic.md @@ -2,6 +2,7 @@ title = "Liiklus Topic" availability = "v1.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on Liiklus Topic." go_file = "liiklus_scaler" +++ diff --git a/content/docs/2.14/scalers/memory.md b/content/docs/2.14/scalers/memory.md index ec55f56e2..af6c76a4c 100644 --- a/content/docs/2.14/scalers/memory.md +++ b/content/docs/2.14/scalers/memory.md @@ -2,6 +2,7 @@ title = "Memory" availability = "v2.0+" maintainer = "Community" +category = "Apps" description = "Scale applications based on memory metrics." go_file = "cpu_memory_scaler" +++ diff --git a/content/docs/2.14/scalers/metrics-api.md b/content/docs/2.14/scalers/metrics-api.md index f4bdb68a5..ae22df53b 100644 --- a/content/docs/2.14/scalers/metrics-api.md +++ b/content/docs/2.14/scalers/metrics-api.md @@ -2,6 +2,7 @@ title = "Metrics API" availability = "v2.0+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a metric provided by an API" go_file = "metrics_api_scaler" +++ diff --git a/content/docs/2.14/scalers/mongodb.md b/content/docs/2.14/scalers/mongodb.md index d36ff1c31..2ca3c1068 100644 --- a/content/docs/2.14/scalers/mongodb.md +++ b/content/docs/2.14/scalers/mongodb.md @@ -1,6 +1,7 @@ +++ title = "MongoDB" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on MongoDB queries." availability = "v2.1+" go_file = "mongo_scaler" diff --git a/content/docs/2.14/scalers/mssql.md b/content/docs/2.14/scalers/mssql.md index 98839f2d2..78b5c9803 100644 --- a/content/docs/2.14/scalers/mssql.md +++ b/content/docs/2.14/scalers/mssql.md @@ -2,6 +2,7 @@ title = "MSSQL" availability = "v2.2+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on Microsoft SQL Server (MSSQL) query results." go_file = "mssql_scaler" +++ diff --git a/content/docs/2.14/scalers/mysql.md b/content/docs/2.14/scalers/mysql.md index 2ac08c531..8598d34c8 100644 --- a/content/docs/2.14/scalers/mysql.md +++ b/content/docs/2.14/scalers/mysql.md @@ -2,6 +2,7 @@ title = "MySQL" availability = "v1.2+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on MySQL query result." go_file = "mysql_scaler" +++ diff --git a/content/docs/2.14/scalers/nats-jetstream.md b/content/docs/2.14/scalers/nats-jetstream.md index 4cb8e812e..f81517a83 100644 --- a/content/docs/2.14/scalers/nats-jetstream.md +++ b/content/docs/2.14/scalers/nats-jetstream.md @@ -3,6 +3,7 @@ title = "NATS JetStream" layout = "scaler" availability = "v2.8+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on NATS JetStream." go_file = "nats_jetstream_scaler" +++ diff --git a/content/docs/2.14/scalers/nats-streaming.md b/content/docs/2.14/scalers/nats-streaming.md index f26887447..490082ed3 100644 --- a/content/docs/2.14/scalers/nats-streaming.md +++ b/content/docs/2.14/scalers/nats-streaming.md @@ -2,6 +2,7 @@ title = "NATS Streaming" availability = "v1.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on NATS Streaming." go_file = "stan_scaler" +++ diff --git a/content/docs/2.14/scalers/new-relic.md b/content/docs/2.14/scalers/new-relic.md index 3d12b8ca2..08bc3b521 100644 --- a/content/docs/2.14/scalers/new-relic.md +++ b/content/docs/2.14/scalers/new-relic.md @@ -2,6 +2,7 @@ title = "New Relic" availability = "2.6+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on New Relic NRQL" go_file = "newrelic_scaler" +++ diff --git a/content/docs/2.14/scalers/openstack-metric.md b/content/docs/2.14/scalers/openstack-metric.md index 1d9330dc9..c50a8ec04 100644 --- a/content/docs/2.14/scalers/openstack-metric.md +++ b/content/docs/2.14/scalers/openstack-metric.md @@ -2,6 +2,7 @@ title = "OpenStack Metric" availability = "v2.3+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a threshold reached by a specific measure from OpenStack Metric API." go_file = "openstack_metrics_scaler" +++ diff --git a/content/docs/2.14/scalers/openstack-swift.md b/content/docs/2.14/scalers/openstack-swift.md index 392dc5b1b..147132ec5 100644 --- a/content/docs/2.14/scalers/openstack-swift.md +++ b/content/docs/2.14/scalers/openstack-swift.md @@ -2,6 +2,7 @@ title = "OpenStack Swift" availability = "v2.1+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on the count of objects in a given OpenStack Swift container." go_file = "openstack_swift_scaler" +++ diff --git a/content/docs/2.14/scalers/postgresql.md b/content/docs/2.14/scalers/postgresql.md index bc55a40b3..8c570b17e 100644 --- a/content/docs/2.14/scalers/postgresql.md +++ b/content/docs/2.14/scalers/postgresql.md @@ -2,6 +2,7 @@ title = "PostgreSQL" availability = "v1.2+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on a PostgreSQL query." go_file = "postgresql_scaler" +++ diff --git a/content/docs/2.14/scalers/predictkube.md b/content/docs/2.14/scalers/predictkube.md index c9e33715a..f79cf594e 100644 --- a/content/docs/2.14/scalers/predictkube.md +++ b/content/docs/2.14/scalers/predictkube.md @@ -2,6 +2,7 @@ title = "Predictkube" availability = "v2.6+" maintainer = "Dysnix" +category = "Metrics" description = "AI-based predictive scaling based on Prometheus metrics & PredictKube SaaS." go_file = "predictkube_scaler" +++ diff --git a/content/docs/2.14/scalers/prometheus.md b/content/docs/2.14/scalers/prometheus.md index a84d40f8a..406f8c8db 100644 --- a/content/docs/2.14/scalers/prometheus.md +++ b/content/docs/2.14/scalers/prometheus.md @@ -2,6 +2,7 @@ title = "Prometheus" availability = "v1.0+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on Prometheus." go_file = "prometheus_scaler" +++ diff --git a/content/docs/2.14/scalers/pulsar.md b/content/docs/2.14/scalers/pulsar.md index 4f6141c16..b0c8edc11 100644 --- a/content/docs/2.14/scalers/pulsar.md +++ b/content/docs/2.14/scalers/pulsar.md @@ -2,6 +2,7 @@ title = "Apache Pulsar" availability = "v2.8" maintainer = "Community" +category = "Messaging" description = "Scale applications based on an Apache Pulsar topic subscription." go_file = "pulsar_scaler" layout = "scaler" diff --git a/content/docs/2.14/scalers/rabbitmq-queue.md b/content/docs/2.14/scalers/rabbitmq-queue.md index 932494cad..1e65d7dd5 100644 --- a/content/docs/2.14/scalers/rabbitmq-queue.md +++ b/content/docs/2.14/scalers/rabbitmq-queue.md @@ -2,6 +2,7 @@ title = "RabbitMQ Queue" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on RabbitMQ Queue." go_file = "rabbitmq_scaler" +++ diff --git a/content/docs/2.14/scalers/redis-cluster-lists.md b/content/docs/2.14/scalers/redis-cluster-lists.md index 38d1960d8..6e6c240e9 100644 --- a/content/docs/2.14/scalers/redis-cluster-lists.md +++ b/content/docs/2.14/scalers/redis-cluster-lists.md @@ -2,6 +2,7 @@ title = "Redis Lists (supports Redis Cluster)" availability = "v2.1+" maintainer = "Community" +category = "Data & Storage" description = "Redis Lists scaler with support for Redis Cluster topology" go_file = "redis_scaler" +++ diff --git a/content/docs/2.14/scalers/redis-cluster-streams.md b/content/docs/2.14/scalers/redis-cluster-streams.md index 249ff0a5a..be57aa5f7 100644 --- a/content/docs/2.14/scalers/redis-cluster-streams.md +++ b/content/docs/2.14/scalers/redis-cluster-streams.md @@ -2,6 +2,7 @@ title = "Redis Streams (supports Redis Cluster)" availability = "v2.1+" maintainer = "Community" +category = "Data & Storage" description = "Redis Streams scaler with support for Redis Cluster topology" go_file = "redis_streams_scaler" +++ diff --git a/content/docs/2.14/scalers/redis-lists.md b/content/docs/2.14/scalers/redis-lists.md index 45f2979fc..e8b0ad83f 100644 --- a/content/docs/2.14/scalers/redis-lists.md +++ b/content/docs/2.14/scalers/redis-lists.md @@ -2,6 +2,7 @@ title = "Redis Lists" availability = "v1.0+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on Redis Lists." go_file = "redis_scaler" +++ diff --git a/content/docs/2.14/scalers/redis-sentinel-lists.md b/content/docs/2.14/scalers/redis-sentinel-lists.md index 852ab00d7..07bf4b25e 100644 --- a/content/docs/2.14/scalers/redis-sentinel-lists.md +++ b/content/docs/2.14/scalers/redis-sentinel-lists.md @@ -2,6 +2,7 @@ title = "Redis Lists (supports Redis Sentinel)" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Redis Lists scaler with support for Redis Sentinel topology" go_file = "redis_scaler" +++ diff --git a/content/docs/2.14/scalers/redis-sentinel-streams.md b/content/docs/2.14/scalers/redis-sentinel-streams.md index e8fb32351..0070884d9 100644 --- a/content/docs/2.14/scalers/redis-sentinel-streams.md +++ b/content/docs/2.14/scalers/redis-sentinel-streams.md @@ -2,6 +2,7 @@ title = "Redis Streams (supports Redis Sentinel)" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Redis Streams scaler with support for Redis Sentinel topology" go_file = "redis_streams_scaler" +++ diff --git a/content/docs/2.14/scalers/redis-streams.md b/content/docs/2.14/scalers/redis-streams.md index 45ca1bb42..0c8436acb 100644 --- a/content/docs/2.14/scalers/redis-streams.md +++ b/content/docs/2.14/scalers/redis-streams.md @@ -2,6 +2,7 @@ title = "Redis Streams" availability = "v1.5+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on Redis Streams." go_file = "redis_streams_scaler" +++ diff --git a/content/docs/2.14/scalers/selenium-grid-scaler.md b/content/docs/2.14/scalers/selenium-grid-scaler.md index edeff1da7..d30c30aa9 100644 --- a/content/docs/2.14/scalers/selenium-grid-scaler.md +++ b/content/docs/2.14/scalers/selenium-grid-scaler.md @@ -2,6 +2,7 @@ title = "Selenium Grid Scaler" availability = "v2.4+" maintainer = "Volvo Cars" +category = "Testing" description = "Scales Selenium browser nodes based on number of requests waiting in session queue" go_file = "selenium_grid_scaler" +++ diff --git a/content/docs/2.14/scalers/solace-pub-sub.md b/content/docs/2.14/scalers/solace-pub-sub.md index 351a8e360..c8a3e8ba5 100644 --- a/content/docs/2.14/scalers/solace-pub-sub.md +++ b/content/docs/2.14/scalers/solace-pub-sub.md @@ -2,6 +2,7 @@ title = "Solace PubSub+ Event Broker" availability = "2.4+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on Solace PubSub+ Event Broker Queues" go_file = "solace_scaler" +++ diff --git a/content/docs/2.14/scalers/solr.md b/content/docs/2.14/scalers/solr.md index a4fafb7f6..9eaac8f65 100644 --- a/content/docs/2.14/scalers/solr.md +++ b/content/docs/2.14/scalers/solr.md @@ -2,6 +2,7 @@ title = "Solr" availability = "v2.11+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on Solr query results." go_file = "solr_scaler" +++ diff --git a/content/docs/2.15/scalers/activemq.md b/content/docs/2.15/scalers/activemq.md index a970f9566..b9c012798 100644 --- a/content/docs/2.15/scalers/activemq.md +++ b/content/docs/2.15/scalers/activemq.md @@ -2,6 +2,7 @@ title = "ActiveMQ" availability = "v2.6+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on ActiveMQ Queue." go_file = "activemq_scaler" +++ diff --git a/content/docs/2.15/scalers/apache-kafka-go.md b/content/docs/2.15/scalers/apache-kafka-go.md index 8c69ca0de..e2c7b7fd8 100644 --- a/content/docs/2.15/scalers/apache-kafka-go.md +++ b/content/docs/2.15/scalers/apache-kafka-go.md @@ -2,6 +2,7 @@ title = "Apache Kafka (Experimental)" availability = "v2.12+" maintainer = "Community" +category = "Messaging" description = "Experimental scaler based on 'segmentio/kafka-go' library. Scale applications based on an Apache Kafka topic or other services that support Kafka protocol." go_file = "apache_kafka_scaler" +++ diff --git a/content/docs/2.15/scalers/apache-kafka.md b/content/docs/2.15/scalers/apache-kafka.md index 5a66cae58..15414f5d5 100644 --- a/content/docs/2.15/scalers/apache-kafka.md +++ b/content/docs/2.15/scalers/apache-kafka.md @@ -2,6 +2,7 @@ title = "Apache Kafka" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on an Apache Kafka topic or other services that support Kafka protocol." go_file = "kafka_scaler" +++ diff --git a/content/docs/2.15/scalers/arangodb.md b/content/docs/2.15/scalers/arangodb.md index 81ac3cec3..f3c1c6eb4 100644 --- a/content/docs/2.15/scalers/arangodb.md +++ b/content/docs/2.15/scalers/arangodb.md @@ -2,6 +2,7 @@ title = "ArangoDB" availability = "v2.10+" maintainer = "Community" +category = "Datastore" description = "Scale applications based on ArangoDB query result." go_file = "arangodb_scaler" +++ diff --git a/content/docs/2.15/scalers/artemis.md b/content/docs/2.15/scalers/artemis.md index 08613af50..19500e25c 100644 --- a/content/docs/2.15/scalers/artemis.md +++ b/content/docs/2.15/scalers/artemis.md @@ -2,6 +2,7 @@ title = "ActiveMQ Artemis" availability = "v1.5+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on ActiveMQ Artemis queues" go_file = "artemis_scaler" +++ diff --git a/content/docs/2.15/scalers/aws-cloudwatch.md b/content/docs/2.15/scalers/aws-cloudwatch.md index f3ac9f2ea..3b433225e 100644 --- a/content/docs/2.15/scalers/aws-cloudwatch.md +++ b/content/docs/2.15/scalers/aws-cloudwatch.md @@ -2,6 +2,7 @@ title = "AWS CloudWatch" availability = "v1.0+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on AWS CloudWatch." go_file = "aws_cloudwatch_scaler" +++ diff --git a/content/docs/2.15/scalers/aws-dynamodb-streams.md b/content/docs/2.15/scalers/aws-dynamodb-streams.md index 0b9cb4d2d..9a3fcb142 100644 --- a/content/docs/2.15/scalers/aws-dynamodb-streams.md +++ b/content/docs/2.15/scalers/aws-dynamodb-streams.md @@ -2,6 +2,7 @@ title = "AWS DynamoDB Streams" availability = "v2.8+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on AWS DynamoDB Streams" go_file = "aws_dynamodb_streams_scaler" +++ diff --git a/content/docs/2.15/scalers/aws-dynamodb.md b/content/docs/2.15/scalers/aws-dynamodb.md index ca5c72df4..f01141549 100644 --- a/content/docs/2.15/scalers/aws-dynamodb.md +++ b/content/docs/2.15/scalers/aws-dynamodb.md @@ -2,6 +2,7 @@ title = "AWS DynamoDB" availability = "v2.7+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on the records count in AWS DynamoDB" go_file = "aws_dynamodb_scaler" +++ diff --git a/content/docs/2.15/scalers/aws-kinesis.md b/content/docs/2.15/scalers/aws-kinesis.md index f13d878cb..901863983 100644 --- a/content/docs/2.15/scalers/aws-kinesis.md +++ b/content/docs/2.15/scalers/aws-kinesis.md @@ -2,6 +2,7 @@ title = "AWS Kinesis Stream" availability = "v1.1+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on AWS Kinesis Stream." go_file = "aws_kinesis_stream_scaler" +++ diff --git a/content/docs/2.15/scalers/aws-sqs.md b/content/docs/2.15/scalers/aws-sqs.md index aba7bbec6..95eb2387c 100644 --- a/content/docs/2.15/scalers/aws-sqs.md +++ b/content/docs/2.15/scalers/aws-sqs.md @@ -2,6 +2,7 @@ title = "AWS SQS Queue" availability = "v1.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on AWS SQS Queue." go_file = "aws_sqs_queue_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-app-insights.md b/content/docs/2.15/scalers/azure-app-insights.md index 7a9891ab1..234a00f32 100644 --- a/content/docs/2.15/scalers/azure-app-insights.md +++ b/content/docs/2.15/scalers/azure-app-insights.md @@ -2,6 +2,7 @@ title = "Azure Application Insights" availability = "v2.6+" maintainer = "Microsoft" +category = "Metrics" description = "Scale applications based on Azure Application Insights metrics." go_file = "azure_app_insights_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-data-explorer.md b/content/docs/2.15/scalers/azure-data-explorer.md index 0a3e408c8..6493bafd1 100644 --- a/content/docs/2.15/scalers/azure-data-explorer.md +++ b/content/docs/2.15/scalers/azure-data-explorer.md @@ -2,6 +2,7 @@ title = "Azure Data Explorer" availability = "v2.7+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on Azure Data Explorer query result." go_file = "azure_data_explorer_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-event-hub.md b/content/docs/2.15/scalers/azure-event-hub.md index e19858754..54135b492 100644 --- a/content/docs/2.15/scalers/azure-event-hub.md +++ b/content/docs/2.15/scalers/azure-event-hub.md @@ -2,6 +2,7 @@ title = "Azure Event Hubs" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on Azure Event Hubs." go_file = "azure_eventhub_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-log-analytics.md b/content/docs/2.15/scalers/azure-log-analytics.md index fb49826b9..c7743db27 100644 --- a/content/docs/2.15/scalers/azure-log-analytics.md +++ b/content/docs/2.15/scalers/azure-log-analytics.md @@ -2,6 +2,7 @@ title = "Azure Log Analytics" availability = "v2.0+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on Azure Log Analytics query result" go_file = "azure_log_analytics_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-monitor.md b/content/docs/2.15/scalers/azure-monitor.md index 86d94747f..156aa1099 100644 --- a/content/docs/2.15/scalers/azure-monitor.md +++ b/content/docs/2.15/scalers/azure-monitor.md @@ -2,6 +2,7 @@ title = "Azure Monitor" availability = "v1.3+" maintainer = "Microsoft" +category = "Metrics" description = "Scale applications based on Azure Monitor metrics." go_file = "azure_monitor_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-pipelines.md b/content/docs/2.15/scalers/azure-pipelines.md index af6d1818f..4933bfae4 100644 --- a/content/docs/2.15/scalers/azure-pipelines.md +++ b/content/docs/2.15/scalers/azure-pipelines.md @@ -2,6 +2,7 @@ title = "Azure Pipelines" availability = "v2.3+" maintainer = "Microsoft" +category = "CI/CD" description = "Scale applications based on agent pool queues for Azure Pipelines." go_file = "azure_pipelines_scaler" +++ diff --git a/content/docs/2.15/scalers/azure-service-bus.md b/content/docs/2.15/scalers/azure-service-bus.md index 01d4ebd5a..ca498fbc9 100644 --- a/content/docs/2.15/scalers/azure-service-bus.md +++ b/content/docs/2.15/scalers/azure-service-bus.md @@ -1,6 +1,7 @@ +++ title = "Azure Service Bus" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on Azure Service Bus Queues or Topics." availability = "v1.0+" go_file = "azure_servicebus_scaler" diff --git a/content/docs/2.15/scalers/azure-storage-blob.md b/content/docs/2.15/scalers/azure-storage-blob.md index 70f16b950..05bdbb220 100644 --- a/content/docs/2.15/scalers/azure-storage-blob.md +++ b/content/docs/2.15/scalers/azure-storage-blob.md @@ -2,6 +2,7 @@ title = "Azure Blob Storage" availability = "v1.1+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on the count of blobs in a given Azure Blob Storage container." notice = "As of now, this Azure Blob Storage scaler scales based on the count of the blobs in a container as opposed to the Azure Functions behavior where code is only triggered on new blobs." go_file = "azure_blob_scaler" diff --git a/content/docs/2.15/scalers/azure-storage-queue.md b/content/docs/2.15/scalers/azure-storage-queue.md index 5e6066b1c..76402c14a 100644 --- a/content/docs/2.15/scalers/azure-storage-queue.md +++ b/content/docs/2.15/scalers/azure-storage-queue.md @@ -2,6 +2,7 @@ title = "Azure Storage Queue" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on Azure Storage Queues." go_file = "azure_queue_scaler" +++ diff --git a/content/docs/2.15/scalers/cassandra.md b/content/docs/2.15/scalers/cassandra.md index ccf2e9e0a..d662388d3 100644 --- a/content/docs/2.15/scalers/cassandra.md +++ b/content/docs/2.15/scalers/cassandra.md @@ -2,6 +2,7 @@ title = "Cassandra" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on Cassandra query results." go_file = "cassandra_scaler" +++ diff --git a/content/docs/2.15/scalers/couchdb.md b/content/docs/2.15/scalers/couchdb.md index 07a868ab9..444126c19 100644 --- a/content/docs/2.15/scalers/couchdb.md +++ b/content/docs/2.15/scalers/couchdb.md @@ -2,6 +2,7 @@ title = "CouchDB" availability = "v2.9+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on CouchDB query results." go_file = "couchdb_scaler" +++ diff --git a/content/docs/2.15/scalers/cpu.md b/content/docs/2.15/scalers/cpu.md index 5051a22ab..ad4efa3e2 100644 --- a/content/docs/2.15/scalers/cpu.md +++ b/content/docs/2.15/scalers/cpu.md @@ -2,6 +2,7 @@ title = "CPU" availability = "v2.0+" maintainer = "Community" +category = "Apps" description = "Scale applications based on cpu metrics." go_file = "cpu_memory_scaler" +++ diff --git a/content/docs/2.15/scalers/cron.md b/content/docs/2.15/scalers/cron.md index 8a5f63821..3a526742d 100644 --- a/content/docs/2.15/scalers/cron.md +++ b/content/docs/2.15/scalers/cron.md @@ -2,6 +2,7 @@ title = "Cron" availability = "v1.5+" maintainer = "Community" +category = "Scheduling" description = "Scale applications based on a cron schedule." go_file = "cron_scaler" +++ diff --git a/content/docs/2.15/scalers/datadog.md b/content/docs/2.15/scalers/datadog.md index 49115a514..cf7e01d24 100644 --- a/content/docs/2.15/scalers/datadog.md +++ b/content/docs/2.15/scalers/datadog.md @@ -2,6 +2,7 @@ title = "Datadog" availability = "v2.6+" maintainer = "Datadog" +category = "Metrics" description = "Scale applications based on Datadog." go_file = "datadog_scaler" +++ diff --git a/content/docs/2.15/scalers/elasticsearch.md b/content/docs/2.15/scalers/elasticsearch.md index aa432c0bc..95ee76d6c 100644 --- a/content/docs/2.15/scalers/elasticsearch.md +++ b/content/docs/2.15/scalers/elasticsearch.md @@ -2,6 +2,7 @@ title = "Elasticsearch" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on elasticsearch search template query result." go_file = "elasticsearch_scaler" +++ diff --git a/content/docs/2.15/scalers/etcd.md b/content/docs/2.15/scalers/etcd.md index 27a236b57..f02da9ba3 100644 --- a/content/docs/2.15/scalers/etcd.md +++ b/content/docs/2.15/scalers/etcd.md @@ -2,6 +2,7 @@ title = "Etcd" availability = "v2.9+" maintainer = "Huawei Cloud" +category = "Data & Storage" description = "Scale applications based on an etcd key-value pair. By watching an etcd key, a passively received push mode, the scaler can activate applications with lower load usage than frequent pull mode" go_file = "etcd_scaler" +++ diff --git a/content/docs/2.15/scalers/external-push.md b/content/docs/2.15/scalers/external-push.md index b659d860e..ffabbc0fe 100644 --- a/content/docs/2.15/scalers/external-push.md +++ b/content/docs/2.15/scalers/external-push.md @@ -2,6 +2,7 @@ title = "External Push" availability = "v2.0+" maintainer = "Microsoft" +category = "Extensibility" description = "Scale applications based on an external push scaler." go_file = "external_scaler" +++ diff --git a/content/docs/2.15/scalers/external.md b/content/docs/2.15/scalers/external.md index b011700f5..ec785073d 100644 --- a/content/docs/2.15/scalers/external.md +++ b/content/docs/2.15/scalers/external.md @@ -2,6 +2,7 @@ title = "External" availability = "v1.0+" maintainer = "Microsoft" +category = "Extensibility" description = "Scale applications based on an external scaler." go_file = "external_scaler" +++ diff --git a/content/docs/2.15/scalers/gcp-cloud-tasks.md b/content/docs/2.15/scalers/gcp-cloud-tasks.md index 9ddc6b11a..0c504c8ba 100644 --- a/content/docs/2.15/scalers/gcp-cloud-tasks.md +++ b/content/docs/2.15/scalers/gcp-cloud-tasks.md @@ -1,14 +1,14 @@ +++ -title = "Google Cloud Platform‎ Cloud Tasks" +title = "Google Cloud Platform Cloud Tasks" availability = "v2.12+" maintainer = "Community" -description = "Scale applications based on Google Cloud Platform‎ Cloud Tasks." +description = "Scale applications based on Google Cloud Platform Cloud Tasks." go_file = "gcp_cloud_tasks_scaler" +++ ### Trigger Specification -This specification describes the `gcp-cloudtasks` trigger for Google Cloud Platform‎ Cloud Tasks. +This specification describes the `gcp-cloudtasks` trigger for Google Cloud Platform Cloud Tasks. ```yaml triggers: @@ -22,7 +22,7 @@ triggers: credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required ``` -The Google Cloud Platform‎ (GCP) Cloud Tasks trigger allows you to scale based on the number of tasks queued in you queue. +The Google Cloud Platform (GCP) Cloud Tasks trigger allows you to scale based on the number of tasks queued in you queue. 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 Cloud Task queue. diff --git a/content/docs/2.15/scalers/gcp-pub-sub.md b/content/docs/2.15/scalers/gcp-pub-sub.md index e09bf2412..801dbc2c3 100644 --- a/content/docs/2.15/scalers/gcp-pub-sub.md +++ b/content/docs/2.15/scalers/gcp-pub-sub.md @@ -1,14 +1,15 @@ +++ -title = "Google Cloud Platform‎ Pub/Sub" +title = "Google Cloud Platform Pub/Sub" availability = "v1.0+" maintainer = "Community" -description = "Scale applications based on Google Cloud Platform‎ Pub/Sub." +category = "Messaging" +description = "Scale applications based on Google Cloud Platform Pub/Sub." go_file = "gcp_pubsub_scaler" +++ ### Trigger Specification -This specification describes the `gcp-pubsub` trigger for Google Cloud Platform‎ Pub/Sub. +This specification describes the `gcp-pubsub` trigger for Google Cloud Platform Pub/Sub. ```yaml triggers: @@ -28,7 +29,7 @@ triggers: credentialsFromEnv: GOOGLE_APPLICATION_CREDENTIALS_JSON # Required ``` -The Google Cloud Platform‎ (GCP) Pub/Sub trigger allows you to scale based on any metrics from your Pub/Sub subscription or topic, such as number of messages or oldest unacked message age, etc. +The Google Cloud Platform (GCP) Pub/Sub trigger allows you to scale based on any metrics from your Pub/Sub subscription or topic, such as number of messages or oldest unacked message age, etc. - `credentialsFromEnv` - This 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. diff --git a/content/docs/2.15/scalers/gcp-stackdriver.md b/content/docs/2.15/scalers/gcp-stackdriver.md index c961d81da..39e425b33 100644 --- a/content/docs/2.15/scalers/gcp-stackdriver.md +++ b/content/docs/2.15/scalers/gcp-stackdriver.md @@ -2,6 +2,7 @@ title = "Google Cloud Platform Stackdriver" availability = "2.7+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a metric obtained from Stackdriver." go_file = "gcp_stackdriver_scaler" +++ diff --git a/content/docs/2.15/scalers/gcp-storage.md b/content/docs/2.15/scalers/gcp-storage.md index a4a0ccc03..e32b5c912 100644 --- a/content/docs/2.15/scalers/gcp-storage.md +++ b/content/docs/2.15/scalers/gcp-storage.md @@ -2,6 +2,7 @@ title = "Google Cloud Platform Storage" availability = "2.7+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on the count of objects in a given Google Cloud Storage (GCS) bucket." go_file = "gcp_storage_scaler" +++ diff --git a/content/docs/2.15/scalers/github-runner.md b/content/docs/2.15/scalers/github-runner.md index 56719eba4..f8da2f8ce 100644 --- a/content/docs/2.15/scalers/github-runner.md +++ b/content/docs/2.15/scalers/github-runner.md @@ -2,6 +2,7 @@ title = "Github Runner Scaler" availability = "v2.10+" maintainer = "GitHub" +category = "CI/CD" description = "Scale GitHub Runners based on the number of queued jobs in GitHub Actions" go_file = "github_runner_scaler" +++ diff --git a/content/docs/2.15/scalers/graphite.md b/content/docs/2.15/scalers/graphite.md index 88bd21097..08fa4d5f0 100644 --- a/content/docs/2.15/scalers/graphite.md +++ b/content/docs/2.15/scalers/graphite.md @@ -2,6 +2,7 @@ title = "Graphite" availability = "v2.5+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on metrics in Graphite." go_file = "graphite_scaler" +++ diff --git a/content/docs/2.15/scalers/huawei-cloudeye.md b/content/docs/2.15/scalers/huawei-cloudeye.md index 97863f25c..2ddfadaba 100644 --- a/content/docs/2.15/scalers/huawei-cloudeye.md +++ b/content/docs/2.15/scalers/huawei-cloudeye.md @@ -2,6 +2,7 @@ title = "Huawei Cloudeye" availability = "v1.1+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a Huawei Cloudeye." go_file = "huawei_cloudeye_scaler" +++ diff --git a/content/docs/2.15/scalers/ibm-mq.md b/content/docs/2.15/scalers/ibm-mq.md index f3aceaf3a..786e66ee2 100644 --- a/content/docs/2.15/scalers/ibm-mq.md +++ b/content/docs/2.15/scalers/ibm-mq.md @@ -2,6 +2,7 @@ title = "IBM MQ" availability = "v2.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on IBM MQ Queue" go_file = "ibmmq_scaler" +++ diff --git a/content/docs/2.15/scalers/influxdb.md b/content/docs/2.15/scalers/influxdb.md index 7aafafb87..2be2f830b 100644 --- a/content/docs/2.15/scalers/influxdb.md +++ b/content/docs/2.15/scalers/influxdb.md @@ -2,6 +2,7 @@ title = "InfluxDB" availability = "v2.1+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on InfluxDB queries" go_file = "influxdb_scaler" +++ diff --git a/content/docs/2.15/scalers/kubernetes-workload.md b/content/docs/2.15/scalers/kubernetes-workload.md index 365b2f878..bb0d18159 100644 --- a/content/docs/2.15/scalers/kubernetes-workload.md +++ b/content/docs/2.15/scalers/kubernetes-workload.md @@ -2,6 +2,7 @@ title = "Kubernetes Workload" availability = "v2.4+" maintainer = "Community" +category = "Apps" description = "Scale applications based on the count of running pods that match the given selectors." go_file = "kubernetes_workload_scaler" +++ diff --git a/content/docs/2.15/scalers/liiklus-topic.md b/content/docs/2.15/scalers/liiklus-topic.md index 5741a0df3..4ef51a7c6 100644 --- a/content/docs/2.15/scalers/liiklus-topic.md +++ b/content/docs/2.15/scalers/liiklus-topic.md @@ -2,6 +2,7 @@ title = "Liiklus Topic" availability = "v1.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on Liiklus Topic." go_file = "liiklus_scaler" +++ diff --git a/content/docs/2.15/scalers/loki.md b/content/docs/2.15/scalers/loki.md index 8cc974e89..e3e553f1d 100644 --- a/content/docs/2.15/scalers/loki.md +++ b/content/docs/2.15/scalers/loki.md @@ -2,6 +2,7 @@ title = "Loki" availability = "v2.9+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on Loki query result." go_file = "loki_scaler" +++ diff --git a/content/docs/2.15/scalers/memory.md b/content/docs/2.15/scalers/memory.md index ec55f56e2..af6c76a4c 100644 --- a/content/docs/2.15/scalers/memory.md +++ b/content/docs/2.15/scalers/memory.md @@ -2,6 +2,7 @@ title = "Memory" availability = "v2.0+" maintainer = "Community" +category = "Apps" description = "Scale applications based on memory metrics." go_file = "cpu_memory_scaler" +++ diff --git a/content/docs/2.15/scalers/metrics-api.md b/content/docs/2.15/scalers/metrics-api.md index f4bdb68a5..ae22df53b 100644 --- a/content/docs/2.15/scalers/metrics-api.md +++ b/content/docs/2.15/scalers/metrics-api.md @@ -2,6 +2,7 @@ title = "Metrics API" availability = "v2.0+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a metric provided by an API" go_file = "metrics_api_scaler" +++ diff --git a/content/docs/2.15/scalers/mongodb.md b/content/docs/2.15/scalers/mongodb.md index d36ff1c31..2ca3c1068 100644 --- a/content/docs/2.15/scalers/mongodb.md +++ b/content/docs/2.15/scalers/mongodb.md @@ -1,6 +1,7 @@ +++ title = "MongoDB" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on MongoDB queries." availability = "v2.1+" go_file = "mongo_scaler" diff --git a/content/docs/2.15/scalers/mssql.md b/content/docs/2.15/scalers/mssql.md index 98839f2d2..78b5c9803 100644 --- a/content/docs/2.15/scalers/mssql.md +++ b/content/docs/2.15/scalers/mssql.md @@ -2,6 +2,7 @@ title = "MSSQL" availability = "v2.2+" maintainer = "Microsoft" +category = "Data & Storage" description = "Scale applications based on Microsoft SQL Server (MSSQL) query results." go_file = "mssql_scaler" +++ diff --git a/content/docs/2.15/scalers/mysql.md b/content/docs/2.15/scalers/mysql.md index 2ac08c531..8598d34c8 100644 --- a/content/docs/2.15/scalers/mysql.md +++ b/content/docs/2.15/scalers/mysql.md @@ -2,6 +2,7 @@ title = "MySQL" availability = "v1.2+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on MySQL query result." go_file = "mysql_scaler" +++ diff --git a/content/docs/2.15/scalers/nats-jetstream.md b/content/docs/2.15/scalers/nats-jetstream.md index 4cb8e812e..f81517a83 100644 --- a/content/docs/2.15/scalers/nats-jetstream.md +++ b/content/docs/2.15/scalers/nats-jetstream.md @@ -3,6 +3,7 @@ title = "NATS JetStream" layout = "scaler" availability = "v2.8+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on NATS JetStream." go_file = "nats_jetstream_scaler" +++ diff --git a/content/docs/2.15/scalers/nats-streaming.md b/content/docs/2.15/scalers/nats-streaming.md index f26887447..490082ed3 100644 --- a/content/docs/2.15/scalers/nats-streaming.md +++ b/content/docs/2.15/scalers/nats-streaming.md @@ -2,6 +2,7 @@ title = "NATS Streaming" availability = "v1.0+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on NATS Streaming." go_file = "stan_scaler" +++ diff --git a/content/docs/2.15/scalers/new-relic.md b/content/docs/2.15/scalers/new-relic.md index 3d12b8ca2..08bc3b521 100644 --- a/content/docs/2.15/scalers/new-relic.md +++ b/content/docs/2.15/scalers/new-relic.md @@ -2,6 +2,7 @@ title = "New Relic" availability = "2.6+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on New Relic NRQL" go_file = "newrelic_scaler" +++ diff --git a/content/docs/2.15/scalers/openstack-metric.md b/content/docs/2.15/scalers/openstack-metric.md index 1d9330dc9..c50a8ec04 100644 --- a/content/docs/2.15/scalers/openstack-metric.md +++ b/content/docs/2.15/scalers/openstack-metric.md @@ -2,6 +2,7 @@ title = "OpenStack Metric" availability = "v2.3+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on a threshold reached by a specific measure from OpenStack Metric API." go_file = "openstack_metrics_scaler" +++ diff --git a/content/docs/2.15/scalers/openstack-swift.md b/content/docs/2.15/scalers/openstack-swift.md index 392dc5b1b..147132ec5 100644 --- a/content/docs/2.15/scalers/openstack-swift.md +++ b/content/docs/2.15/scalers/openstack-swift.md @@ -2,6 +2,7 @@ title = "OpenStack Swift" availability = "v2.1+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on the count of objects in a given OpenStack Swift container." go_file = "openstack_swift_scaler" +++ diff --git a/content/docs/2.15/scalers/postgresql.md b/content/docs/2.15/scalers/postgresql.md index 51b9b9194..9aa5b8f04 100644 --- a/content/docs/2.15/scalers/postgresql.md +++ b/content/docs/2.15/scalers/postgresql.md @@ -2,6 +2,7 @@ title = "PostgreSQL" availability = "v1.2+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on a PostgreSQL query." go_file = "postgresql_scaler" +++ diff --git a/content/docs/2.15/scalers/predictkube.md b/content/docs/2.15/scalers/predictkube.md index c9e33715a..f79cf594e 100644 --- a/content/docs/2.15/scalers/predictkube.md +++ b/content/docs/2.15/scalers/predictkube.md @@ -2,6 +2,7 @@ title = "Predictkube" availability = "v2.6+" maintainer = "Dysnix" +category = "Metrics" description = "AI-based predictive scaling based on Prometheus metrics & PredictKube SaaS." go_file = "predictkube_scaler" +++ diff --git a/content/docs/2.15/scalers/prometheus.md b/content/docs/2.15/scalers/prometheus.md index a84d40f8a..406f8c8db 100644 --- a/content/docs/2.15/scalers/prometheus.md +++ b/content/docs/2.15/scalers/prometheus.md @@ -2,6 +2,7 @@ title = "Prometheus" availability = "v1.0+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on Prometheus." go_file = "prometheus_scaler" +++ diff --git a/content/docs/2.15/scalers/pulsar.md b/content/docs/2.15/scalers/pulsar.md index 4f6141c16..b0c8edc11 100644 --- a/content/docs/2.15/scalers/pulsar.md +++ b/content/docs/2.15/scalers/pulsar.md @@ -2,6 +2,7 @@ title = "Apache Pulsar" availability = "v2.8" maintainer = "Community" +category = "Messaging" description = "Scale applications based on an Apache Pulsar topic subscription." go_file = "pulsar_scaler" layout = "scaler" diff --git a/content/docs/2.15/scalers/rabbitmq-queue.md b/content/docs/2.15/scalers/rabbitmq-queue.md index 932494cad..1e65d7dd5 100644 --- a/content/docs/2.15/scalers/rabbitmq-queue.md +++ b/content/docs/2.15/scalers/rabbitmq-queue.md @@ -2,6 +2,7 @@ title = "RabbitMQ Queue" availability = "v1.0+" maintainer = "Microsoft" +category = "Messaging" description = "Scale applications based on RabbitMQ Queue." go_file = "rabbitmq_scaler" +++ diff --git a/content/docs/2.15/scalers/redis-cluster-lists.md b/content/docs/2.15/scalers/redis-cluster-lists.md index 38d1960d8..6e6c240e9 100644 --- a/content/docs/2.15/scalers/redis-cluster-lists.md +++ b/content/docs/2.15/scalers/redis-cluster-lists.md @@ -2,6 +2,7 @@ title = "Redis Lists (supports Redis Cluster)" availability = "v2.1+" maintainer = "Community" +category = "Data & Storage" description = "Redis Lists scaler with support for Redis Cluster topology" go_file = "redis_scaler" +++ diff --git a/content/docs/2.15/scalers/redis-cluster-streams.md b/content/docs/2.15/scalers/redis-cluster-streams.md index 249ff0a5a..be57aa5f7 100644 --- a/content/docs/2.15/scalers/redis-cluster-streams.md +++ b/content/docs/2.15/scalers/redis-cluster-streams.md @@ -2,6 +2,7 @@ title = "Redis Streams (supports Redis Cluster)" availability = "v2.1+" maintainer = "Community" +category = "Data & Storage" description = "Redis Streams scaler with support for Redis Cluster topology" go_file = "redis_streams_scaler" +++ diff --git a/content/docs/2.15/scalers/redis-lists.md b/content/docs/2.15/scalers/redis-lists.md index 45f2979fc..e8b0ad83f 100644 --- a/content/docs/2.15/scalers/redis-lists.md +++ b/content/docs/2.15/scalers/redis-lists.md @@ -2,6 +2,7 @@ title = "Redis Lists" availability = "v1.0+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on Redis Lists." go_file = "redis_scaler" +++ diff --git a/content/docs/2.15/scalers/redis-sentinel-lists.md b/content/docs/2.15/scalers/redis-sentinel-lists.md index 852ab00d7..07bf4b25e 100644 --- a/content/docs/2.15/scalers/redis-sentinel-lists.md +++ b/content/docs/2.15/scalers/redis-sentinel-lists.md @@ -2,6 +2,7 @@ title = "Redis Lists (supports Redis Sentinel)" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Redis Lists scaler with support for Redis Sentinel topology" go_file = "redis_scaler" +++ diff --git a/content/docs/2.15/scalers/redis-sentinel-streams.md b/content/docs/2.15/scalers/redis-sentinel-streams.md index e8fb32351..0070884d9 100644 --- a/content/docs/2.15/scalers/redis-sentinel-streams.md +++ b/content/docs/2.15/scalers/redis-sentinel-streams.md @@ -2,6 +2,7 @@ title = "Redis Streams (supports Redis Sentinel)" availability = "v2.5+" maintainer = "Community" +category = "Data & Storage" description = "Redis Streams scaler with support for Redis Sentinel topology" go_file = "redis_streams_scaler" +++ diff --git a/content/docs/2.15/scalers/redis-streams.md b/content/docs/2.15/scalers/redis-streams.md index 45ca1bb42..0c8436acb 100644 --- a/content/docs/2.15/scalers/redis-streams.md +++ b/content/docs/2.15/scalers/redis-streams.md @@ -2,6 +2,7 @@ title = "Redis Streams" availability = "v1.5+" maintainer = "Community" +category = "Data & Storage" description = "Scale applications based on Redis Streams." go_file = "redis_streams_scaler" +++ diff --git a/content/docs/2.15/scalers/selenium-grid-scaler.md b/content/docs/2.15/scalers/selenium-grid-scaler.md index edeff1da7..d30c30aa9 100644 --- a/content/docs/2.15/scalers/selenium-grid-scaler.md +++ b/content/docs/2.15/scalers/selenium-grid-scaler.md @@ -2,6 +2,7 @@ title = "Selenium Grid Scaler" availability = "v2.4+" maintainer = "Volvo Cars" +category = "Testing" description = "Scales Selenium browser nodes based on number of requests waiting in session queue" go_file = "selenium_grid_scaler" +++ diff --git a/content/docs/2.15/scalers/solace-pub-sub.md b/content/docs/2.15/scalers/solace-pub-sub.md index 351a8e360..c8a3e8ba5 100644 --- a/content/docs/2.15/scalers/solace-pub-sub.md +++ b/content/docs/2.15/scalers/solace-pub-sub.md @@ -2,6 +2,7 @@ title = "Solace PubSub+ Event Broker" availability = "2.4+" maintainer = "Community" +category = "Messaging" description = "Scale applications based on Solace PubSub+ Event Broker Queues" go_file = "solace_scaler" +++ diff --git a/content/docs/2.15/scalers/solr.md b/content/docs/2.15/scalers/solr.md index a4fafb7f6..9eaac8f65 100644 --- a/content/docs/2.15/scalers/solr.md +++ b/content/docs/2.15/scalers/solr.md @@ -2,6 +2,7 @@ title = "Solr" availability = "v2.11+" maintainer = "Community" +category = "Metrics" description = "Scale applications based on Solr query results." go_file = "solr_scaler" +++ From a46b64fc13d4657a955a582e104ede40e28de950 Mon Sep 17 00:00:00 2001 From: Uchechukwu Obasi Date: Fri, 14 Jun 2024 08:09:34 +0100 Subject: [PATCH 09/31] Feat: Provide filtering capabilities for scalers (#1400) * Feat: Provide filtering capabilities for scalers Signed-off-by: thisisobate * chore: provide filter button on mobile Signed-off-by: thisisobate * chore: reduce spacing between filter and scaler cards Signed-off-by: thisisobate * chore: improve filter logic to use new model Signed-off-by: thisisobate * chore: reorder filter options Signed-off-by: thisisobate * chore: nit fix Signed-off-by: thisisobate --------- Signed-off-by: thisisobate Co-authored-by: Tom Kerkhove Signed-off-by: shubhusion --- assets/sass/style.sass | 28 +++ config.toml | 4 +- layouts/_default/list.lunr.json | 4 +- layouts/partials/javascript.html | 234 ++++++++++---------------- layouts/partials/scaler-layout.html | 103 ++++++++---- layouts/partials/scaler-template.html | 4 +- 6 files changed, 197 insertions(+), 180 deletions(-) diff --git a/assets/sass/style.sass b/assets/sass/style.sass index f71c9286c..016540311 100644 --- a/assets/sass/style.sass +++ b/assets/sass/style.sass @@ -367,3 +367,31 @@ hr @media screen and (min-width: 769px) .md-height-desktop height: 9rem + + .filter-icon + display: none + + .filter-options + display: inline-block + + .filter-pane + padding-left: 0 + padding-top: 20px + +@media screen and (max-width: 769px) + .filter-icon + padding: 0.5rem + cursor: pointer + border: 1px solid #DBDBDB + font-size: 18px + border-radius: 0.4rem + display: inline-block + &:hover + border: 1px solid #000000 + + .filter-options + display: none + + .filter-pane + padding-left: 20px + padding-top: 10px diff --git a/config.toml b/config.toml index 746792caf..3407abf04 100644 --- a/config.toml +++ b/config.toml @@ -66,8 +66,8 @@ notAlternative = true # parameters for lunr search [params.lunr] -vars = ["title", "maintainer", "description", "availability"] -params = ["availability", "maintainer"] +vars = ["title", "maintainer", "description", "availability", "category", "type"] +params = ["availability", "maintainer", "category", "type"] # "Highlighted Samples" section on the main page [[params.samples]] diff --git a/layouts/_default/list.lunr.json b/layouts/_default/list.lunr.json index 87e634064..7c5a7507f 100644 --- a/layouts/_default/list.lunr.json +++ b/layouts/_default/list.lunr.json @@ -1,6 +1,6 @@ {{- $index := slice -}} {{- range $scalers := where site.RegularPages ".CurrentSection.Title" "Scalers" -}} - {{- $index = $index | append (dict "title" $scalers.Title "version" (index (first 3 (split (delimit (split $scalers.RelPermalink "/") "," "") ",")) 2) "href" $scalers.RelPermalink "availability" $scalers.Params.availability "description" ($scalers.Description | markdownify) "maintainer" $scalers.Params.maintainer ) -}} + {{- $index = $index | append (dict "title" $scalers.Title "version" (index (first 3 (split (delimit (split $scalers.RelPermalink "/") "," "") ",")) 2) "href" $scalers.RelPermalink "availability" $scalers.Params.availability "description" ($scalers.Description | markdownify) "maintainer" $scalers.Params.maintainer "category" $scalers.Params.category "type" "built-in" ) -}} {{- end -}} -{{- $index | jsonify -}} \ No newline at end of file +{{- $index | jsonify -}} diff --git a/layouts/partials/javascript.html b/layouts/partials/javascript.html index 37105da88..b8d33a463 100644 --- a/layouts/partials/javascript.html +++ b/layouts/partials/javascript.html @@ -50,36 +50,7 @@ }); -{{/* Scalers filter */}} - - -{{/* In-built Scalers Search */}} +{{/* Scaler Search and filter */}}