examples for version 1.0

kumarvna · kumarvna · commit 8b462241e11a · 2021-07-10T22:35:08.000+05:30
diff --git a/README.md b/README.md
@@ -54,6 +54,14 @@ module "redis" {
     maxmemory_policy   = "allkeys-lru"
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time.
+  # The Patch Window lasts for 5 hours from the start_hour_utc
+  patch_schedule = {
+    days_of_week   = "Monday"
+    start_hour_utc = 21
+  }
+
   #Azure Cache for Redis firewall filter rules are used to provide specific source IP access. 
   # Azure Redis Cache access is determined based on start and end IP address range specified. 
   # As a rule, only specific IP addresses should be granted access, and all others denied.
diff --git a/examples/Azure_Cache_for_Redis_with_Cluster/output.tf b/examples/Azure_Cache_for_Redis_with_Cluster/output.tf
@@ -16,6 +16,7 @@ output "redis_cache_ssl_port" {
 output "redis_cache_port" {
   description = "The non-SSL Port of the Redis Instance"
   value       = module.redis.redis_cache_port
+  sensitive   = true
 }
 
 output "redis_cache_primary_access_key" {
diff --git a/examples/Azure_Cache_for_Redis_with_Data_Persistence_Enabled/output.tf b/examples/Azure_Cache_for_Redis_with_Data_Persistence_Enabled/output.tf
@@ -16,6 +16,7 @@ output "redis_cache_ssl_port" {
 output "redis_cache_port" {
   description = "The non-SSL Port of the Redis Instance"
   value       = module.redis.redis_cache_port
+  sensitive   = true
 }
 
 output "redis_cache_primary_access_key" {
diff --git a/examples/Azure_Cache_for_Redis_with_Private_Endpoint/README.md b/examples/Azure_Cache_for_Redis_with_Private_Endpoint/README.md
@@ -29,10 +29,6 @@ module "redis" {
       shard_count         = 3
       zones               = ["1", "2", "3"]
       enable_non_ssl_port = true
-      patch_schedule = {
-        days_of_week   = "Monday"
-        start_hour_utc = 21
-      }
     }
   }
 
@@ -44,6 +40,14 @@ module "redis" {
     maxmemory_policy   = "allkeys-lru"
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time.
+  # The Patch Window lasts for 5 hours from the start_hour_utc
+  patch_schedule = {
+    days_of_week   = "Monday"
+    start_hour_utc = 21
+  }
+
   #Azure Cache for Redis firewall filter rules are used to provide specific source IP access. 
   # Azure Redis Cache access is determined based on start and end IP address range specified. 
   # As a rule, only specific IP addresses should be granted access, and all others denied.
diff --git a/examples/Azure_Cache_for_Redis_with_Private_Endpoint/main.tf b/examples/Azure_Cache_for_Redis_with_Private_Endpoint/main.tf
@@ -20,10 +20,6 @@ module "redis" {
       shard_count         = 3
       zones               = ["1", "2", "3"]
       enable_non_ssl_port = true
-      patch_schedule = {
-        days_of_week   = "Monday"
-        start_hour_utc = 21
-      }
     }
   }
 
@@ -35,6 +31,14 @@ module "redis" {
     maxmemory_policy   = "allkeys-lru"
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time.
+  # The Patch Window lasts for 5 hours from the start_hour_utc
+  patch_schedule = {
+    days_of_week   = "Monday"
+    start_hour_utc = 21
+  }
+
   #Azure Cache for Redis firewall filter rules are used to provide specific source IP access. 
   # Azure Redis Cache access is determined based on start and end IP address range specified. 
   # As a rule, only specific IP addresses should be granted access, and all others denied.
diff --git a/examples/Azure_Cache_for_Redis_with_Private_Endpoint/output.tf b/examples/Azure_Cache_for_Redis_with_Private_Endpoint/output.tf
@@ -16,6 +16,7 @@ output "redis_cache_ssl_port" {
 output "redis_cache_port" {
   description = "The non-SSL Port of the Redis Instance"
   value       = module.redis.redis_cache_port
+  sensitive   = true
 }
 
 output "redis_cache_primary_access_key" {
diff --git a/examples/Azure_Cache_for_Redis_with_Private_Endpoint/variables.tf b/examples/Azure_Cache_for_Redis_with_Private_Endpoint/variables.tf
diff --git a/examples/README.md b/examples/README.md
@@ -37,6 +37,14 @@ module "redis" {
     maxmemory_policy   = "allkeys-lru"
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time. 
+  # The Patch Window lasts for 5 hours from the `start_hour_utc`
+  patch_schedule = {
+    day_of_week    = "Saturday"
+    start_hour_utc = 10
+  }
+
   # (Optional) To enable Azure Monitoring for Azure Cache for Redis
   # (Optional) Specify `storage_account_name` to save monitoring logs to storage. 
   log_analytics_workspace_name = "loganalytics-we-sharedtest2"
@@ -270,10 +278,6 @@ module "redis" {
       shard_count         = 3
       zones               = ["1", "2", "3"]
       enable_non_ssl_port = true
-      patch_schedule = {
-        days_of_week   = "Monday"
-        start_hour_utc = 21
-      }
     }
   }
 
@@ -285,6 +289,14 @@ module "redis" {
     maxmemory_policy   = "allkeys-lru"
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time. 
+  # The Patch Window lasts for 5 hours from the `start_hour_utc`
+  patch_schedule = {
+    day_of_week    = "Saturday"
+    start_hour_utc = 10
+  }
+
   #Azure Cache for Redis firewall filter rules are used to provide specific source IP access. 
   # Azure Redis Cache access is determined based on start and end IP address range specified. 
   # As a rule, only specific IP addresses should be granted access, and all others denied.
diff --git a/examples/Simple_Azure_Cache_for_Redis/README.md b/examples/Simple_Azure_Cache_for_Redis/README.md
@@ -37,6 +37,14 @@ module "redis" {
     maxmemory_policy   = "allkeys-lru"
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time. 
+  # The Patch Window lasts for 5 hours from the `start_hour_utc`
+  patch_schedule = {
+    day_of_week    = "Saturday"
+    start_hour_utc = 10
+  }
+
   # (Optional) To enable Azure Monitoring for Azure Cache for Redis
   # (Optional) Specify `storage_account_name` to save monitoring logs to storage. 
   log_analytics_workspace_name = "loganalytics-we-sharedtest2"
diff --git a/examples/Simple_Azure_Cache_for_Redis/main.tf b/examples/Simple_Azure_Cache_for_Redis/main.tf
@@ -20,6 +20,14 @@ module "redis" {
     }
   }
 
+  # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.
+  # Clustered caches are patched one shard at a time. 
+  # The Patch Window lasts for 5 hours from the `start_hour_utc`
+  patch_schedule = {
+    day_of_week    = "Saturday"
+    start_hour_utc = 10
+  }
+
   # MEMORY MANAGEMENT
   # Azure Cache for Redis instances are configured with the following default Redis configuration values:
   redis_configuration = {
diff --git a/examples/Simple_Azure_Cache_for_Redis/output.tf b/examples/Simple_Azure_Cache_for_Redis/output.tf
@@ -16,6 +16,7 @@ output "redis_cache_ssl_port" {
 output "redis_cache_port" {
   description = "The non-SSL Port of the Redis Instance"
   value       = module.redis.redis_cache_port
+  sensitive   = true
 }
 
 output "redis_cache_primary_access_key" {
diff --git a/main.tf b/main.tf
@@ -93,14 +93,28 @@ resource "azurerm_redis_cache" "main" {
     rdb_backup_max_snapshot_count   = each.value["sku_name"] == "Premium" && var.enable_data_persistence == true ? var.data_persistence_backup_max_snapshot_count : null
     rdb_storage_connection_string   = each.value["sku_name"] == "Premium" && var.enable_data_persistence == true ? azurerm_storage_account.storeacc.0.primary_blob_connection_string : null
   }
-
+  /*
   patch_schedule {
     day_of_week    = each.value.patch_schedule["days_of_week"]
     start_hour_utc = each.value.patch_schedule["start_hour_utc"]
   }
 
+  patch_schedule {
+    day_of_week    = lookup(var.patch_schedule, "day_of_week")
+    start_hour_utc = lookup(var.patch_schedule, "start_hour_utc")
+  }
+*/
+
+  dynamic "patch_schedule" {
+    for_each = var.patch_schedule != null ? [var.patch_schedule] : []
+    content {
+      day_of_week    = var.patch_schedule.day_of_week    #lookup(var.patch_schedule, "day_of_week", null)
+      start_hour_utc = var.patch_schedule.start_hour_utc #lookup(var.patch_schedule, "start_hour_utc", null)
+    }
+  }
+
   lifecycle {
-    # A bug in the Redis API where the original storage connection string isn't being returned
+    # A bug in the Redis API where the original storage connection string isn't being returneds
     ignore_changes = [redis_configuration.0.rdb_storage_connection_string]
   }
 }
diff --git a/output.tf b/output.tf
@@ -15,7 +15,8 @@ output "redis_cache_ssl_port" {
 
 output "redis_cache_port" {
   description = "The non-SSL Port of the Redis Instance"
-  value       = element(concat([for p in azurerm_redis_cache.main : p.port], [""]), 0)
+  value       = element(concat([for p in azurerm_redis_cache.main : p.port if p == true], [""]), 0)
+  sensitive   = true
 }
 
 output "redis_cache_primary_access_key" {
diff --git a/variables.tf b/variables.tf
@@ -44,15 +44,20 @@ variable "redis_server_settings" {
     replicas_per_master           = optional(number)
     shard_count                   = optional(number)
     zones                         = optional(list(string))
-    patch_schedule = optional(object({
-      days_of_week   = optional(string)
-      start_hour_utc = optional(number)
-    }))
   }))
   description = "optional redis server setttings for both Premium and Standard/Basic SKU"
   default     = {}
 }
 
+variable "patch_schedule" {
+  type = object({
+    day_of_week    = string
+    start_hour_utc = number
+  })
+  description = "The window for redis maintenance. The Patch Window lasts for 5 hours from the `start_hour_utc` "
+  default     = null
+}
+
 variable "subnet_id" {
   description = "The ID of the Subnet within which the Redis Cache should be deployed. Only available when using the Premium SKU and this subnet s "
   default     = null

Original file line number	Diff line number	Diff line change
`@@ -16,6 +16,7 @@ output "redis_cache_ssl_port" {`
`16`	`16`	`output "redis_cache_port" {`
`17`	`17`	`description = "The non-SSL Port of the Redis Instance"`
`18`	`18`	`value = module.redis.redis_cache_port`
	`19`	`+ sensitive = true`
`19`	`20`	`}`
`20`	`21`
`21`	`22`	`output "redis_cache_primary_access_key" {`
Original file line number	Diff line number	Diff line change
`@@ -20,6 +20,14 @@ module "redis" {`
`20`	`20`	`}`
`21`	`21`	`}`
`22`	`22`
	`23`	`+ # Nodes are patched one at a time to prevent data loss. Basic caches will have data loss.`
	`24`	`+ # Clustered caches are patched one shard at a time.`
	`25`	+ # The Patch Window lasts for 5 hours from the `start_hour_utc`
	`26`	`+ patch_schedule = {`
	`27`	`+ day_of_week = "Saturday"`
	`28`	`+ start_hour_utc = 10`
	`29`	`+ }`
	`30`	`+`
`23`	`31`	`# MEMORY MANAGEMENT`
`24`	`32`	`# Azure Cache for Redis instances are configured with the following default Redis configuration values:`
`25`	`33`	`redis_configuration = {`