Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit b8c9834

Browse files
committedMay 28, 2022
add upgrade schedule and priming changes
1 parent 19ee1b9 commit b8c9834

File tree

6 files changed

+46
-16
lines changed

6 files changed

+46
-16
lines changed
 

‎articles/hpc-cache/hpc-cache-manage.md

Lines changed: 28 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
---
22
title: Manage and update Azure HPC Cache
33
description: How to manage and update Azure HPC Cache using the Azure portal or Azure CLI
4-
author: ronhogue
4+
author: ekpgh
55
ms.service: hpc-cache
66
ms.topic: how-to
7-
ms.date: 01/19/2022
8-
ms.author: rohogue
7+
ms.date: 05/27/2022
8+
ms.author: v-erinkelly
99
---
1010

1111
# Manage your cache
@@ -147,15 +147,37 @@ If a new software version is available, the **Upgrade** button becomes active. Y
147147

148148
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.
149149

150-
The software update can take several hours. Caches configured with higher throughput take longer to upgrade than caches with smaller peak throughput values.
150+
The software update can take several hours. Caches configured with higher throughput take longer to upgrade than caches with smaller peak throughput values. The cache status changes to **Upgrading** until the operation completes.
151151

152-
When a software upgrade is available, you will have a week or so 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 the cache performance impact, you should upgrade the software yourself before the time period expires.
152+
When a software upgrade is available, you will have a week or so 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.
153+
154+
You can use the Azure Portal to schedule a more convenient time for the update. Follow the instructions in the **Portal** tab below.
153155

154156
If your cache is stopped when the end date passes, the cache will automatically upgrade software the next time it is started. (The update might not start immediately, but it will start in the first hour.)
155157

156158
### [Portal](#tab/azure-portal)
157159

158-
Click the **Upgrade** button to begin the software update. The cache status changes to **Upgrading** until the operation completes.
160+
Click the **Upgrade** button to configure your software update. You have the option to update the software immediately, or to schedule the update for a specific date and time.
161+
162+
![Screenshot of the Schedule software upgrade blade showing radio buttons with "Schedule later" selected and fields to select a new date and time.](media/upgrade-schedule.png)
163+
164+
To upgrade immediately, select **Upgrade now** and click the **Save** button.
165+
166+
To schedule a different update time, select **Schedule later** and select a new date and time.
167+
168+
* The date and time are shown in the browser's local time zone.
169+
* You can't choose a later time than the deadline in the original message.
170+
171+
When you save the custom date, the update message will change to show the date you chose.
172+
173+
If you want to revise your scheduled upgrade date, click the **Update** button again. Click the **Reset date** link. This immediately removes your scheduled date.
174+
175+
> [!NOTE]
176+
> You must choose a new date before you exit the **Schedule software upgrade** blade. The calendar selector might reset to a date and time one hour from the current time; be careful to choose the date and time you prefer.
177+
178+
![Screenshot of the Schedule software upgrade blade with a custom date selected. A text link appears at the left of the date labeled "Reset date".](media/upgrade-reset-date.png)
179+
180+
You can't change the schedule if there are fewer than 15 minutes remaining before the upgrade.
159181

160182
### [Azure CLI](#tab/azure-cli)
161183

‎articles/hpc-cache/manage-storage-targets.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,7 @@ The **State** value affects which management options you can use. Here's a short
159159

160160
## Allocate cache storage
161161

162-
xxx to come xxx
162+
<!-- xxx to come xxx -->
163163

164164
![Screenshot of the storage targets page in the Azure portal.](media/storage-target-allocation.png)
165165

Loading
90.8 KB
Loading
183 KB
Loading

‎articles/hpc-cache/prime-cache.md

Lines changed: 17 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: Use the cache priming feature to populate or preload cache contents
44
author: ekpgh
55
ms.service: hpc-cache
66
ms.topic: how-to
7-
ms.date: 05/26/2022
7+
ms.date: 05/27/2022
88
ms.author: v-erinkelly
99
---
1010

@@ -211,19 +211,19 @@ To delete a priming job, select it in the list and use the delete control at the
211211

212212
## Azure REST APIs
213213

214-
You can use these REST API endpoints to create an HPC Cache priming job. These are part of the `2021-10-01-preview` version of the REST API, so make sure you use that string in the *api_version* term.
214+
You can use these REST API endpoints to create and manage HPC Cache priming jobs. These are part of the `2022-05-01` version of the REST API, so make sure you use that string in the *api_version* term.
215215

216-
***xxx update api version throughout xxx***
216+
Read the [Azure REST API reference](/rest/api/azure/) to learn how to use these tools.
217217

218-
Read the [Azure REST API reference](/rest/api/azure/) to learn how to use this interface.
218+
### Add a new priming job
219219

220-
### Add a priming job
220+
The `startPrimingJob` interface creates and queues a priming job. The job starts automatically when resources are available.
221221

222222
```rest
223223
224224
URL: POST
225225
226-
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME/addPrimingJob?api-version=2021-10-01-preview
226+
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME/startPrimingJob?api-version=2022-05-01
227227
228228
BODY:
229229
{
@@ -235,14 +235,20 @@ URL: POST
235235

236236
For the `primingManifestUrl` value, pass the file’s SAS URL or other HTTPS URL that is accessible to the cache. Read [Upload the priming manifest file](#upload-the-priming-manifest-file) to learn more.
237237

238-
### Remove a priming job
238+
### Stop a priming job
239+
240+
The `stopPrimingJob` interface cancels a job (if it is running) and removes it from the job list.
239241

240242
```rest
241243
242244
URL: POST
243-
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME/removePrimingJob/MY-JOB-ID-TO-REMOVE?api-version=2021-10-01-preview
245+
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME/stopPrimingJob?api-version=2022-05-01
244246
245247
BODY:
248+
{
249+
"primingJobId": "MY-JOB-ID-TO-REMOVE"
250+
}
251+
246252
```
247253

248254
### Get priming jobs
@@ -254,12 +260,14 @@ Priming job names and IDs are returned, along with other information.
254260
```rest
255261
256262
URL: GET
257-
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME?api-version=2021-10-01-preview
263+
https://MY-ARM-HOST/subscriptions/MY-SUBSCRIPTION-ID/resourceGroups/MY-RESOURCE-GROUP-NAME/providers/Microsoft.StorageCache/caches/MY-CACHE-NAME?api-version=2022-05-01
258264
259265
BODY:
260266
261267
```
262268

269+
***[ ?? should we add pause/resume APIs here too? ??]***
270+
263271
## Frequently asked questions
264272

265273
* Can I reuse a priming job?

0 commit comments

Comments
 (0)
Please sign in to comment.