Skip to content

Commit eab159f

Browse files
authored
Merge pull request #252500 from shpathak-msft/flush-update-channels
Add docs update flush and update channel
2 parents 9a506d3 + fe5fb81 commit eab159f

11 files changed

+73
-45
lines changed

articles/azure-cache-for-redis/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -204,8 +204,8 @@
204204
href: cache-how-to-encryption.md
205205
- name: Reboot
206206
href: cache-administration.md#reboot
207-
- name: Schedule updates
208-
href: cache-administration.md#schedule-updates
207+
- name: Update channel and schedule updates
208+
href: cache-administration.md#update-channel-and-schedule-updates
209209
- name: Configure redis-cli.exe access
210210
href: cache-how-to-redis-cli-tool.md
211211
- name: Create and manage a cache using CLI

articles/azure-cache-for-redis/cache-administration.md

Lines changed: 26 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@ author: flang-msft
55

66
ms.service: cache
77
ms.topic: conceptual
8-
ms.date: 07/22/2021
8+
ms.date: 09/29/2023
99
ms.author: franlanglois
1010
---
1111
# How to administer Azure Cache for Redis
1212

13-
This article describes how to do administration tasks such as [rebooting](#reboot) and [scheduling updates](#schedule-updates) for your Azure Cache for Redis instances.
13+
This article describes how to do administration tasks such as [rebooting](#reboot) and [Update channel and Schedule updates](#update-channel-and-schedule-updates) for your Azure Cache for Redis instances.
1414

1515
[!INCLUDE [updated-for-az](../../includes/updated-for-az.md)]
1616

@@ -38,7 +38,7 @@ The effect on your client applications varies depending on which nodes you reboo
3838

3939
* **Primary** - When the primary node is rebooted, Azure Cache for Redis fails over to the replica node and promotes it to primary. During this failover, there may be a short interval in which connections may fail to the cache.
4040
* **Replica** - When the replica node is rebooted, there's typically no effect on the cache clients.
41-
* **Both primary and replica** - When both cache nodes are rebooted, Azure Cache for Redis will attempt to gracefully reboot both nodes, waiting for one to finish before rebooting the other. Typically, data loss does not occur. However, data loss can still occur do to unexpected maintenance events or failures. Rebooting your cache many times in a row increases the odds of data loss.
41+
* **Both primary and replica** - When both cache nodes are rebooted, Azure Cache for Redis attempts to gracefully reboot both nodes, waiting for one to finish before rebooting the other. Typically, data loss doesn't occur. However, data loss can still occur do to unexpected maintenance events or failures. Rebooting your cache many times in a row increases the odds of data loss.
4242
* **Nodes of a premium cache with clustering enabled** - When you reboot one or more nodes of a premium cache with clustering enabled, the behavior for the selected nodes is the same as when you reboot the corresponding node or nodes of a non-clustered cache.
4343

4444
## Reboot FAQ
@@ -76,15 +76,33 @@ Yes, for PowerShell instructions see [To reboot an Azure Cache for Redis](cache-
7676

7777
No. Reboot isn't available for the Enterprise tier yet. Reboot is available for Basic, Standard and Premium tiers.The settings that you see on the Resource menu under **Administration** depend on the tier of your cache. You don't see **Reboot** when using a cache from the Enterprise tier.
7878

79-
## Schedule updates
79+
## Flush data (preview)
8080

81-
On the left, **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. Azure Cache for Redis will make a best effort to start and finish updating Redis server software within the specified time window you define.
81+
When using the Basic, Standard, or Premium tiers of Azure Cache for Redis, you see **Flush data** on the resource menu. The **Flush data** operation allows you to delete or _flush_ all data in your cache. This _flush_ operation can be used before scaling operations to potentially reduce the time required to complete the scaling operation on your cache. You can also configure to run the _flush_ operation periodically on your dev/test caches to keep memory usage in check.
8282

83-
> [!NOTE]
84-
> The maintenance window applies to Redis server updates and updates to the Operating System of the VMs hosting the cache. The maintenance window does not apply to Host OS updates to the Hosts hosting the cache VMs or other Azure Networking components. In rare cases, where caches are hosted on older models (you can tell if your cache is on an older model if the DNS name of the cache resolves to a suffix of "cloudapp.net", "chinacloudapp.cn", "usgovcloudapi.net" or "cloudapi.de"), the maintenance window won't apply to Guest OS updates either.
83+
The _flush_ operation, when executed on a clustered cache, clears data from all shards at the same time.
84+
85+
> [!IMPORTANT]
86+
> Previously, the _flush_ operation was only available for geo-replicated Enterprise tier caches. Now, it is available in Basic, Standard and Premium tiers.
8587
>
86-
> Currently, no option is available to configure a reboot or scheduled updates for an Enterprise tier cache.
88+
:::image type="content" source="media/cache-administration/cache-flush.png" alt-text="Screenshot showing flush data selected in the resource menu of a cache instance. ":::
89+
90+
## Update channel and Schedule updates
91+
92+
On the left, **Schedule updates** allows you to choose an update channel and a maintenance window for your cache instance.
93+
94+
Any cache instance using the **Stable** update channel receives updates a few weeks later than cache instances using **Preview** update channel. We recommend choosing the **Preview** update channel for your non-production and less critical workloads. Choose the **Stable** update channel for your most critical, production workloads. All caches default to the **Stable** update channel by default.
95+
96+
> [!IMPORTANT]
97+
> Changing the update channel on your cache instance results in your cache undergoing a patching event to apply the right updates. Consider changing the update channel during your maintenance window.
98+
>
99+
100+
A maintenance window allows you to control the days and times of a week during which the VMs hosting your cache can be updated. Azure Cache for Redis makes a best effort to start and finish updating Redis server software within the specified time window you define.
101+
102+
> [!IMPORTANT]
103+
> The update channel and maintenance window applies to Redis server updates and updates to the Operating System of the VMs hosting the cache. The update channel and maintenance window does not apply to Host OS updates to the Hosts hosting the cache VMs or other Azure Networking components. In rare cases, where caches are hosted on older models the maintenance window won't apply to Guest OS updates either. You can tell if your cache is on an older model if the DNS name of the cache resolves to a suffix of `cloudapp.net`, `chinacloudapp.cn`, `usgovcloudapi.net` or `cloudapi.de`.
87104
>
105+
Currently, no option is available to configure an update channel or scheduled updates for an Enterprise tier cache.
88106

89107
:::image type="content" source="media/cache-administration/redis-schedule-updates-2.png" alt-text="Screenshot showing schedule updates":::
90108

articles/azure-cache-for-redis/cache-best-practices-connection.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: flang-msft
66

77
ms.service: cache
88
ms.topic: conceptual
9-
ms.date: 02/27/2023
9+
ms.date: 09/29/2023
1010
ms.author: franlanglois
1111
---
1212

@@ -22,7 +22,7 @@ Test your system's resiliency to connection breaks using a [reboot](cache-admini
2222

2323
## TCP settings for Linux-hosted client applications
2424

25-
The default TCP settings in some Linux versions can cause Redis server connections to fail for 13 minutes or more. The default settings can prevent the client application from detecting closed connections and restoring them automatically if the connection wasn't closed gracefully.
25+
The default TCP settings in some Linux versions can cause Redis server connections to fail for 13 minutes or more. The default settings can prevent the client application from detecting closed connections and restoring them automatically if the connection wasn't closed gracefully.
2626

2727
The failure to reestablish a connection can happen in situations where the network connection is disrupted or the Redis server goes offline for unplanned maintenance.
2828

@@ -77,19 +77,19 @@ Use notifications to learn of upcoming maintenance. For more information, see [C
7777

7878
## Schedule maintenance window
7979

80-
Adjust your cache settings to accommodate maintenance. For more information about creating a maintenance window to reduce any negative effects to your cache, see [Schedule updates](cache-administration.md#schedule-updates).
80+
Adjust your cache settings to accommodate maintenance. For more information about creating a maintenance window to reduce any negative effects to your cache, see [Update channel and Schedule updates](cache-administration.md#update-channel-and-schedule-updates).
8181

8282
## More design patterns for resilience
8383

8484
Apply design patterns for resiliency. For more information, see [How do I make my application resilient](cache-failover.md#how-do-i-make-my-application-resilient).
8585

8686
## Idle timeout
8787

88-
Azure Cache for Redis has a 10-minute timeout for idle connections. The 10-minute timeout allows the server to automatically clean up leaky connections or connections orphaned by a client application. Most Redis client libraries have a built-in capability to send `heartbeat` or `keepalive` commands periodically to prevent connections from being closed even if there are no requests from the client application.
88+
Azure Cache for Redis has a 10-minute timeout for idle connections. The 10-minute timeout allows the server to automatically clean up leaky connections or connections orphaned by a client application. Most Redis client libraries have a built-in capability to send `heartbeat` or `keepalive` commands periodically to prevent connections from being closed even if there are no requests from the client application.
8989

9090
If there's any risk of your connections being idle for 10 minutes, configure the `keepalive` interval to a value less than 10 minutes. If your application is using a client library that doesn't have native support for `keepalive` functionality, you can implement it in your application by periodically sending a `PING` command.
9191

92-
## Next steps
92+
## Related content
9393

9494
- [Best practices for development](cache-best-practices-development.md)
9595
- [Azure Cache for Redis development FAQ](cache-development-faq.yml)

articles/azure-cache-for-redis/cache-best-practices-scale.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ For more information on scaling and memory, depending on your tier see either:
4545
4646
## Minimizing your data helps scaling complete quicker
4747

48-
If preserving the data in the cache isn't a requirement, consider flushing the data prior to scaling. Flushing the cache helps the scaling operation complete more quickly so the new capacity is available sooner.
48+
If preserving the data in the cache isn't a requirement, consider flushing the data prior to scaling. Flushing the cache helps the scaling operation complete more quickly so the new capacity is available sooner. See more details on [how to initiate flush operation.](cache-administration.md#flush-data-preview)
4949

5050
## Scaling Enterprise tier caches
5151

articles/azure-cache-for-redis/cache-configure.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: flang-msft
55

66
ms.service: cache
77
ms.topic: conceptual
8-
ms.date: 11/21/2022
8+
ms.date: 09/29/2023
99
ms.author: franlanglois
1010
ms.custom: engagement-fy23
1111
---
@@ -185,7 +185,7 @@ Use the **Maxmemory policy**, **maxmemory-reserved**, and **maxfragmentationmemo
185185

186186
**Maxmemory policy** configures the eviction policy for the cache and allows you to choose from the following eviction policies:
187187

188-
- `volatile-lru`: The default eviction policy, removes the least recently used key out of all the keys with an expiration set.
188+
- `volatile-lru`: The default eviction policy. It removes the least recently used key out of all the keys with an expiration set.
189189
- `allkeys-lru`: Removes the least recently used key.
190190
- `volatile-random`: Removes a random key that has an expiration set.
191191
- `allkeys-random`: Removes a random key.
@@ -264,7 +264,7 @@ The **Schedule updates** section on the left allows you to choose a maintenance
264264

265265
To specify a maintenance window, check the days you want. Then, specify the maintenance window start hour for each day, and select **OK**. The maintenance window time is in UTC.
266266

267-
For more information and instructions, see [Azure Cache for Redis administration - Schedule updates](cache-administration.md#schedule-updates)
267+
For more information and instructions, see [Update channel and Schedule updates](cache-administration.md#update-channel-and-schedule-updates).
268268

269269
### Geo-replication
270270

@@ -478,7 +478,7 @@ New Azure Cache for Redis instances are configured with the following default Re
478478
| `lua-event-limit` |500 |Max size of script event queue. |
479479
| `client-output-buffer-limit normal` / `client-output-buffer-limit pubsub` |`0 0 0` / `32mb 8mb 60` |The client output buffer limits can be used to force disconnection of clients that aren't reading data from the server fast enough for some reason. A common reason is that a Pub/Sub client can't consume messages as fast as the publisher can produce them. For more information, see [https://redis.io/topics/clients](https://redis.io/topics/clients). |
480480

481-
<a name="databases"></a>
481+
### Databases
482482

483483
<sup>1</sup>The limit for `databases` is different for each Azure Cache for Redis pricing tier and can be set at cache creation. If no `databases` setting is specified during cache creation, the default is 16.
484484

@@ -504,9 +504,9 @@ For more information about databases, see [What are Redis databases?](cache-deve
504504
> The `databases` setting can be configured only during cache creation and only using PowerShell, CLI, or other management clients. For an example of configuring `databases` during cache creation using PowerShell, see [New-AzRedisCache](cache-how-to-manage-redis-cache-powershell.md#databases).
505505
>
506506
507-
<a name="maxclients"></a>
507+
### Maxclients
508508

509-
<sup>2</sup>`maxclients` is different for each Azure Cache for Redis pricing tier.
509+
<sup>2</sup>The `maxclients` property is different for each Azure Cache for Redis pricing tier.
510510

511511
- Basic and Standard caches
512512
- C0 (250 MB) cache - up to 256 connections
@@ -556,8 +556,7 @@ For cache instances using active geo-replication, the following commands are als
556556
557557
For more information about Redis commands, see [https://redis.io/commands](https://redis.io/commands).
558558

559-
## Next steps
559+
## Related content
560560

561561
- [How can I run Redis commands?](cache-development-faq.yml#how-can-i-run-redis-commands-)
562562
- [Monitor Azure Cache for Redis](cache-how-to-monitor.md)
563-

articles/azure-cache-for-redis/cache-failover.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ author: flang-msft
66
ms.author: franlanglois
77
ms.service: cache
88
ms.topic: conceptual
9-
ms.date: 11/16/2022
9+
ms.date: 09/29/2023
1010
ms.custom: engagement-fy23
1111

1212
---
@@ -114,12 +114,12 @@ Refer to these design patterns to build resilient clients, especially the circui
114114

115115
To test a client application's resiliency, use a [reboot](cache-administration.md#reboot) as a manual trigger for connection breaks.
116116

117-
Additionally, we recommend that you [schedule updates](cache-administration.md#schedule-updates) on a cache to apply Redis runtime patches during specific weekly windows. These windows are typically periods when client application traffic is low, to avoid potential incidents.
117+
Additionally, we recommend that you [Update channel and Schedule updates](cache-administration.md#update-channel-and-schedule-updates) on a cache to apply Redis runtime patches during specific weekly windows. These windows are typically periods when client application traffic is low, to avoid potential incidents.
118118

119119
For more information, see [Connection resilience](cache-best-practices-connection.md).
120120

121-
## Next steps
121+
## Related content
122122

123-
- [Schedule updates](cache-administration.md#schedule-updates) for your cache.
124-
- Test application resiliency by using a [reboot](cache-administration.md#reboot).
125-
- [Configure](cache-configure.md#memory-policies) memory reservations and policies.
123+
- [Update channel and Schedule updates](cache-administration.md#update-channel-and-schedule-updates)
124+
- Test application resiliency by using a [reboot](cache-administration.md#reboot)
125+
- [Configure](cache-configure.md#memory-policies) memory reservations and policies

0 commit comments

Comments
 (0)