|
1 | 1 | --- |
2 | | -title: "Add Scheduled Backup To Application Server" |
3 | | -linkTitle: "Add Scheduled Backup To Application Server" |
4 | | -description: "Information about backing up the application server." |
| 2 | +title: "Add Scheduled Backup To Flow Debugger" |
| 3 | +linkTitle: "Add Scheduled Backup To Flow Debugger" |
| 4 | +description: "Information about backing up the Flow Debugger." |
5 | 5 | weight: 40 |
6 | 6 | --- |
7 | 7 |
|
8 | 8 | # {{% param title %}} |
9 | 9 |
|
10 | | -This guide describes how to configure a scheduled backup of the Application Server. This will backup the application's reliable collections, the cluster's configuration and the service's appsettings. |
| 10 | +This guide describes how to configure a scheduled backup of the Flow Debugger. This will backup the application's reliable collections, the cluster's configuration and the service's appsettings. |
11 | 11 |
|
12 | 12 | ## Configure the Backup Script |
13 | 13 |
|
14 | | -1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Backup.ps1` script and open it with a text editor. |
15 | | -1. Configure the script according to the details given below: |
16 | | - |
17 | | - ```powershell |
18 | | - .\Cortex.Backup.ps1 ` |
19 | | - -ConfigFileName "Cortex.Application.Backup.Config.json" ` |
20 | | - -AutoRestoreOnDataLoss $false ` |
21 | | - -BackupPolicyName "Customer1.BackupPolicy1" ` |
22 | | - -MaxIncrementalBackups 5 ` |
23 | | - -BackupSchedule "Weekly" ` |
24 | | - -BackupDays @("Monday") ` |
25 | | - -BackupTimes @("00:00:00") ` |
26 | | - -BackupPath "\\UncPath\BackupLocation" ` |
27 | | - -RetentionDuration "24:00:00" ` |
28 | | - -MinimumNumberOfBackups 1 ` |
29 | | - -Credential $Credential |
30 | | - ``` |
31 | | -
|
32 | | - | Name | Description | |
33 | | - |------------------------------------------------|-------------| |
34 | | - |`BackupPolicyName` | Configure this value with the unique name of the backup policy that will be set for the application policy and scheduled Windows task. | |
35 | | - |`AutoRestoreOnDataLoss` | Configure the value as `$true` if you want to trigger restore automatically using the latest available backup in case the partition experiences a data loss event on your current application server.| |
36 | | - |`MaxIncrementalBackups` | Configure this value with the maximum number of incremental backups to be taken between two full backups.<br /><br />This is just the upper limit.<br /><br />A full backup may be taken before specified number of incremental backups are completed in one of the following conditions<br /><br /> - The replica has never taken a full backup since it has become primary,<br /><br /> - Some of the log records since the last backup has been truncated, or<br /><br /> - Replica passed the MaxAccumulatedBackupLogSizeInMB limit.| |
37 | | - |`BackupSchedule` | Configure the value with either `Daily` or `Weekly` depending on when the schedule will run.| |
38 | | - |`BackupDays` | This is only needed if the `BackupSchedule` is set to `Weekly`. Configure this value with the days of the week when the backup should run.| |
39 | | - |`BackupTimes` | Configure the value with the times that the back up will run. The format of the value should be in ISO8601 format, date specified along with time will be ignored. | |
40 | | - |`BackupPath` | Replace `\\UncPath\BackupLocation` with the path of the location the backups will be stored in. if the path is a network path then the `Credentials` will be used to access that location.| |
41 | | - |`RetentionDuration` | Configure this value with the minimum duration for which a backup created, will remain stored in the storage and might get deleted after that span of time. The format of the value should be in ISO8601 format, date specified along with time will be ignored.| |
42 | | - |`MinimumNumberOfBackups` | Configure this value with the minimum number of backups to be retained at any point of time. If specified with a non zero value, backups will not be deleted even if the backups have gone past retention duration and have number of backups less than or equal to it.| |
43 | | - |`Credential` | The credentials of the user which will be used to access the `BackupPath`. It must be a domain user that is a member of the local Administrators group on the server. <br /><br /> This does not need to be changed, a prompt will appear to enter this information when the script is run.| |
44 | | -
|
45 | | -1. Save and close `Cortex.Innovation.Backup.ps1`. |
| 14 | +{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}} |
46 | 15 |
|
47 | 16 | ## Run the Backup Script |
48 | 17 |
|
49 | | -1. Open a Windows PowerShell (x64) window as administrator. |
50 | | -1. Navigate PowerShell to inside the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary: |
51 | | -
|
52 | | - ```powershell |
53 | | - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" |
54 | | - ``` |
55 | | -
|
56 | | -1. Type the following command into PowerShell: |
57 | | -
|
58 | | - ```powershell |
59 | | - .\Cortex.Innovation.Backup.ps1 |
60 | | - ``` |
61 | | -
|
62 | | -1. Run the PowerShell command to backup the application services. |
63 | | -1. A credentials prompt will appear. Enter credentials of a domain user that is a member of the local Administrators group on the server and press OK. |
64 | | -1. Wait for the script to finish running. This should take between 2 to 10 minutes. |
65 | | -1. Check that there have been no errors in the script; these would appear in red in the console. |
| 18 | +{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} |
66 | 19 |
|
67 | 20 | ## Preserve installation files |
68 | 21 |
|
69 | | -Ensure that the installation files are backed up or kept on the server, especially the scripts and config files that have been modified. This will make it easier to delete or configure further scheduled backups in the future. |
| 22 | +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} |
0 commit comments