documentation for version 1.0

Author: kumarvna

README.md

@@ -76,7 +76,7 @@ module "redis" {
   # Creating Private Endpoint requires, VNet name and address prefix to create a subnet
   # By default this will create a `privatelink.mysql.database.azure.com` DNS zone. 
   # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name
-  # Private endpoints doesn't work If using `subnet_id` to create redis cache inside a specified virtual network
+  # Private endpoints doesn't work If using `subnet_id` to create redis inside a specified VNet.
   enable_private_endpoint       = true
   virtual_network_name          = "vnet-shared-hub-westeurope-001"
   private_subnet_address_prefix = ["10.1.5.0/29"]
@@ -95,5 +95,118 @@ module "redis" {
 }
 ```
 
-Schedule maintenance for Redis. The default maintenance window is 5 hours
-This does not cover any maintenance done by Azure for updating the underlying platform.
+## `redis_server_settings` - Azure Cache for Redis Server Settings
+
+## `redis_configuration` - Azure Cache for Redis configuration
+
+## Advanced Usage of the Module
+
+### Memory Management
+
+### Non-SSL port
+
+### Firewall Rules
+
+### Virtual network
+
+### Data Persistence
+
+### Patching Schedule
+
+### Cluster Support
+
+### Zones
+
+### Private Link to Azure Database for MySQL
+
+Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link. Private Endpoint uses a private IP address from your VNet, effectively bringing the service into your VNet.
+
+With Private Link, Microsoft offering the ability to associate a logical server to a specific private IP address (also known as private endpoint) within the VNet. Clients can connect to the Private endpoint from the same VNet, peered VNet in same region, or via VNet-to-VNet connection across regions. Additionally, clients can connect from on-premises using ExpressRoute, private peering, or VPN tunneling.
+
+By default, this feature not enabled on this module. To create private link with private endpoints set the variable `enable_private_endpoint` to `true` and provide `virtual_network_name`, `private_subnet_address_prefix` with a valid values. You can also use the existing private DNS zone to create DNS records. To use this feature, set the `existing_private_dns_zone` with a valid existing private DNS zone name.
+
+For more details: [Private Link for Azure Database for MySQL](https://docs.microsoft.com/en-us/azure/mysql/concepts-data-access-security-private-link)
+
+> [!IMPORTANT]
+> There is a `publicNetworkAccess` flag which is `Disabled` by default. This flag is meant to allow you to optionally allow both public and private endpoint access to the cache if it is set to `Enabled`. If set to `Disabled`, it will only allow private endpoint access. You can set the value to `Disabled` or `Enabled`.
+>
+## Recommended naming and tagging conventions
+
+Applying tags to your Azure resources, resource groups, and subscriptions to logically organize them into a taxonomy. Each tag consists of a name and a value pair. For example, you can apply the name `Environment` and the value `Production` to all the resources in production.
+For recommendations on how to implement a tagging strategy, see Resource naming and tagging decision guide.
+
+> [!IMPORTANT]
+> Tag names are case-insensitive for operations. A tag with a tag name, regardless of the casing, is updated or retrieved. However, the resource provider might keep the casing you provide for the tag name. You'll see that casing in cost reports. **Tag values are case-sensitive.**
+>
+
+An effective naming convention assembles resource names by using important resource information as parts of a resource's name. For example, using these [recommended naming conventions](https://docs.microsoft.com/en-us/azure/cloud-adoption-framework/ready/azure-best-practices/naming-and-tagging#example-names), a public IP resource for a production SharePoint workload is named like this: `pip-sharepoint-prod-westus-001`.
+
+## Requirements
+
+| Name | Version |
+|------|---------|
+| terraform | >= 0.13 |
+| azurerm | >= 2.59.0 |
+
+## Providers
+
+| Name | Version |
+|------|---------|
+| azurerm | >= 2.59.0 |
+| random |>= 3.1.0 |
+
+## Inputs
+
+| Name | Description | Type | Default |
+|--|--|--|--|
+`create_resource_group` | Whether to create resource group and use it for all networking resources | string | `"false"`
+`resource_group_name` | The name of the resource group in which resources are created | string | `""`
+`location` | The location of the resource group in which resources are created | string | `""`
+`log_analytics_workspace_name`|The name of log analytics workspace name|string|`null`
+`redis_instance_name`|The name of the Redis instance|string|`""`
+`redis_family`|The SKU family/pricing group to use. Valid values are `C` (for `Basic/Standard` SKU family) and `P` (for `Premium`)|map(any)|`{}`
+`redis_server_settings`|optional redis server setttings for both Premium and Standard/Basic SKU|map(object({}))|`{}`
+`patch_schedule`|The window for redis maintenance. The Patch Window lasts for 5 hours from the `start_hour_utc`|object({})|`null`
+`subnet_id`|The ID of the Subnet within which the Redis Cache should be deployed. Only available when using the Premium SKU|string|`null`
+`redis_configuration`|Memory and other optional configuration for the Redis instance|object({})|`{}`
+`storage_account_name`|The name of the storage account name|string|`null`
+`enable_data_persistence`|`Enable` or `disbale` Redis Database Backup. Only supported on Premium SKU's|string|`false`
+`data_persistence_backup_frequency`|The Backup Frequency in Minutes. Only supported on Premium SKU's. Possible values are: `15`, `30`, `60`, `360`, `720` and `1440`|number|`60`
+`data_persistence_backup_max_snapshot_count`|The maximum number of snapshots to create as a backup. Only supported for Premium SKU's|number|`1`
+`firewall_rules`|Range of IP addresses to allow firewall connections. 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.|map(object({}))|`null`
+`enable_private_endpoint`|Azure Private Endpoint is a network interface that connects you privately and securely to a service powered by Azure Private Link|string|`"false"`
+`virtual_network_name` | The name of the virtual network|string|`""`
+`private_subnet_address_prefix`|A list of subnets address prefixes inside virtual network| list |`[]`
+`existing_private_dns_zone`|Name of the existing private DNS zone|string|`null`
+`Tags` | A map of tags to add to all resources | map | `{}`
+
+# Outputs
+
+| Name | Description |
+|--|--|
+`redis_cache_instance_id`|The Route ID of Redis Cache Instance
+`redis_cache_hostname`|The Hostname of the Redis Instance
+`redis_cache_ssl_port`|The SSL Port of the Redis Instance
+`redis_cache_port`|The non-SSL Port of the Redis Instance
+`redis_cache_primary_access_key`|The Primary Access Key for the Redis Instance
+`redis_cache_secondary_access_key`|The Secondary Access Key for the Redis Instance
+`redis_cache_primary_connection_string`|The primary connection string of the Redis Instance
+`redis_cache_secondary_connection_string`|The secondary connection string of the Redis Instance
+`redis_configuration_maxclients`|Returns the max number of connected clients at the same time
+`redis_cache_private_endpoint`|id of the Redis Cache server Private Endpoint
+`redis_cache_private_dns_zone_domain`|DNS zone name of Redis Cache server Private endpoints dns name records
+`redis_cache_private_endpoint_ip`|Redis Cache server private endpoint IPv4 Addresses
+`redis_cache_private_endpoint_fqdn`|Redis Cache server private endpoint FQDN Addresses
+
+## Resource Graph
+
+![Resource Graph](graph.png)
+
+## Authors
+
+Originally created by [Kumaraswamy Vithanala](mailto:[email protected])
+
+## Other resources
+
+* [Azure Cache for Redis](https://docs.microsoft.com/en-us/azure/azure-cache-for-redis/)
+* [Terraform AzureRM Provider Documentation](https://www.terraform.io/docs/providers/azurerm/index.html)

examples/Azure_Cache_for_Redis_with_Private_Endpoint/README.md

@@ -66,7 +66,7 @@ module "redis" {
   # Creating Private Endpoint requires, VNet name and address prefix to create a subnet
   # By default this will create a `privatelink.mysql.database.azure.com` DNS zone. 
   # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name
-  # Private endpoints doesn't work If using `subnet_id` to create redis cache inside a specified virtual network
+  # Private endpoints doesn't work If using `subnet_id` to create redis inside a specified VNet.
   enable_private_endpoint       = true
   virtual_network_name          = "vnet-shared-hub-westeurope-001"
   private_subnet_address_prefix = ["10.1.5.0/29"]

examples/Azure_Cache_for_Redis_with_Private_Endpoint/main.tf

@@ -57,7 +57,7 @@ module "redis" {
   # Creating Private Endpoint requires, VNet name and address prefix to create a subnet
   # By default this will create a `privatelink.mysql.database.azure.com` DNS zone. 
   # To use existing private DNS zone specify `existing_private_dns_zone` with valid zone name
-  # Private endpoints doesn't work If using `subnet_id` to create redis cache inside a specified virtual network
+  # Private endpoints doesn't work If using `subnet_id` to create redis inside a specified VNet.
   enable_private_endpoint       = true
   virtual_network_name          = "vnet-shared-hub-westeurope-001"
   private_subnet_address_prefix = ["10.1.5.0/29"]

output.tf

@@ -59,12 +59,12 @@ output "redis_cache_private_dns_zone_domain" {
 }
 
 output "redis_cache_private_endpoint_ip" {
-  description = "Redis Cache server private endpoint IPv4 Addresses "
+  description = "Redis Cache server private endpoint IPv4 Addresses"
   value       = var.enable_private_endpoint ? element(concat(data.azurerm_private_endpoint_connection.private-ip1.*.private_service_connection.0.private_ip_address, [""]), 0) : null
 }
 
 output "redis_cache_private_endpoint_fqdn" {
-  description = "Redis Cache server private endpoint FQDN Addresses "
+  description = "Redis Cache server private endpoint FQDN Addresses"
   value       = var.enable_private_endpoint ? element(concat(azurerm_private_dns_a_record.arecord1.*.fqdn, [""]), 0) : null
 }
 

variables.tf

@@ -59,7 +59,7 @@ variable "patch_schedule" {
 }
 
 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 "
+  description = "The ID of the Subnet within which the Redis Cache should be deployed. Only available when using the Premium SKU"
   default     = null
 }
 
@@ -82,7 +82,7 @@ variable "storage_account_name" {
 }
 
 variable "enable_data_persistence" {
-  description = " Enable or disbale Redis Database Backup. Only supported on Premium SKU's"
+  description = "Enable or disbale Redis Database Backup. Only supported on Premium SKU's"
   default     = false
 }
 
@@ -106,7 +106,7 @@ variable "firewall_rules" {
 }
 
 variable "enable_private_endpoint" {
-  description = "Manages a Private Endpoint to Azure database for MySQL"
+  description = "Manages a Private Endpoint to Azure database for Redis"
   default     = false
 }