adding quickstart

Author: slorello89

.gitignore

@@ -43,3 +43,5 @@ out
 .project
 .classpath
 build
+*.terraform
+.gradle

.gradle/buildOutputCleanup/buildOutputCleanup.lock

@@ -5,4 +5,8 @@ redis_cloud_account_key = "REDIS_CLOUD_ACCOUNT_KEY"
 redis_cloud_api_key = "REDIS_CLOUD_API_KEY"
 sub_name = "NAME_FOR_YOUR_SUBSCRIPTION"
 db_name = "NAME_FOR_YOUR_DATABASE"
-last_four_digits="LAST_FOUR_DIGITS_OF_YOUR_CREDIT_CARD"
+last_four_digits="LAST_FOUR_DIGITS_OF_YOUR_CREDIT_CARD"
+gcloud_username="GCLOUD_USERNAME"
+gcloud_region = "GCLOUD_REGION"
+gcloud_zone = "GCLOUD_ZONE"
+ssh_key_file="ssh_key_file"

.gradle/file-system.probe

@@ -15,7 +15,7 @@ provider "rediscloud" {
 
 provider "google" {
     project = var.gcp_project
-    region  = "us-east1"  
+    region  = var.gcloud_region  
 }
 
 
@@ -26,7 +26,7 @@ resource "google_compute_network" "autoscale_test_vpc" {
 
 resource "google_compute_subnetwork" "autoscale_test_subnet" {
     name          = "autoscale-test-subnet"
-    region        = "us-east1"
+    region        = var.gcloud_region
     ip_cidr_range = "10.0.0.0/24"
     network       = google_compute_network.autoscale_test_vpc.id
     private_ip_google_access = true
@@ -97,7 +97,7 @@ resource "rediscloud_subscription" "autoscaling_sub" {
     cloud_provider {
         provider = "GCP"
         region {
-            region = "us-east1"
+            region = var.gcloud_region
             multiple_availability_zones = false
             networking_deployment_cidr = "10.0.1.0/24"
         }
@@ -145,24 +145,6 @@ resource "rediscloud_subscription_database" "autoscale-database" {
     ]
 }
 
-#data "rediscloud_subscription" "autoscale-sub" {
-#    name = var.sub_name
-#}
-
-#data "rediscloud_database" "autoscale-db" {
-#    subscription_id = rediscloud_subscription.autoscaling_sub.id
-#    name = "autoscale-database"
-#}
-#
-#data "google_compute_network" "autoscale_test_vpc" {
-#  name="autoscale-test-vpc"
-#}
-
-#data "google_compute_subnetwork" "autoscale_test_subnet" {
-#  name          = "autoscale-test-subnet"
-#  region        = "us-east1"
-#}
-
 # Extract the hostname portion of the private_endpoint
 locals {
   private_endpoint_host = join("", slice(split(":", rediscloud_subscription_database.autoscale-database.private_endpoint), 0, 1))
@@ -171,7 +153,7 @@ locals {
 resource "google_compute_instance" "autoscaler-vm"{
     name = "autoscaler-vm"
     machine_type = "n1-standard-1"
-    zone = "us-east1-b"
+    zone = var.gcloud_zone
     boot_disk {
         initialize_params {
             image = "ubuntu-2004-focal-v20240731"
@@ -181,8 +163,6 @@ resource "google_compute_instance" "autoscaler-vm"{
 
     network_interface {
         network = google_compute_network.autoscale_test_vpc.id
-#        network = data.google_compute_network.autoscale_test_vpc.id
-#        subnetwork = data.google_compute_subnetwork.autoscale_test_subnet.id
         subnetwork = google_compute_subnetwork.autoscale_test_subnet.id
         access_config {          
         }
@@ -203,7 +183,7 @@ resource "null_resource" "build_app" {
     }
 
     provisioner "file" {
-        source = "./autoscaler/redis-cloud-autoscaler/build/libs/redis-cloud-autoscaler-0.0.2.jar"
+        source = "./autoscaler/redis-cloud-autoscaler/build/libs/redis-cloud-autoscaler.jar"
         destination = "autoscaler.jar"      
     }
 
@@ -232,7 +212,7 @@ resource "null_resource" "build_app" {
             "echo 'Environment=REDIS_PASSWORD=${rediscloud_subscription_database.autoscale-database.password}' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
             "echo 'Environment=REDIS_CLOUD_API_KEY=${var.redis_cloud_api_key}' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
             "echo 'Environment=REDIS_CLOUD_ACCOUNT_KEY=${var.redis_cloud_account_key}' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
-            "echo 'Environment=REDIS_CLOUD_SUBSCRIPTION_ID=${rediscloud_subscription.autoscaling_sub.id}' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
+            "echo 'Environment=REDIS_CLOUD_SUBSCRIPTION_ID=${rediscloud_subscription_database.autoscale-database.id}' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
             "echo 'Environment=ALERT_MANAGER_HOST=${google_compute_instance.autoscale-vm-prometheus.network_interface[0].access_config[0].nat_ip}' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
             "echo 'Environment=ALERT_MANAGER_PORT=9093' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
             "echo 'ExecStart=/usr/bin/java -jar /usr/local/bin/autoscaler.jar' | sudo tee -a /etc/systemd/system/autoscaler.service > /dev/null",
@@ -265,7 +245,7 @@ resource "google_dns_record_set" "autoscaler_dns" {
 resource "google_compute_instance" "autoscale-vm-prometheus" {
     name = "autoscale-vm-prometheus"
     machine_type = "n1-standard-1"
-    zone = "us-east1-b"
+    zone = var.gcloud_zone
     boot_disk {
         initialize_params {
             image = "ubuntu-2004-focal-v20240731"
@@ -442,4 +422,4 @@ resource "google_dns_record_set" "autoscale_prometheus_dns" {
     type = "A"
     ttl = 300
     rrdatas = [google_compute_instance.autoscale-vm-prometheus.network_interface[0].access_config[0].nat_ip]  
-}
+}

.tfvars.example

@@ -0,0 +1,36 @@
+# Redis Cloud Autoscaler Quickstart
+
+## Purpose
+
+This is a quickstart guide for the Redis Cloud Autoscaler. It will show you how you can deploy the Redis Cloud Autoscaler alongside your Redis Cloud subscription.
+
+## Configure Environment
+
+Inside of the `gcp` folder you will find the `.tfvars.example` file. This file contains the environment variables that you need to set before you start the Redis Cloud Autoscaler. You can create a copy of this file called `.tfvars` and fill out the variables.
+
+### Spinning up the Redis Cloud Autoscaler with terraform in GCP
+
+To spin up the Redis Cloud Autoscaler with terraform in GCP, you can cd into the `gcp` folder and run the following command: `terraform init && terraform apply --var-file=.tfvars`. This will start the Redis Cloud Autoscaler in detached mode. and enter `yes` when prompted to apply the changes.
+
+### Create some Rules
+
+You can open the postman collection in the `postman` folder to create some rules for the Redis Cloud Autoscaler.
+
+#### Configure Postman
+
+1. In Postman import the `autoscaler.postman_collection.json` file in the `postman` folder.
+2. In Postman import the `autoscaler.postman_environment.json` file in the `postman` folder.
+3. Open the `autoscaler` environment.
+4. Update the `base_url` to the base URL of the Redis Cloud Autoscaler.
+7. Update the `db_id` to the ID of the database you want to scale.
+
+#### Create a Rule
+
+In Postman, open the Throughput rules or Memory rules collection.
+
+1. Click on the `IncreaseThroughputDeterministic` or `IncreaseMemoryDeterministic` request.
+2. Click on the `Body` tab.
+3. Update the `scale_value` to the value you want to scale to (in ops/sec).
+4. Click on the `Send` button.
+
+You should see a 200 status code.

main.tf

@@ -4,4 +4,6 @@ REDIS_CLOUD_API_KEY=
 REDIS_CLOUD_ACCOUNT_KEY=
 REDIS_CLOUD_SUBSCRIPTION_ID=
 ALERT_MANAGER_HOST=
-ALERT_MANAGER_PORT=
+ALERT_MANAGER_PORT=
+REDIS_CLOUD_INTERNAL_ENDPOINT=
+REDIS_CLOUD_AUTOSCALER_HOST=

quickstart/README.md

@@ -0,0 +1,36 @@
+services:
+  autoscaler:    
+    image: ghcr.io/redis-field-engineering/redis-cloud-autoscaler:latest
+    container_name: autoscaler
+    env_file:
+      - .env
+    ports:
+      - 8080:8080
+  alertmanager:
+    image: prom/alertmanager:latest
+    container_name: alertmanager
+    links:
+      - autoscaler
+    env_file:
+      - .env
+    volumes:
+      - ./prometheus/alertmanager.yml:/etc/alertmanager/alertmanager.yml
+    ports:
+      - 9093:9093
+    command: 
+      - '--config.file=/etc/alertmanager/alertmanager.yml'
+  prometheus:
+    image: prom/prometheus
+    container_name: prometheus
+    links:
+      - alertmanager
+    env_file:
+      - .env
+    volumes:
+      - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
+      - ./prometheus/alert.rules:/etc/prometheus/alert.rules
+      - ./prometheus/alertmanager.yml:/etc/prometheus/alertmanager.yml
+    command: 
+      - '--config.file=/etc/prometheus/prometheus.yml'
+    ports:
+      - 9090:9090

quickstart/docker-compose.yml

@@ -0,0 +1,35 @@
+groups:
+    - name: RedisAlerts
+      rules:
+        - alert: IncreaseMemory
+          expr: sum by (instance, db) (redis_server_used_memory) / sum by (instance, db) (redis_server_maxmemory) * 100 > 80
+          for: 1m
+          labels:
+            severity: warning
+          annotations:
+            summary: "High Redis Memory Usage"
+            description: "Redis memory usage is high"
+        - alert: DecreaseMemory
+          expr: sum by (instance, db) (redis_server_used_memory) / sum by (instance, db) (redis_server_maxmemory) * 100 < 20
+          for: 1m
+          labels:
+            severity: warning
+          annotations:
+            summary: "Low Redis Memory Usage"
+            description: "Redis memory usage is low"
+        - alert: IncreaseThroughput
+          expr: sum by (db, instance) (irate(endpoint_write_requests[1m]) + irate(endpoint_read_requests[1m])) / on(db) group_left() redis_db_configured_throughput * 100 > 80
+          for: 1m
+          labels:
+            severity: warning
+          annotations:
+            summary: "High Redis Throughput"
+            description: "Redis throughput is high"
+        - alert: DecreaseThroughput
+          expr: sum by (db, instance) (irate(endpoint_write_requests[1m]) + irate(endpoint_read_requests[1m])) / on(db) group_left() redis_db_configured_throughput * 100 < 20
+          for: 1m
+          labels:
+            severity: warning
+          annotations:
+            summary: "Low Redis Throughput"
+            description: "Redis throughput is low"

quickstart/.env.example renamed to quickstart/docker/.env.example

@@ -8,7 +8,7 @@ alerting:
     - static_configs:
       - targets:
         # Alertmanager's default port is 9093
-        - localhost:9093
+        - alertmanager:9093
 
 scrape_configs:
   - job_name: 'prometheus'

quickstart/docker/docker-compose.yml

@@ -0,0 +1,12 @@
+gcp_project = "YOUR_GCP_PROJECT_ID"
+dns-zone-name="DNS_ZONE_NAME"
+subdomain="FULLY_QUALIFIED_DNS_SUBDOMAIN"
+redis_cloud_account_key = "REDIS_CLOUD_ACCOUNT_KEY"
+redis_cloud_api_key = "REDIS_CLOUD_API_KEY"
+sub_name = "NAME_FOR_YOUR_SUBSCRIPTION"
+db_name = "NAME_FOR_YOUR_DATABASE"
+last_four_digits="LAST_FOUR_DIGITS_OF_YOUR_CREDIT_CARD"
+gcloud_username="YOUR_GCLOUD_USERNAME"
+gcloud_region = "GCLOUD_REGION"
+gcloud_zone = "GCLOUD_ZONE"
+ssh_key_file="ssh_key_file"