From 85c740b1006d519e9774d5a2325a85261b7d6b83 Mon Sep 17 00:00:00 2001 From: Mathias Petermann Date: Sun, 1 Oct 2023 14:29:34 +0200 Subject: [PATCH] chore: Add databaseIndex to documentation of all redis scalers in 2.12 --- content/docs/2.12/scalers/redis-cluster-lists.md | 2 ++ content/docs/2.12/scalers/redis-cluster-streams.md | 2 ++ content/docs/2.12/scalers/redis-sentinel-lists.md | 2 ++ content/docs/2.12/scalers/redis-sentinel-streams.md | 2 ++ content/docs/2.12/scalers/redis-streams.md | 2 +- 5 files changed, 9 insertions(+), 1 deletion(-) diff --git a/content/docs/2.12/scalers/redis-cluster-lists.md b/content/docs/2.12/scalers/redis-cluster-lists.md index 5c0a80753..d8e7fc095 100644 --- a/content/docs/2.12/scalers/redis-cluster-lists.md +++ b/content/docs/2.12/scalers/redis-cluster-lists.md @@ -22,6 +22,7 @@ triggers: activationListLength: "5" # optional enableTLS: "false" # optional unsafeSsl: "false" # optional + databaseIndex: "0" # optional # Alternatively, you can use existing environment variables to read configuration from: # See details in "Parameter list" section addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter @@ -40,6 +41,7 @@ triggers: - `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) +- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables: diff --git a/content/docs/2.12/scalers/redis-cluster-streams.md b/content/docs/2.12/scalers/redis-cluster-streams.md index 31a5ce5b0..249ff0a5a 100644 --- a/content/docs/2.12/scalers/redis-cluster-streams.md +++ b/content/docs/2.12/scalers/redis-cluster-streams.md @@ -35,6 +35,7 @@ triggers: activationLagCount: "3" # required if lagCount is provided - lag count at which scaler triggers enableTLS: "false" # optional unsafeSsl: "false" # optional + databaseIndex: "0" # optional # Alternatively, you can use existing environment variables to read configuration from: # See details in "Parameter list" section addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter @@ -68,6 +69,7 @@ triggers: - `activationLagCount` - Lag count threshold at which to start scaling. Any average lag count below this value will not trigger the scaler. (Default: `0`, Optional) - `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) +- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables: diff --git a/content/docs/2.12/scalers/redis-sentinel-lists.md b/content/docs/2.12/scalers/redis-sentinel-lists.md index 8ef5bfc17..0c14ca69e 100644 --- a/content/docs/2.12/scalers/redis-sentinel-lists.md +++ b/content/docs/2.12/scalers/redis-sentinel-lists.md @@ -25,6 +25,7 @@ triggers: activationListLength: "5" # optional enableTLS: "false" # optional unsafeSsl: "false" # optional + databaseIndex: "0" # optional # Alternatively, you can use existing environment variables to read configuration from: # See details in "Parameter list" section addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter @@ -46,6 +47,7 @@ triggers: - `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional) - `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) +- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables: diff --git a/content/docs/2.12/scalers/redis-sentinel-streams.md b/content/docs/2.12/scalers/redis-sentinel-streams.md index c808d9458..e8fb32351 100644 --- a/content/docs/2.12/scalers/redis-sentinel-streams.md +++ b/content/docs/2.12/scalers/redis-sentinel-streams.md @@ -35,6 +35,7 @@ triggers: activationLagCount: "3" # required if lagCount is provided - lag count at which scaler triggers enableTLS: "false" # optional unsafeSsl: "false" # optional + databaseIndex: "0" # optional # Alternatively, you can use existing environment variables to read configuration from: # See details in "Parameter list" section addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter @@ -72,6 +73,7 @@ triggers: - `activationLagCount` - Lag count threshold at which to start scaling. Any average lag count below this value will not trigger the scaler. (Default: `0`, Optional) - `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) +- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0. Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables: diff --git a/content/docs/2.12/scalers/redis-streams.md b/content/docs/2.12/scalers/redis-streams.md index b8782d6a8..365c04327 100644 --- a/content/docs/2.12/scalers/redis-streams.md +++ b/content/docs/2.12/scalers/redis-streams.md @@ -62,9 +62,9 @@ triggers: > Setting the `consumerGroup` causes the scaler to operate on `pendingEntriesCount`. Lack of `consumerGroup` will cause the scaler to be based on `streamLength` - `pendingEntriesCount` - Threshold for the number of `Pending Entries List`. This is the average target value to scale the workload. (Default: `5`, Optional) - `streamLength` - Threshold for stream length, alternative average target value to scale workload. (Default: `5`, Optional) -- `databaseIndex` - The Redis database index. Defaults to `0` if not specified. - `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional) - `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`) +- `databaseIndex` - The Redis database index. Defaults to `0` if not specified. Some parameters could be provided using environmental variables, instead of setting them directly in metadata. Here is a list of parameters you can use to retrieve values from environment variables: