Skip to content

Commit ae27741

Browse files
authored
Merge pull request #93074 from ronhogue/ronh1023
add manage cache article
2 parents 64551c8 + 6a7507c commit ae27741

File tree

6 files changed

+80
-2
lines changed

6 files changed

+80
-2
lines changed
Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
---
2+
title: Manage and update Azure HPC Cache (Preview)
3+
description: How to manage and update Azure HPC Cache using the Azure portal
4+
author: ekpgh
5+
ms.service: hpc-cache
6+
ms.topic: conceptual
7+
ms.date: 10/25/2019
8+
ms.author: rohogue
9+
---
10+
11+
# Manage your cache from the Azure portal
12+
13+
The cache overview page in the Azure portal shows project details, cache status, and basic statistics for your cache. It also has controls to delete the cache, flush data to long-term storage, or update software.
14+
15+
To open the overview page, select your cache resource in the Azure portal. For example, load the **All resources** page and click the cache name.
16+
17+
![screenshot of an Azure HPC Cache instance's Overview page](media/hpc-cache-overview.png) <!-- placeholder is identical to hpc-cache-new-overview.png; replace with better image (showing graphs, full sidebar) when available -->
18+
19+
The buttons at the top of the page can help you manage the cache:
20+
21+
* [**Flush**](#flush-cached-data) - Writes all cached data to storage targets
22+
* [**Upgrade**](#upgrade-cache-software) - Updates the cache software
23+
* **Refresh** - Reloads the overview page
24+
* [**Delete**](#delete-the-cache) - Permanently destroys the cache
25+
26+
Read more about these options below.
27+
28+
## Flush cached data
29+
30+
The **Flush** button on the overview page tells the cache to immediately write all changed data that is stored in the cache to the back-end storage targets. The cache routinely saves data to the storage targets, so it's not necessary to do this manually unless you want to make sure the back-end storage system is up to date. For example, you might use **Flush** before taking a storage snapshot or checking the data set size.
31+
32+
> [!NOTE]
33+
> During the flush process, the cache can't serve client requests. Cache access is suspended and resumes after the operation finishes.
34+
35+
When you start the cache flush operation, the cache stops accepting client requests, and the cache status on the overview page changes to **Flushing**.
36+
37+
Data in the cache is saved to the appropriate storage targets. The process can take a few minutes or it can take an hour or more, depending on how much data has been written to the cache recently.
38+
39+
After all the data is saved to storage targets, the cache automatically starts taking client requests again. The cache status returns to **Healthy**.
40+
41+
## Upgrade cache software
42+
43+
If a new software version is available, the **Upgrade** button becomes active. You also might see a message at the top of the page about updating software.
44+
45+
![screenshot of the top row of buttons with the Upgrade button enabled](media/hpc-cache-upgrade-button.png)
46+
47+
Client access is not interrupted during a software upgrade, but cache performance slows. Plan to upgrade software during non-peak usage hours or in a planned maintenance period.
48+
49+
The software update can take several hours. Caches configured with higher throughput take longer to upgrade than caches with smaller peak throughput values.
50+
51+
When a software upgrade is available, you have several days to apply it manually. The end date is listed in the upgrade message. If you don't upgrade during that time, Azure automatically applies the update to your cache. The timing of the automatic upgrade is not configurable. If you are concerned about impacting cache performance, you should upgrade the software yourself before the time period expires.
52+
53+
Click the **Upgrade** button to begin the software update. The cache status changes to **Upgrading** until the operation completes.
54+
55+
## Delete the cache
56+
57+
The **Delete** button destroys the cache. When you delete a cache, all of its resources are destroyed and no longer incur account charges.
58+
59+
Storage targets are unaffected when you delete the cache. You can add them to a future cache later, or decommission them separately.
60+
61+
The cache automatically flushes any unsaved data to storage targets as part of its final shutdown.
62+
63+
## Cache metrics and monitoring
64+
65+
The overview page shows graphs for some basic cache statistics - cache throughput, operations per second, and latency.
66+
67+
![screenshot of three line graphs showing the statistics mentioned above for a sample cache](media/hpc-cache-overview-stats.png)
68+
69+
These charts are part of Azure's built-in monitoring and analytics tools. Additional tools and alerts are available from the pages under the **Monitoring** heading in the portal sidebar. Learn more in the portal section of the [Azure Monitoring documentation](../azure-monitor/insights/monitor-azure-resource.md#monitoring-in-the-azure-portal).
70+
71+
## Next steps
72+
73+
<!-- * Learn more about metrics and statistics for hpc cache -->
74+
* Learn more about [Azure metrics and statistics tools](../azure-monitor/index.yml)
75+
* Get [help with your Azure HPC Cache](hpc-cache-support-ticket.md)

articles/hpc-cache/index.yml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ metadata:
1111
ms.collection: collection
1212
author: ekpgh
1313
ms.author: rohogue
14-
ms.date: 09/24/2019
14+
ms.date: 10/21/2019
1515

1616
# linkListType: architecture | concept | deploy | download | get-started | how-to-guide | learn | overview | quickstart | reference | tutorial | video | whats-new
1717

@@ -39,6 +39,8 @@ landingContent:
3939
url: hpc-cache-add-storage.md
4040
- text: Mount clients
4141
url: hpc-cache-mount.md
42+
- text: Manage and monitor the cache
43+
url: hpc-cache-manage.md
4244
- linkListType: concept
4345
links:
4446
- text: Plan the aggregated namespace
165 KB
Loading
285 KB
Loading
9.37 KB
Loading

articles/hpc-cache/toc.yml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,10 @@
3333
href: hpc-cache-ingest-msrsync.md
3434
- name: Populate the cache by manual file copy
3535
href: hpc-cache-ingest-manual.md
36-
3736
- name: Connect to the cache
3837
href: hpc-cache-mount.md
38+
- name: Manage the cache
39+
href: hpc-cache-manage.md
3940

4041
- name: Resources
4142
items:

0 commit comments

Comments
 (0)