Skip to content

Commit 73bd009

Browse files
committedJun 24, 2021
add storage target manage actions article
1 parent c0f7ba1 commit 73bd009

File tree

6 files changed

+120
-70
lines changed

6 files changed

+120
-70
lines changed
 

‎articles/hpc-cache/cache-usage-models.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ ms.topic: how-to
77
ms.date: 06/17/2021
88
ms.author: v-erkel
99
---
10+
<!-- filename is referenced from GUI in aka.ms/hpc-cache-usagemodel -->
1011

1112
# Understand cache usage models
1213

‎articles/hpc-cache/hpc-cache-add-storage.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ description: How to define storage targets so that your Azure HPC Cache can use
44
author: ekpgh
55
ms.service: hpc-cache
66
ms.topic: how-to
7-
ms.date: 06/23/2021
7+
ms.date: 06/24/2021
88
ms.custom: subject-rbac-steps
99
ms.author: v-erkel
1010
---
@@ -91,7 +91,7 @@ Azure HPC Cache uses [Azure role-based access control (Azure RBAC)](../role-base
9191

9292
The storage account owner must explicitly add the roles [Storage Account Contributor](../role-based-access-control/built-in-roles.md#storage-account-contributor) and [Storage Blob Data Contributor](../role-based-access-control/built-in-roles.md#storage-blob-data-contributor) for the user "HPC Cache Resource Provider".
9393

94-
You can do this ahead of time, or by clicking a link on the page where you add a Blob storage target. Keep in mind that it can take up to five minutes for the role settings to propagate through the Azure environment, so you should wait a few minutes after adding the roles before creating a storage target.
94+
You can do this ahead of time, or by clicking a link on the portal page where you add a Blob storage target. Keep in mind that it can take up to five minutes for the role settings to propagate through the Azure environment, so you should wait a few minutes after adding the roles before creating a storage target.
9595

9696
1. Open **Access control (IAM)** for your storage account.
9797

@@ -107,7 +107,7 @@ You can do this ahead of time, or by clicking a link on the page where you add a
107107
![Add role assignment page](../../includes/role-based-access-control/media/add-role-assignment-page.png)
108108

109109
> [!NOTE]
110-
> If you can't find the HPC Cache Resource Provider, try a search for the string "storagecache" instead. Users who participated in HPC Cache previews (before GA) might need to use the older name for the service principal.
110+
> If you can't find the HPC Cache Resource Provider, try a search for the string "storagecache" instead. This was a pre-GA name for the service principal.
111111
112112
<!--
113113
Steps to add the Azure roles:
@@ -184,25 +184,23 @@ az hpc-cache blob-storage-target add --resource-group "hpc-cache-group" \
184184

185185
## Add a new NFS storage target
186186

187-
An NFS storage target has different settings from a Blob storage target. The usage model setting helps the cache to efficiently cache data from this storage system.
187+
An NFS storage target has different settings from a Blob storage target, including a usage model setting, which tells the cache how to store data from this storage system.
188188

189189
![Screenshot of add storage target page with NFS target defined](media/add-nfs-target.png)
190190

191191
> [!NOTE]
192192
> Before you create an NFS storage target, make sure your storage system is accessible from the Azure HPC Cache and meets permission requirements. Storage target creation will fail if the cache can't access the storage system. Read [NFS storage requirements](hpc-cache-prerequisites.md#nfs-storage-requirements) and [Troubleshoot NAS configuration and NFS storage target issues](troubleshoot-nas.md) for details.
193193
194194
### Choose a usage model
195-
<!-- referenced from GUI by aka.ms link -->
196195

197196
When you create a storage target that uses NFS to reach its storage system, you need to choose a usage model for that target. This model determines how your data is cached.
198197

199198
Read [Understand usage models](cache-usage-models.md) for more details about all of these settings.
200199

201200
The built-in usage models let you choose how to balance fast response with the risk of getting stale data. If you want to optimize speed for reading files, you might not care whether the files in the cache are checked against the back-end files. On the other hand, if you want to make sure your files are always up to date with the remote storage, choose a model that checks frequently.
202201

203-
<!-- asc12 add restriction on L series: -->
204202
> [!NOTE]
205-
> L Series storage caches support read caching only so you can't choose those write models (write this better)
203+
> [High-throughput style caches](hpc-cache-create.md#choose-the-cache-type-for-your-needs) support read caching only.
206204
207205
These three options cover most situations:
208206

@@ -251,7 +249,7 @@ Provide this information for an NFS-backed storage target:
251249

252250
* **Target type** - Choose **NFS**.
253251

254-
* **Hostname** - Enter the IP address or fully qualified domain name for your NFS storage system. (Use a domain name only if your cache has access to a DNS server that can resolve the name.)
252+
* **Hostname** - Enter the IP address or fully qualified domain name for your NFS storage system. (Use a domain name only if your cache has access to a DNS server that can resolve the name.) You can enter multiple IP addresses if your storage system is referenced by multiple IPs.
255253

256254
* **Usage model** - Choose one of the data caching profiles based on your workflow, described in [Choose a usage model](#choose-a-usage-model) above.
257255

@@ -342,7 +340,9 @@ ADLS-NFS storage targets have some similarities with Blob storage targets and so
342340

343341
* Like a Blob storage target, you need to give Azure HPC Cache permission to [access your storage account](#add-the-access-control-roles-to-your-account).
344342
* Like an NFS storage target, you need to set a cache [usage model](#choose-a-usage-model).
345-
* Because NFS-enabled blob containers have an NFS-compatible hierarchical structure, you do not need to use the cache to ingest data, and the containers are readable by other NFS systems. You can pre-load data in an ADLS-NFS container, then add it to an HPC Cache as a storage target, and then access the data later from outside of an HPC Cache. When you use a standard blob container as an HPC Cache storage target, the data is written in a proprietary format and can only be accessed from other Azure HPC Cache-compatible products.
343+
* Because NFS-enabled blob containers have an NFS-compatible hierarchical structure, you do not need to use the cache to ingest data, and the containers are readable by other NFS systems.
344+
345+
You can pre-load data in an ADLS-NFS container, then add it to an HPC Cache as a storage target, and then access the data later from outside of an HPC Cache. When you use a standard blob container as an HPC Cache storage target, the data is written in a proprietary format and can only be accessed from other Azure HPC Cache-compatible products.
346346

347347
Before you can create an ADLS-NFS storage target, you must create an NFS-enabled storage account. Follow the tips in [Prerequisites for Azure HPC Cache](hpc-cache-prerequisites.md#nfs-mounted-blob-adls-nfs-storage-requirements-preview) and the instructions in [Mount Blob storage by using NFS](../storage/blobs/network-file-system-protocol-support-how-to.md). After your storage account is set up you can create a new container when you create the storage target.
348348

‎articles/hpc-cache/hpc-cache-edit-storage.md

Lines changed: 6 additions & 61 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@ description: How to edit Azure HPC Cache storage targets
44
author: ekpgh
55
ms.service: hpc-cache
66
ms.topic: how-to
7-
ms.date: 03/29/2021
7+
ms.date: 06/24/2021
88
ms.author: v-erkel
99
---
1010

1111
# Edit storage targets
1212

13-
You can modify, manage, or remove storage targets with the Azure portal or by using the Azure CLI.
13+
You can modify storage targets with the Azure portal or by using the Azure CLI. For example, you can change access policies, usage models, and namespace paths for an existing storage target.
1414

15-
The xxx
15+
Storage target *management* tasks, like suspending or deleting a storage target, are described in [Manage storage targets](manage-storage-targets.md).
1616

1717
Depending on the type of storage, you can modify these storage target values:
1818

@@ -27,40 +27,11 @@ Depending on the type of storage, you can modify these storage target values:
2727

2828
* For ADLS-NFS storage targets, you can change the namespace path, access policy, and the usage model.
2929

30-
You can't edit a storage target's name, type, or back-end storage system (Blob container or NFS hostname/IP address). If you need to change these properties, delete the storage target and create a replacement with the new value.
30+
You can't edit a storage target's name, type, or back-end storage system. If you need to change these properties, delete the storage target and create a replacement with the new value.
3131

3232
> [!TIP]
3333
> The [Managing Azure HPC Cache video](https://azure.microsoft.com/resources/videos/managing-hpc-cache/) shows how to edit a storage target in the Azure portal.
3434
35-
## Remove a storage target
36-
37-
### [Portal](#tab/azure-portal)
38-
39-
To remove a storage target, open the **Storage targets** page. Click the '...' next to the storage target and choose **Delete** from the menu. The other options on this menu are explained in [Manage storage targets](#manage-storage-targets).
40-
41-
### [Azure CLI](#tab/azure-cli)
42-
43-
[Set up Azure CLI for Azure HPC Cache](./az-cli-prerequisites.md).
44-
45-
Use [az hpc-cache storage-target remove](/cli/azure/hpc-cache/storage-target#az_hpc_cache_storage_target_remove) to delete a storage target from the cache.
46-
47-
```azurecli
48-
$ az hpc-cache storage-target remove --resource-group cache-rg --cache-name doc-cache0629 --name blob1
49-
50-
{- Finished ..
51-
"endTime": "2020-07-09T21:45:06.1631571+00:00",
52-
"name": "2f95eac1-aded-4860-b19c-3f089531a7ec",
53-
"startTime": "2020-07-09T21:43:38.5461495+00:00",
54-
"status": "Succeeded"
55-
}
56-
```
57-
58-
---
59-
60-
Deleting a storage target removes the storage system's association with this Azure HPC Cache system, but it does not change the back-end storage system. For example, if you used an Azure Blob storage container, the container and its contents still exist after you delete it from the cache. You can add the container to a different Azure HPC Cache, re-add it to this cache, or delete it with the Azure portal.
61-
62-
Any file changes stored in the cache are written to the back-end storage system before the storage target is removed. This process can take an hour or more if a lot of changed data is in the cache.
63-
6435
## Change a blob storage target's namespace path
6536

6637
Namespace paths are the paths that clients use to mount this storage target. (To learn more, read [Plan the aggregated namespace](hpc-cache-namespace.md) and [Set up the aggregated namespace](add-namespace-paths.md)).
@@ -211,34 +182,8 @@ Use the **Namespace** page for your Azure HPC Cache to update namespace values.
211182

212183
The configuration for ADLS-NFS usage models is identical to the NFS usage model selection. Read the portal instructions in [Change the usage model](#change-the-usage-model) in the NFS section above. Additional tools for updating ADLS-NFS storage targets are in development.
213184

214-
215-
## Manage storage targets
216-
217-
You can also perform management actions on individual storage targets. These actions supplement the cache-level management options discussed in [Manage your cache](hpc-cache-manage.md).
218-
219-
Sometimes an individual storage target can get into a bad state and need to be temporarily removed, or permanently deleted. You also can flush cached data for a specific target.
220-
221-
![Screenshot of the storage targets page in the Azure portal, with the cursor over the menu exposed by clicking on the three dots (...) symbol to the far right of the storage target's row in the list.](media/storage-target-manage-options.png)
222-
223-
* Flush
224-
* Suspend
225-
* Force remove
226-
* Resume
227-
* Delete
228-
229-
### Flush cached files to the storage target
230-
231-
### Suspend a storage target
232-
233-
The suspend feature disables client access to a storage target, but doesn't permanently remove the storage target from your cache. You can use this option if you need to disable a back-end storage system for maintenance, repair, or replacement. <!-- https://msazure.visualstudio.com/One/_workitems/edit/5301521 -->
234-
235-
### Force remove a storage target
236-
<!-- https://msazure.visualstudio.com/One/_workitems/edit/8267141 -->
237-
238-
Delete
239-
240-
241185
## Next steps
242186

243-
* Read [Add storage targets](hpc-cache-add-storage.md) to learn more about these options.
187+
* Read [Manage storage targets](manage-storage-targets.md) for information about stopping, deleting, and flushing individual storage targets.
188+
* Read [Add storage targets](hpc-cache-add-storage.md) to learn more about storage target options.
244189
* Read [Plan the aggregated namespace](hpc-cache-namespace.md) for more tips about using virtual paths.

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,9 @@ The buttons at the top of the page can help you manage the cache:
2929

3030
Read more about these options below.
3131

32+
> [!TIP]
33+
> You can also manage individual storage targets - read [Manage storage targets](manage-storage-targets.md) for details.
34+
3235
Click the image below to watch a [video](https://azure.microsoft.com/resources/videos/managing-hpc-cache/) that demonstrates cache management tasks.
3336

3437
[![video thumbnail: Azure HPC Cache: Manage (click to visit the video page)](media/video-5-manage.png)](https://azure.microsoft.com/resources/videos/managing-hpc-cache/)
Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
---
2+
title: Manage Azure HPC Cache storage targets
3+
description: How to suspend, remove, force delete, and flush Azure HPC Cache storage targets
4+
author: ekpgh
5+
ms.service: hpc-cache
6+
ms.topic: how-to
7+
ms.date: 06/24/2021
8+
ms.author: v-erkel
9+
---
10+
11+
# Manage storage targets
12+
13+
You can perform management actions on individual storage targets. These actions supplement the cache-level options discussed in [Manage your cache](hpc-cache-manage.md).
14+
15+
Sometimes an individual storage target can get into a bad state and need to be temporarily removed, or permanently deleted. You also can save cached data for a specific target.
16+
17+
Open the **Storage targets** page in the Azure portal. Click the **...** text on the far right of the storage target list to open the list of tasks.
18+
19+
![Screenshot of the storage targets page in the Azure portal, with the cursor over the menu exposed by clicking on the three dots (...) symbol to the far right of the storage target's row in the list.](media/storage-target-manage-options.png)
20+
21+
These options are available:
22+
23+
* **Flush** - Write all cached changes to the back-end storage
24+
* **Suspend** - Temporarily stop the storage target from serving requests
25+
* **Resume** - Put a suspended storage target back into service
26+
* **Force remove** - Delete a storage target, skipping some usual steps
27+
* **Delete** - Permanently remove a storage target
28+
29+
Read the rest of this article for more detail about these options.
30+
31+
## Write cached files to the storage target
32+
33+
The **Flush** option tells the cache immediately copy any changed files stored in the cache to the back-end storage system. For example, if your client machines are updating a particular file repeatedly, it is held in the cache for quicker access and not written to the long-term storage system for a period ranging from several minutes to more than an hour.
34+
35+
The **Flush** action tells the cache to write all files to the storage system.
36+
37+
The cache won't accept requests from clients for files on this storage target until after the flush is complete.
38+
39+
You could use this option to make sure that the back-end storage is populated before doing a backup, or for any situation where you want to make sure the back-end storage has recent updates.
40+
41+
This option mainly applies to usage models that include write caching. Read [Understand cache usage models](cache-usage-models.md) to learn more about read and write caching.
42+
43+
## Suspend a storage target
44+
45+
The suspend feature disables client access to a storage target, but doesn't permanently remove the storage target from your cache. You can use this option if you need to disable a back-end storage system for maintenance, repair, or replacement.
46+
47+
## Put a suspended storage target back in service
48+
49+
Use **Resume** to un-suspend a storage target.
50+
51+
## Force remove a storage target
52+
53+
> [!NOTE]
54+
> This option can cause data loss for the affected storage target.
55+
56+
If a storage target can't be removed with a normal delete action, you can use the **Force remove** option to delete it from the Azure HPC Cache.
57+
58+
This action skips the step that synchronizes files in the cache with the files in the back-end storage system. There is no guarantee that any changes written to the HPC Cache will be written to the back-end storage system, so changes can be lost if you use this option.
59+
60+
There also is no guarantee that the back-end storage system will be accessible after it is removed from the cache.
61+
62+
Usually, force remove is used only when a storage target has become unresponsive or otherwise is in a bad state. This option lets you remove the bad storage target instead of having to take more drastic action.
63+
<!-- https://msazure.visualstudio.com/One/_workitems/edit/8267141 -->
64+
65+
## Delete a storage target
66+
67+
You can use the Azure portal or the AZ CLI to delete a storage target.
68+
69+
The regular delete option permanently removes the storage target from the HPC Cache, but first it synchronizes the cache contents with the back-end storage system. It's different from the force delete option, which does not synchronize data.
70+
71+
Deleting a storage target removes the storage system's association with this Azure HPC Cache, but it does not change the back-end storage system. For example, if you used an Azure Blob storage container, the container and its contents still exist after you delete it from the cache. You can add the container to a different Azure HPC Cache, re-add it to this cache, or delete it with the Azure portal.
72+
73+
If there is a large amount of changed data stored in the cache, deleting a storage target can take several minutes to complete. Wait for the action to finish to be sure that the data is safely stored in your long-term storage system.
74+
75+
### [Portal](#tab/azure-portal)
76+
77+
To remove a storage target, open the **Storage targets** page. Click the '...' next to the storage target and choose **Delete** from the menu.
78+
79+
### [Azure CLI](#tab/azure-cli)
80+
81+
[Set up Azure CLI for Azure HPC Cache](./az-cli-prerequisites.md).
82+
83+
Use [az hpc-cache storage-target remove](/cli/azure/hpc-cache/storage-target#az_hpc_cache_storage_target_remove) to delete a storage target from the cache.
84+
85+
```azurecli
86+
$ az hpc-cache storage-target remove --resource-group cache-rg --cache-name doc-cache0629 --name blob1
87+
88+
{- Finished ..
89+
"endTime": "2020-07-09T21:45:06.1631571+00:00",
90+
"name": "2f95eac1-aded-4860-b19c-3f089531a7ec",
91+
"startTime": "2020-07-09T21:43:38.5461495+00:00",
92+
"status": "Succeeded"
93+
}
94+
```
95+
96+
---
97+
98+
## Next steps
99+
100+
* Learn about [cache-level management actions](hpc-cache-manage.md)
101+
* [Edit a storage target](hpc-cache-edit-storage.md)
-20.8 KB
Loading

0 commit comments

Comments
 (0)
Please sign in to comment.