Skip to content

Commit 8fd99f2

Browse files
authored
Update azacsnap-get-started.md for AzAcSnap 10 Release
1 parent df827b5 commit 8fd99f2

File tree

1 file changed

+70
-137
lines changed

1 file changed

+70
-137
lines changed

articles/azure-netapp-files/azacsnap-get-started.md

Lines changed: 70 additions & 137 deletions
Original file line numberDiff line numberDiff line change
@@ -5,151 +5,86 @@ services: azure-netapp-files
55
author: Phil-Jensen
66
ms.service: azure-netapp-files
77
ms.topic: how-to
8-
ms.date: 03/03/2022
8+
ms.date: 05/15/2024
99
ms.author: phjensen
1010
---
1111

1212
# Get started with Azure Application Consistent Snapshot tool
1313

1414
This article provides a guide for installing the Azure Application Consistent Snapshot tool that you can use with Azure NetApp Files.
1515

16-
## Getting the snapshot tools
17-
18-
It's recommended customers get the most recent version of the [AzAcSnap Installer](https://aka.ms/azacsnapinstaller) from Microsoft.
19-
20-
The self-installation file has an associated [AzAcSnap Installer signature file](https://aka.ms/azacsnapdownloadsignature). This file is signed with Microsoft's public key to allow for GPG verification of the downloaded installer.
21-
22-
Once these downloads are completed, then follow the steps in this guide to install.
23-
24-
### Verifying the download
25-
26-
The installer has an associated PGP signature file with an `.asc` filename extension. This file can be used to ensure the installer downloaded is a verified
27-
Microsoft provided file. The [Microsoft PGP Public Key used for signing Linux packages](https://packages.microsoft.com/keys/microsoft.asc) has been used to sign the signature file.
28-
29-
The Microsoft PGP Public Key can be imported to a user's local as follows:
30-
31-
```bash
32-
wget https://packages.microsoft.com/keys/microsoft.asc
33-
gpg --import microsoft.asc
34-
```
35-
36-
The following commands trust the Microsoft PGP Public Key:
37-
38-
1. List the keys in the store.
39-
2. Edit the Microsoft key.
40-
3. Check the fingerprint with `fpr`.
41-
4. Sign the key to trust it.
42-
43-
```bash
44-
gpg --list-keys
45-
```
46-
47-
Listed keys:
48-
```output
49-
----<snip>----
50-
pub rsa2048 2015- 10 - 28 [SC]
51-
BC528686B50D79E339D3721CEB3E94ADBE1229CF
52-
uid [ unknown] Microsoft (Release signing) [email protected]
53-
```
54-
55-
```bash
56-
gpg --edit-key [email protected]
57-
```
58-
59-
Output from interactive `gpg` session signing Microsoft public key:
60-
```output
61-
gpg (GnuPG) 2.1.18; Copyright (C) 2017 Free Software Foundation, Inc.
62-
This is free software: you are free to change and redistribute it.
63-
There is NO WARRANTY, to the extent permitted by law.
64-
pub rsa2048/EB3E94ADBE1229CF
65-
created: 2015- 10 - 28 expires: never usage: SC
66-
trust: unknown validity: unknown
67-
[ unknown] (1). Microsoft (Release signing) <[email protected]>
68-
69-
gpg> fpr
70-
pub rsa2048/EB3E94ADBE1229CF 2015- 10 - 28 Microsoft (Release signing)
71-
72-
Primary key fingerprint: BC52 8686 B50D 79E3 39D3 721C EB3E 94AD BE12 29CF
73-
74-
gpg> sign
75-
pub rsa2048/EB3E94ADBE1229CF
76-
created: 2015- 10 - 28 expires: never usage: SC
77-
trust: unknown validity: unknown
78-
Primary key fingerprint: BC52 8686 B50D 79E3 39D3 721C EB3E 94AD BE12 29CF
79-
Microsoft (Release signing) <[email protected]>
80-
Are you sure that you want to sign this key with your
81-
key "XXX XXXX <[email protected]>" (A1A1A1A1A1A1)
82-
Really sign? (y/N) y
83-
84-
gpg> quit
85-
Save changes? (y/N) y
86-
```
87-
88-
The PGP signature file for the installer can be checked as follows:
89-
90-
```bash
91-
gpg --verify azacsnap_installer_v5.0.run.asc azazsnap_installer_v5.0.run
92-
```
93-
94-
```output
95-
gpg: Signature made Sat 13 Apr 2019 07:51:46 AM STD
96-
gpg: using RSA key EB3E94ADBE1229CF
97-
gpg: Good signature from "Microsoft (Release signing)
98-
99-
```
100-
101-
For more information about using GPG, see [The GNU Privacy Handbook](https://www.gnupg.org/gph/en/manual/book1.html).
102-
103-
## Supported scenarios
104-
105-
The snapshot tools can be used in the following [Supported scenarios for HANA Large Instances](../virtual-machines/workloads/sap/hana-supported-scenario.md) and [SAP HANA with Azure NetApp Files](../virtual-machines/workloads/sap/hana-vm-operations-netapp.md).
106-
107-
## Snapshot Support Matrix from SAP
108-
109-
The following matrix is provided as a guideline on which versions of SAP HANA are supported by SAP for Storage Snapshot Backups.
110-
111-
112-
113-
| Database type | Minimum database versions | Notes |
114-
|---------------------------|---------------------------|-----------------------------------------------------------------------------------------|
115-
| Single Container Database | 1.0 SPS 12, 2.0 SPS 00 | |
116-
| MDC Single Tenant | [2.0 SPS 01](https://help.sap.com/docs/SAP_HANA_PLATFORM/42668af650f84f9384a3337bcd373692/2194a981ea9e48f4ba0ad838abd2fb1c.html?version=2.0.01&locale=en-US) | or later versions where MDC Single Tenant supported by SAP for storage/data snapshots.* |
117-
| MDC Multiple Tenants | [2.0 SPS 04](https://help.sap.com/docs/SAP_HANA_PLATFORM/42668af650f84f9384a3337bcd373692/7910eb4a498246b1b0435a4e9bf938d1.html?version=2.0.04&locale=en-US) | or later where MDC Multiple Tenants supported by SAP for data snapshots. |
118-
> \* [SAP changed terminology from Storage Snapshots to Data Snapshots from 2.0 SPS 02](https://help.sap.com/docs/SAP_HANA_PLATFORM/42668af650f84f9384a3337bcd373692/7f203cf75ae4445d96ad0012c67c0480.html?version=2.0.02&locale=en-US)
119-
120-
121-
122-
16+
## Installation and setup workflow for AzAcSnap
17+
18+
This workflow provides the main steps to install, setup and configure AzAcSnap along with your chosen database and storage option.
19+
20+
**Steps**:
21+
1. [Install AzAcSnap](azacsnap-installation.md)
22+
1. [Configure Database](azacsnap-configure-database.md)
23+
1. [SAP HANA](azacsnap-configure-database.md?tabs=sap-hana)
24+
1. [Oracle DB](azacsnap-configure-database.md?tabs=oracle)
25+
1. [IBM Db2](azacsnap-configure-database.md?tabs=db2)
26+
1. Microsoft SQL Server (PREVIEW)
27+
1. [Configure Storage](azacsnap-configure-storage.md)
28+
1. [Azure NetApp Files](azacsnap-configure-storage.md?tabs=azure-netapp-files)
29+
1. [Azure Large Instance](azacsnap-configure-storage.md?tabs=azure-large-instance)
30+
1. Azure Managed Disk (PREVIEW)
31+
1. [Configure AzAcSnap](azacsnap-cmd-ref-configure.md)
32+
1. [Test AzAcSnap](azacsnap-cmd-ref-test.md)
33+
1. [Take a backup with AzAcSnap](azacsnap-cmd-ref-backup.md)
34+
35+
## Technical articles
36+
37+
The following technical articles describe how to setup AzAcSnap as part of a data protection strategy:
38+
39+
- [Manual Recovery Guide for SAP HANA on Azure VMs from Azure NetApp Files snapshot with AzAcSnap](https://techcommunity.microsoft.com/t5/running-sap-applications-on-the/manual-recovery-guide-for-sap-hana-on-azure-vms-from-azure/ba-p/3290161)
40+
- [Manual Recovery Guide for SAP HANA on Azure Large Instance from storage snapshot with AzAcSnap](https://techcommunity.microsoft.com/t5/running-sap-applications-on-the/manual-recovery-guide-for-sap-hana-on-azure-large-instance-from/ba-p/3242347)
41+
- [Manual Recovery Guide for SAP Oracle 19c on Azure VMs from Azure NetApp Files snapshot with AzAcSnap](https://techcommunity.microsoft.com/t5/running-sap-applications-on-the/manual-recovery-guide-for-sap-oracle-19c-on-azure-vms-from-azure/ba-p/3242408)
42+
- [Manual Recovery Guide for SAP Db2 on Azure VMs from Azure NetApp Files snapshot with AzAcSnap](https://techcommunity.microsoft.com/t5/running-sap-applications-on-the/manual-recovery-guide-for-sap-db2-on-azure-vms-from-azure-netapp/ba-p/3865379)
43+
- [SAP Oracle 19c System Refresh Guide on Azure VMs using Azure NetApp Files Snapshots with AzAcSnap](https://techcommunity.microsoft.com/t5/running-sap-applications-on-the/sap-oracle-19c-system-refresh-guide-on-azure-vms-using-azure/ba-p/3708172)
44+
- [Protecting HANA databases configured with HSR on Azure NetApp Files with AzAcSnap](https://techcommunity.microsoft.com/t5/running-sap-applications-on-the/protecting-hana-databases-configured-with-hsr-on-azure-netapp/ba-p/3654620)
45+
- [Automating SAP system copy operations with Libelle SystemCopy](https://docs.netapp.com/us-en/netapp-solutions-sap/lifecycle/libelle-sc-overview.html)
46+
47+
## Get command help
48+
49+
To see a list of commands and examples, type `azacsnap -h` and then press the ENTER key.
50+
51+
The general format of the commands is:
52+
`azacsnap -c [command] --[command] [sub-command] --[flag-name] [flag-value]`.
53+
54+
### Command options
55+
56+
The command options are as follows. The main bullets are commands, and the indented bullets are subcommands.
57+
58+
- `-h` provides extended command-line help with examples on AzAcSnap usage.
59+
- [`-c configure`](azacsnap-cmd-ref-configure.md) provides an interactive Q&A style interface to create or modify the `azacsnap` configuration file (default = `azacsnap.json`).
60+
- `--configuration new` creates a new configuration file.
61+
- `--configuration edit` enables editing an existing configuration file.
62+
- [`-c test`](azacsnap-cmd-ref-test.md) validates the configuration file and tests connectivity.
63+
- `--test <DbType>`, where DbType is one of `hana`, `oracle`, or `db2`, tests the connection to the specified database.
64+
- `--test storage` tests communication with the underlying storage interface by creating a temporary storage snapshot on all the configured `data` volumes, and then removing them.
65+
- `--test all` performs both the `hana` and `storage` tests in sequence.
66+
- [`-c backup`](azacsnap-cmd-ref-backup.md) is the primary command to execute database-consistent storage snapshots for SAP HANA data volumes and for other (for example, shared, log backup, or boot) volumes.
67+
- `--volume data` takes a snapshot of all the volumes in the `dataVolume` stanza of the configuration file.
68+
- `--volume other` takes a snapshot of all the volumes in the `otherVolume` stanza of the configuration file.
69+
- `--volume all` takes a snapshot of all the volumes in the `dataVolume` stanza and then all the volumes in the `otherVolume` stanza of the configuration file.
70+
- [`-c details`](azacsnap-cmd-ref-details.md) provides information on snapshots or replication.
71+
- `--details snapshots` (optional) provides a list of basic details about the snapshots for each volume that you configured.
72+
- `--details replication` (optional) provides basic details about the replication status from the production site to the disaster-recovery site.
73+
- [`-c delete`](azacsnap-cmd-ref-delete.md) deletes a storage snapshot or a set of snapshots.
74+
- [`-c restore`](azacsnap-cmd-ref-restore.md) provides two methods to restore a snapshot to a volume.
75+
- `--restore snaptovol` creates a new volume based on the latest snapshot on the target volume.
76+
- `-c restore --restore revertvolume` reverts the target volume to a prior state, based on the most recent snapshot.
77+
- `[--configfile <configfilename>]` is an optional command-line parameter to provide a different file name for the JSON configuration. It's useful for creating a separate configuration file per security ID (for example, `--configfile H80.json`).
78+
- [`[--runbefore]` and `[--runafter]`](azacsnap-cmd-ref-runbefore-runafter.md) are optional commands to run external commands or shell scripts before and after the execution of the main AzAcSnap logic.
79+
- `[--preview]` is an optional command-line option that's required when you're using preview features.
80+
81+
For more information, see [Preview features of the Azure Application Consistent Snapshot tool](azacsnap-preview.md).
12382

12483
## Important things to remember
12584

126-
- After the setup of the snapshot tools, continuously monitor the storage space available and if
127-
necessary, delete the old snapshots on a regular basis to avoid storage fill out.
85+
- After the setup of the snapshot tools, continuously monitor the storage space available and if necessary, delete the old snapshots on a regular basis to avoid running out of storage capacity.
12886
- Always use the latest snapshot tools.
129-
- Use the same version of the snapshot tools across the landscape.
13087
- Test the snapshot tools to understand the parameters required and their behavior, along with the log files, before deployment into production.
131-
- When setting up the HANA user for backup, you need to set up the user for each HANA instance. Create an SAP HANA user account to access HANA
132-
instance under the SYSTEMDB (and not in the SID database) for MDC. In the single container environment, it can be set up under the tenant database.
133-
- Customers must provide the SSH public key for storage access. This action must be done once per node and for each user under which the command is executed.
134-
- The number of snapshots per volume is limited to 250.
135-
- If manually editing the configuration file, always use a Linux text editor such as "vi" and not Windows editors like Notepad. Using Windows editor may corrupt the file format.
136-
- Set up `hdbuserstore` for the SAP HANA user to communicate with SAP HANA.
137-
- For DR: The snapshot tools must be tested on DR node before DR is set up.
138-
- Monitor disk space regularly
139-
- Automated log deletion is managed with the `--trim` option of the `azacsnap -c backup` for SAP HANA 2 and later releases.
140-
- **Risk of snapshots not being taken** - The snapshot tools only interact with the node of the SAP HANA system specified in the configuration file. If this
141-
node becomes unavailable, there's no mechanism to automatically start communicating with another node.
142-
- For an **SAP HANA Scale-Out with Standby** scenario it's typical to install and configure the snapshot tools on the primary node. But, if the primary node becomes
143-
unavailable, the standby node will take over the primary node role. In this case, the implementation team should configure the snapshot tools on both
144-
nodes (Primary and Stand-By) to avoid any missed snapshots. In the normal state, the primary node will take HANA snapshots initiated by crontab. If the primary
145-
node fails over those snapshots will have to be executed from another node, such as the new primary node (former standby). To achieve this outcome, the standby
146-
node would need the snapshot tool installed, storage communication enabled, hdbuserstore configured, `azacsnap.json` configured, and crontab commands staged
147-
in advance of the failover.
148-
- For an **SAP HANA HSR HA** scenario, it's recommended to install, configure, and schedule the snapshot tools on both (Primary and Secondary) nodes. Then, if
149-
the Primary node becomes unavailable, the Secondary node will take over with snapshots being taken on the Secondary. In the normal state, the Primary node
150-
will take HANA snapshots initiated by crontab. The Secondary node would attempt to take snapshots but fail as the Primary is functioning correctly. But,
151-
after Primary node failover, those snapshots will be executed from the Secondary node. To achieve this outcome, the Secondary node needs the snapshot tool
152-
installed, storage communication enabled, `hdbuserstore` configured, `azacsnap.json` configured, and crontab enabled in advance of the failover.
15388

15489
## Guidance provided in this document
15590

@@ -158,8 +93,8 @@ The following guidance is provided to illustrate the usage of the snapshot tools
15893
### Taking snapshot backups
15994

16095
- [What are the prerequisites for the storage snapshot](azacsnap-installation.md#prerequisites-for-installation)
161-
- [Enable communication with storage](azacsnap-installation.md#enable-communication-with-storage)
162-
- [Enable communication with database](azacsnap-installation.md#enable-communication-with-the-database)
96+
- [Enable communication with storage](azacsnap-configure-storage.md#enable-communication-with-storage)
97+
- [Enable communication with database](azacsnap-configure-database.md#enable-communication-with-the-database)
16398
- [How to take snapshots manually](azacsnap-tips.md#take-snapshots-manually)
16499
- [How to set up automatic snapshot backup](azacsnap-tips.md#setup-automatic-snapshot-backup)
165100
- [How to monitor the snapshots](azacsnap-tips.md#monitor-the-snapshots)
@@ -168,8 +103,6 @@ The following guidance is provided to illustrate the usage of the snapshot tools
168103
- [How to restore a `boot` snapshot](azacsnap-tips.md#restore-a-boot-snapshot)
169104
- [What are key facts to know about the snapshots](azacsnap-tips.md#key-facts-to-know-about-snapshots)
170105

171-
> Snapshots are tested for both single SID and multi SID.
172-
173106
### Performing disaster recovery
174107

175108
- [What are the prerequisites for DR setup](azacsnap-disaster-recovery.md#prerequisites-for-disaster-recovery-setup)

0 commit comments

Comments
 (0)