Skip to content

Commit a9520a2

Browse files
authored
chore: Add databaseIndex to documentation of redis-cluster scaler (kedacore#1234)
1 parent dfdde58 commit a9520a2

10 files changed

+18
-2
lines changed

content/docs/2.12/scalers/redis-cluster-lists.md

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ triggers:
2222
activationListLength: "5" # optional
2323
enableTLS: "false" # optional
2424
unsafeSsl: "false" # optional
25+
databaseIndex: "0" # optional
2526
# Alternatively, you can use existing environment variables to read configuration from:
2627
# See details in "Parameter list" section
2728
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -40,6 +41,7 @@ triggers:
4041
- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
4142
- `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional)
4243
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
44+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
4345

4446
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:
4547

content/docs/2.12/scalers/redis-cluster-streams.md

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ triggers:
3535
activationLagCount: "3" # required if lagCount is provided - lag count at which scaler triggers
3636
enableTLS: "false" # optional
3737
unsafeSsl: "false" # optional
38+
databaseIndex: "0" # optional
3839
# Alternatively, you can use existing environment variables to read configuration from:
3940
# See details in "Parameter list" section
4041
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -68,6 +69,7 @@ triggers:
6869
- `activationLagCount` - Lag count threshold at which to start scaling. Any average lag count below this value will not trigger the scaler. (Default: `0`, Optional)
6970
- `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional)
7071
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
72+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
7173

7274
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:
7375

content/docs/2.12/scalers/redis-sentinel-lists.md

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ triggers:
2525
activationListLength: "5" # optional
2626
enableTLS: "false" # optional
2727
unsafeSsl: "false" # optional
28+
databaseIndex: "0" # optional
2829
# Alternatively, you can use existing environment variables to read configuration from:
2930
# See details in "Parameter list" section
3031
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -46,6 +47,7 @@ triggers:
4647
- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
4748
- `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional)
4849
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
50+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
4951

5052
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:
5153

content/docs/2.12/scalers/redis-sentinel-streams.md

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ triggers:
3535
activationLagCount: "3" # required if lagCount is provided - lag count at which scaler triggers
3636
enableTLS: "false" # optional
3737
unsafeSsl: "false" # optional
38+
databaseIndex: "0" # optional
3839
# Alternatively, you can use existing environment variables to read configuration from:
3940
# See details in "Parameter list" section
4041
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -72,6 +73,7 @@ triggers:
7273
- `activationLagCount` - Lag count threshold at which to start scaling. Any average lag count below this value will not trigger the scaler. (Default: `0`, Optional)
7374
- `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional)
7475
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
76+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
7577

7678
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:
7779

content/docs/2.12/scalers/redis-streams.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ triggers:
6262
> Setting the `consumerGroup` causes the scaler to operate on `pendingEntriesCount`. Lack of `consumerGroup` will cause the scaler to be based on `streamLength`
6363
- `pendingEntriesCount` - Threshold for the number of `Pending Entries List`. This is the average target value to scale the workload. (Default: `5`, Optional)
6464
- `streamLength` - Threshold for stream length, alternative average target value to scale workload. (Default: `5`, Optional)
65-
- `databaseIndex` - The Redis database index. Defaults to `0` if not specified.
6665
- `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional)
6766
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
67+
- `databaseIndex` - The Redis database index. Defaults to `0` if not specified.
6868

6969
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:
7070

content/docs/2.13/scalers/redis-cluster-lists.md

+2
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ triggers:
2222
activationListLength: "5" # optional
2323
enableTLS: "false" # optional
2424
unsafeSsl: "false" # optional
25+
databaseIndex: "0" # optional
2526
# Alternatively, you can use existing environment variables to read configuration from:
2627
# See details in "Parameter list" section
2728
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -40,6 +41,7 @@ triggers:
4041
- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
4142
- `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional)
4243
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
44+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
4345

4446
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:
4547

content/docs/2.13/scalers/redis-cluster-streams.md

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ triggers:
3535
activationLagCount: "3" # required if lagCount is provided - lag count at which scaler triggers
3636
enableTLS: "false" # optional
3737
unsafeSsl: "false" # optional
38+
databaseIndex: "0" # optional
3839
# Alternatively, you can use existing environment variables to read configuration from:
3940
# See details in "Parameter list" section
4041
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -68,6 +69,7 @@ triggers:
6869
- `activationLagCount` - Lag count threshold at which to start scaling. Any average lag count below this value will not trigger the scaler. (Default: `0`, Optional)
6970
- `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional)
7071
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
72+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
7173

7274
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:
7375

content/docs/2.13/scalers/redis-sentinel-lists.md

+2
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ triggers:
2525
activationListLength: "5" # optional
2626
enableTLS: "false" # optional
2727
unsafeSsl: "false" # optional
28+
databaseIndex: "0" # optional
2829
# Alternatively, you can use existing environment variables to read configuration from:
2930
# See details in "Parameter list" section
3031
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -46,6 +47,7 @@ triggers:
4647
- `activationListLength` - Target value for activating the scaler. Learn more about activation [here](./../concepts/scaling-deployments.md#activating-and-scaling-thresholds).(Default: `0`, Optional)
4748
- `enableTLS` - Allow a connection to a redis queue using tls. (Values: `true`, `false`, Default: `false`, Optional)
4849
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
50+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
4951

5052
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:
5153

content/docs/2.13/scalers/redis-sentinel-streams.md

+2
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@ triggers:
3535
activationLagCount: "3" # required if lagCount is provided - lag count at which scaler triggers
3636
enableTLS: "false" # optional
3737
unsafeSsl: "false" # optional
38+
databaseIndex: "0" # optional
3839
# Alternatively, you can use existing environment variables to read configuration from:
3940
# See details in "Parameter list" section
4041
addressesFromEnv: REDIS_ADDRESSES # Optional. You can use this instead of `addresses` parameter
@@ -72,6 +73,7 @@ triggers:
7273
- `activationLagCount` - Lag count threshold at which to start scaling. Any average lag count below this value will not trigger the scaler. (Default: `0`, Optional)
7374
- `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional)
7475
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
76+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
7577

7678
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:
7779

content/docs/2.13/scalers/redis-streams.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -62,9 +62,9 @@ triggers:
6262
> Setting the `consumerGroup` causes the scaler to operate on `pendingEntriesCount`. Lack of `consumerGroup` will cause the scaler to be based on `streamLength`
6363
- `pendingEntriesCount` - Threshold for the number of `Pending Entries List`. This is the average target value to scale the workload. (Default: `5`, Optional)
6464
- `streamLength` - Threshold for stream length, alternative average target value to scale workload. (Default: `5`, Optional)
65-
- `databaseIndex` - The Redis database index. Defaults to `0` if not specified.
6665
- `enableTLS` - Allow a connection to Redis using tls. (Values: `true`, `false`, Default: `false`, Optional)
6766
- `unsafeSsl` - Used for skipping certificate check e.g: using self-signed certs. (Values: `true`,`false`, Default: `false`, Optional, This requires `enableTLS: true`)
67+
- `databaseIndex` - Index of Redis database to use. If not specified, the default value is 0.
6868

6969
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:
7070

0 commit comments

Comments
 (0)