Skip to content

Commit 2f63773

Browse files
committed
adding configuration table to readme
1 parent 3c401c1 commit 2f63773

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

README.adoc

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,22 @@ The Redis Cloud Autoscaler is and application designed to run in your own enviro
2020
1. **Prometheus Alerts** You can configure your Prometheus Alert Manager ot send webhook alerts to the Redis Cloud Autoscaler, the Autoscaler's rule-based scaling system will then scale your Redis Cloud instance out / in based off of the alerts it receives.
2121
2. **Scheduled Scaling** You can configure the Redis Cloud Autoscaler to scale your Redis Cloud instance out / in based on a schedule you define.
2222

23+
== Configuration
24+
25+
=== Redis Cloud Autoscaler Config Items
26+
27+
[options="header"]
28+
|===
29+
| Name | Description
30+
| REDIS_HOST_AND_PORT | The private endpoint of the Redis Cloud subscription database.
31+
| REDIS_PASSWORD | The password for accessing the Redis Cloud database.
32+
| REDIS_CLOUD_API_KEY | The API key for interacting with Redis Cloud services.
33+
| REDIS_CLOUD_ACCOUNT_KEY | The account key for authenticating with Redis Cloud.
34+
| REDIS_CLOUD_SUBSCRIPTION_ID | The ID of the Redis Cloud subscription.
35+
| ALERT_MANAGER_HOST | The public IP address of the Prometheus Alert Manager instance.
36+
| ALERT_MANAGER_PORT | The port on which Alert Manager is running (default: 9093).
37+
|===
38+
2339
=== Defining Rules
2440

2541
The Redis Cloud Autoscaler uses a JSON-based rule system to define how a given Redis Cloud Database should be scaled.

0 commit comments

Comments
 (0)