Skip to content

Commit c62a8c9

Browse files
authored
Merge pull request #2 from kumarvna/develop
documentation for version 1.0
2 parents b50d374 + d388f08 commit c62a8c9

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

README.md

+15-15
Original file line numberDiff line numberDiff line change
@@ -126,21 +126,9 @@ This object to help set up the advance memory and other settings for Azure Cache
126126
`maxmemory_policy`|configures the eviction policy for the cache and allows you to choose from the following eviction policies: `volatile-lru`, `allkeys-lru`, `volatile-random`, `allkeys-random`, `volatile-ttl`, `noeviction`. For more information about maxmemory policies, see [Eviction policies](https://redis.io/topics/lru-cache#eviction-policies)
127127
`notify_keyspace_events`|Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. [Reference](https://redis.io/topics/notifications#configuration)
128128

129-
## Data Persistence
130-
131-
RDB persistence - When you use RDB persistence, Azure Cache for Redis persists a snapshot of the Azure Cache for Redis in a Redis to disk in binary format. The snapshot is saved in an Azure Storage account. The configurable backup frequency determines how often to persist the snapshot.
132-
133-
By default, RDB backup feature not enabled on this module. To enable RDB backup, set the variable `enable_data_persistence` to `true` also provide a valid values to `rdb_backup_frequency` and `rdb_backup_max_snapshot_count`. The Backup Frequency in Minutes. Possible values are: `15`, `30`, `60`, `360`, `720` and `1440`. Default to `60` mintues. Only available when using the Premium SKU.
134-
135-
## Patching Schedule - Scheduling updates
136-
137-
Schedule updates allows you to choose a maintenance window for your cache instance. A maintenance window allows you to control the day(s) and time(s) of a week during which the VM(s) hosting your cache can be updated.
138-
139-
By default, Scheduling the updates are not enabled. To specify the maintenance window, set `patch_schedule` with `day_of_week` and `start_hour_utc` values. The default, and minimum, maintenance window for updates is 5 hours.
140-
141129
## Azure Cache for Redis network isolation options
142130

143-
### Private Link for Azure Cache for Redis
131+
### 1. Private Link for Azure Cache for Redis
144132

145133
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.
146134

@@ -159,22 +147,34 @@ For more details: [Azure Cache for Redis with Azure Private Link](https://docs.m
159147
* Currently, portal console support, and persistence to firewall storage accounts are not supported.
160148
* To connect to a clustered cache, publicNetworkAccess needs to be set to Disabled and there can only be one private endpoint connection.
161149

162-
### Azure Virtual Network injection
150+
### 2. Azure Virtual Network injection
163151

164152
Azure Virtual Network deployment provides enhanced security and isolation along with: subnets, access control policies, and other features to restrict access further. When an Azure Cache for Redis instance is configured with a virtual network, it isn't publicly addressable. Instead, the instance can only be accessed from virtual machines and applications within the virtual network.
165153

166154
By default this feature not enabled on this module. To enable VNet, set the variable `subnet_id` to a valid subnet resource ID.
167155

168156
VNet injected caches are only available for Premium Azure Cache for Redis. When using a VNet injected cache, you must change your VNet to cache dependencies such as CRLs/PKI, AKV, Azure Storage, Azure Monitor, and more.
169157

170-
### Azure Firewall rules
158+
### 3. Azure Firewall rules
171159

172160
When firewall rules are configured, only client connections from the specified IP address ranges can connect to the cache. Connections from Azure Cache for Redis monitoring systems are always permitted, even if firewall rules are configured. NSG rules that you define are also permitted.
173161

174162
By default this feature not enabled on this module. To enable Firewall rules, provide a list of `firewall_rules` wiht a valid `start_ip` and `end_ip` blocks.
175163

176164
>Firewall rules can be used with VNet injected caches, but not private endpoints currently.
177165
166+
## Data Persistence
167+
168+
RDB persistence - When you use RDB persistence, Azure Cache for Redis persists a snapshot of the Azure Cache for Redis in a Redis to disk in binary format. The snapshot is saved in an Azure Storage account. The configurable backup frequency determines how often to persist the snapshot.
169+
170+
By default, RDB backup feature not enabled on this module. To enable RDB backup, set the variable `enable_data_persistence` to `true` also provide a valid values to `rdb_backup_frequency` and `rdb_backup_max_snapshot_count`. The Backup Frequency in Minutes. Possible values are: `15`, `30`, `60`, `360`, `720` and `1440`. Default to `60` mintues. Only available when using the Premium SKU.
171+
172+
## Patching Schedule - Scheduling updates
173+
174+
Schedule updates allows you to choose a maintenance window for your cache instance. A maintenance window allows you to control the day(s) and time(s) of a week during which the VM(s) hosting your cache can be updated.
175+
176+
By default, Scheduling the updates are not enabled. To specify the maintenance window, set `patch_schedule` with `day_of_week` and `start_hour_utc` values. The default, and minimum, maintenance window for updates is 5 hours.
177+
178178
## Recommended naming and tagging conventions
179179

180180
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.

0 commit comments

Comments
 (0)