You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/azure-netapp-files/azacsnap-tips.md
+30-30Lines changed: 30 additions & 30 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,27 +16,27 @@ This article provides tips and tricks that might be helpful when you use AzAcSna
16
16
17
17
## Global override settings to control azacsnap behavior
18
18
19
-
AzAcSnap 8 introduced a new global settings file (`.azacsnaprc`) which must be located in the same (current working) directory as azacsnap is executed in. The filename is `.azacsnaprc` and by using the dot '.' character as the start of the filename makes it hidden to standard directory listings. The file allows global settings controlling the behavior of AzAcSnap to be set. The format is one entry per line with a supported customizing variable and a new overriding value.
19
+
AzAcSnap 8 introduced a new global settings file (`.azacsnaprc`) which must be located in the same (current working) directory as azacsnap is executed in. The filename is `.azacsnaprc` and by using the dot '.' character as the start of the filename makes it hidden to standard directory listings. The file allows global settings controlling the behavior of AzAcSnap to be set. The format is one entry per line with a supported customizing variable and a new overriding value.
20
20
21
21
Settings, which can be controlled by adding/editing the global override settings file or by setting them as environment variables are:
22
22
23
-
-**AZURE_MANAGEMENT_ENDPOINT** to customize the location of the Azure Management Endpoint which AzAcSnap will make Azure REST API calls to was introduced in AzAcSnap 9a. Values should be URL paths and the default value = 'https://management.azure.com'. For example, to configure AzAcSnap to ensure all management calls go to the Azure Management Endpoint for US Govt Cloud (ref: [Azure Government Guidance for developers](/azure/azure-government/compare-azure-government-global-azure#guidance-for-developers)) add the following to the `.azacsnaprc` file:
23
+
-**AZURE_MANAGEMENT_ENDPOINT** to customize the location of the Azure Management Endpoint which AzAcSnap make Azure REST API calls to was introduced in AzAcSnap 9a. Values should be URL paths and the default value = 'https://management.azure.com'. For example, to configure AzAcSnap to ensure all management calls go to the Azure Management Endpoint for US Government Cloud (ref: [Azure Government Guidance for developers](/azure/azure-government/compare-azure-government-global-azure#guidance-for-developers)) add the following to the `.azacsnaprc` file:
-**EXTERNAL_CMD_TIMEOUT_SECS** customizes the timeout for external shell commands. Values should be integers and the default value = 300. For example, to set the external command timeout to 10 minutes (600 seconds) add the following to the `.azacsnaprc` file:
25
+
-**EXTERNAL_CMD_TIMEOUT_SECS** customizes the timeout for external shell commands. Values should be integers and the default value = 300. For example, to set the external command timeout to 10 minutes (600 seconds) add the following to the `.azacsnaprc` file:
26
26
-`EXTERNAL_CMD_TIMEOUT_SECS=600`
27
27
28
28
> [!NOTE]
29
29
> As of AzAcSnap 11, the `EXTERNAL_CMD_TIMEOUT_SECS` only applies to Db2 database commands.
30
30
31
-
-**MAINLOG_LOCATION** which customizes the location of the "main-log" output file, which is called `azacsnap.log` and was introduced in AzAcSnap 8. Values should be absolute paths and the default value = '.' (which is the current working directory). For example, to ensure the "main-log" output file goes to the `/home/azacsnap/bin/logs` add the following to the `.azacsnaprc` file:
31
+
-**MAINLOG_LOCATION** which customizes the location of the "main-log" output file, which is called `azacsnap.log` and was introduced in AzAcSnap 8. Values should be absolute paths and the default value = '.' (which is the current working directory). For example, to ensure the "main-log" output file goes to the `/home/azacsnap/bin/logs` add the following to the `.azacsnaprc` file:
32
32
-`MAINLOG_LOCATION=/home/azacsnap/bin/logs`
33
33
34
34
> [!NOTE]
35
-
> As of AzAcSnap 9a all these values can be set as command-line environment variables as well, or instead of, the `.azacsnaprc` file. For example, on Linux the `AZURE_MANAGEMENT_ENDPOINT` can be set with `export AZURE_MANAGEMENT_ENDPOINT=https://management.usgovcloudapi.net` before running AzAcSnap.
35
+
> As of AzAcSnap 9a all these values can be set as command-line environment variables as well, or instead of, the `.azacsnaprc` file. For example, on Linux the `AZURE_MANAGEMENT_ENDPOINT` can be set with `export AZURE_MANAGEMENT_ENDPOINT=https://management.usgovcloudapi.net` before running AzAcSnap.
36
36
37
37
## Main-log parsing
38
38
39
-
AzAcSnap 8 introduced a new "main-log" to provide simpler parsing of runs of AzAcSnap. The inspiration for this file is the SAP HANA backup catalog, which shows when AzAcSnap was started, how long it took, and what the snapshot name is. With AzAcSnap, this idea has been taken further to include information for each of the AzAcSnap commands, specifically the `-c` options, and the file has the following headers:
39
+
AzAcSnap 8 introduced a new "main-log" to provide simpler parsing of runs of AzAcSnap. The inspiration for this file is the SAP HANA backup catalog, which shows when AzAcSnap was started, how long it took, and what the snapshot name is. With AzAcSnap, this idea is taken further to include information for each of the AzAcSnap commands, specifically the `-c` options, and the file has the following headers:
This format makes the file parse-able with the Linux commands `watch`, `grep`, `head`, `tail`, and `column` to get continuous updates of AzAcSnap backups. An example combination of these commands in single shell script to monitor AzAcSnap is as follows:
56
+
This format makes the file parse-able with the Linux commands `watch`, `grep`, `head`, `tail`, and `column` to get continuous updates of AzAcSnap backups. An example combination of these commands in single shell script to monitor AzAcSnap is as follows:
57
57
58
58
```bash
59
59
#!/bin/bash
@@ -138,9 +138,9 @@ DATE_TIME OPERATION_NAME STATUS DATABASE_TYPE SID DUR
138
138
139
139
## Limit service principal permissions
140
140
141
-
It may be necessary to limit the scope of the AzAcSnap service principal. Review the [Azure RBAC documentation](../role-based-access-control/index.yml) for more details on fine-grained access management of Azure resources.
141
+
It may be necessary to limit the scope of the AzAcSnap service principal. Review the [Azure Role Based Access Control documentation](../role-based-access-control/index.yml) for more details on fine-grained access management of Azure resources.
142
142
143
-
The following is an example role definition with the minimum required actions needed for AzAcSnap to function.
143
+
The following Azure CLI example provides a role definition with the minimum required actions needed for AzAcSnap to function.
144
144
145
145
```azurecli
146
146
az role definition create --role-definition '{ \
@@ -159,7 +159,7 @@ az role definition create --role-definition '{ \
159
159
}'
160
160
```
161
161
162
-
For restore options to work successfully, the AzAcSnap service principal also needs to be able to create volumes. In this case, the role definition needs an extra "Actions" clause added, therefore the complete service principal should look like the following example.
162
+
For restore options to work successfully, the AzAcSnap service principal also needs to be able to create volumes. In this case, the role definition needs an extra "Actions" clause added, therefore the complete service principal should look like the following example.
163
163
164
164
```azurecli
165
165
az role definition create --role-definition '{ \
@@ -182,7 +182,7 @@ az role definition create --role-definition '{ \
182
182
183
183
## Take snapshots manually
184
184
185
-
Before executing any backup commands (`azacsnap -c backup`), check the configuration by running the test commands and verify they get executed successfully. Correct execution of these tests proved `azacsnap` can communicate with the installed SAP HANA database and the underlying storage system of the SAP HANA on **Azure Large Instance** or **Azure NetApp Files** system.
185
+
Before executing any backup commands (`azacsnap -c backup`), check the configuration by running the test commands and verify they get executed successfully. Correct execution of these tests proved `azacsnap` can communicate with the installed SAP HANA database and the underlying storage system of the SAP HANA on **Azure Large Instance** or **Azure NetApp Files** system.
186
186
187
187
-`azacsnap -c test --test hana`
188
188
-`azacsnap -c test --test storage`
@@ -211,15 +211,15 @@ MAILTO=""
211
211
@daily (. /home/azacsnap/.profile ; cd /home/azacsnap/bin ; azacsnap -c backup --volume other --prefix DailyBootVol --retention=7 --configfile boot-vol.json)
212
212
```
213
213
214
-
Explanation of the above crontab.
214
+
Explanation of the example crontab output.
215
215
216
-
-`MAILTO=""`: by having an empty value this prevents cron from automatically trying to email the local Linux user when executing the crontab entry.
216
+
-`MAILTO=""`: by having an empty value for MAILTO cron will not try to email the local Linux user when executing the crontab entry.
217
217
- Shorthand versions of timing for crontab entries are self-explanatory:
218
218
-`@monthly` = Run once a month, that is, "0 0 1 * *".
219
219
-`@weekly` = Run once a week, that is, "0 0 * * 0".
220
220
-`@daily` = Run once a day, that is, "0 0 * * *".
221
221
-`@hourly` = Run once an hour, that is, "0 * * * *".
222
-
- The first five columns are used to designate times, refer to the following column examples:
222
+
- The first five columns are used to designate times. Refer to the following column examples:
223
223
-`0,15,30,45`: Every 15 minutes
224
224
-`0-23`: Every hour
225
225
-`*` : Every day
@@ -242,7 +242,7 @@ generated successfully.
242
242
243
243
AzAcSnap writes output of its operation to log files to assist with debugging and to validate correct operation. These log files continue to grow unless actively managed. Fortunately UNIX based systems have a tool to manage and archive log files called logrotate.
244
244
245
-
The following output provides an example configuration for logrotate. This configuration keeps a maximum of 31 logs (approximately one month), and when the log files are larger than 10k it rotates them by renaming with a number added to the filename and compresses them.
245
+
The following output provides an example configuration for logrotate. This configuration keeps a maximum of 31 logs, approximately one month. When the log files are larger than 10k it rotates them by renaming with a number added to the filename and compresses them.
246
246
247
247
```output
248
248
# azacsnap logrotate configuration file
@@ -254,7 +254,7 @@ compress
254
254
}
255
255
```
256
256
257
-
After the `logrotate.conf` file has been created, the `logrotate` command should be run regularly to archive AzAcSnap log files accordingly. Automating the `logrotate` command can be done using cron. The following output is one line of the azacsnap user's crontab, this example runs logrotate daily using the configuration file `~/logrotate.conf`.
257
+
After the `logrotate.conf` file is created, the `logrotate` command should be run regularly to archive AzAcSnap log files accordingly. Automating the `logrotate` command can be done using cron. The following output is one line of the azacsnap user's crontab, this example runs logrotate daily using the configuration file `~/logrotate.conf`.
@@ -292,7 +292,7 @@ The following conditions should be monitored to ensure a healthy system:
292
292
1. Consistency of the snapshots by restoring them to another system periodically.
293
293
294
294
> [!NOTE]
295
-
> To list snapshot details, execute the command `azacsnap -c details`.
295
+
> To list snapshot details, execute the command `azacsnap -c details`.
296
296
297
297
## Delete a snapshot
298
298
@@ -303,7 +303,7 @@ To delete a snapshot, use the command `azacsnap -c delete`. It's not possible to
303
303
304
304
## Restore a snapshot
305
305
306
-
A storage volume snapshot can be restored to a new volume (`-c restore --restore snaptovol`). For Azure Large Instance, the volume can be reverted to a snapshot (`-c restore --restore revertvolume`).
306
+
A storage volume snapshot can be restored to a new volume (`-c restore --restore snaptovol`). For Azure Large Instance, the volume can be reverted to a snapshot (`-c restore --restore revertvolume`).
307
307
308
308
> [!NOTE]
309
309
> There is **NO** database recovery command provided.
@@ -313,16 +313,16 @@ copy is made (`cp /hana/data/H80/mnt00001/.snapshot/hana_hourly.2020-06-17T11304
313
313
314
314
For Azure Large Instance, you could contact the Microsoft operations team by opening a service request to restore a desired snapshot from the existing available snapshots. You can open a service request via the [Azure portal](https://portal.azure.com).
315
315
316
-
If you decide to perform the disaster recovery failover, the `azacsnap -c restore --restore revertvolume` command at the DR site automatically makes available the most recent (`/hana/data` and `/hana/logbackups`) volume snapshots to allow for an SAP HANA recovery. Use this command with caution as it breaks replication between production and DR sites.
316
+
If you decide to perform the disaster recovery failover, the `azacsnap -c restore --restore revertvolume` command at the Disaster Recovery (DR) site automatically makes available the most recent (`/hana/data` and `/hana/logbackups`) volume snapshots to allow for an SAP HANA recovery. Use this command with caution as it breaks replication between production and DR sites.
317
317
318
318
## Set up snapshots for 'boot' volumes only
319
319
320
320
> [!IMPORTANT]
321
321
> This operation applies only to Azure Large Instance.
322
322
323
-
In some cases, customers already have tools to protect SAP HANA and only want to configure 'boot' volume snapshots. In this case, only the following steps need to be completed.
323
+
In some cases, customers already have tools to protect SAP HANA and only want to configure 'boot' volume snapshots. In this case, only the following steps need to be completed.
324
324
325
-
1. Complete steps 1-4 of the pre-requisites for installation.
325
+
1. Complete steps 1-4 of the prerequisites for installation.
326
326
1. Enable communication with storage.
327
327
1. Download and run the installer to install the snapshot tools.
328
328
1. Complete setup of snapshot tools.
@@ -340,7 +340,7 @@ In some cases, customers already have tools to protect SAP HANA and only want to
340
340
3 entries were displayed.
341
341
```
342
342
> [!NOTE]
343
-
> In this example, this host is part of a 3 node Scale-Out system and all 3 boot volumes can be seen from this host. This means all 3 boot volumes can be snapshot from this host, and all 3 should be added to the configuration file in the next step.
343
+
> In this example, this host is part of a three node Scale-Out system and all 3 boot volumes can be seen from this host. This setup means all three boot volumes can be snapshot from this host, and all three should be added to the configuration file in the next step.
344
344
345
345
1. Create a new configuration file as follows. The boot volume details must be in the OtherVolume stanza:
346
346
```bash
@@ -376,7 +376,7 @@ In some cases, customers already have tools to protect SAP HANA and only want to
376
376
377
377
Editing configuration complete, writing output to 'BootVolume.json'.
378
378
```
379
-
1. Check the config file, refer to the following example:
379
+
1. Check the config file. Refer to the following example:
380
380
381
381
Use `cat` command to display the contents of the configuration file:
382
382
@@ -435,7 +435,7 @@ In some cases, customers already have tools to protect SAP HANA and only want to
1. Check it's listed, note the addition of the `--snapshotfilter` option to limit the snapshot list returned.
438
+
1. Check the snapshot has been created by listing the snapshots using the `-c details` option. Note the addition of the `--snapshotfilter` option to limit the snapshot list returned.
0 commit comments