Feature/update disaster recovery documentation for consistency and clarity in backup and recovery instructions

cortex-sa · cortex-sa · commit cb4d1e72caec · 2025-04-24T13:49:34.000+01:00
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md
@@ -1,6 +1,6 @@
 ---
-title: "Add Scheduled Backup To Application Server"
-linkTitle: "Add Scheduled Backup To Application Server"
+title: "Add Scheduled Backup to Application Server"
+linkTitle: "Add Scheduled Backup to Application Server"
 description: "Instructions to add scheduled backups to the Application Server."
 weight: 40
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger.md
@@ -1,6 +1,6 @@
 ---
-title: "Add Scheduled Backup To Flow Debugger"
-linkTitle: "Add Scheduled Backup To Flow Debugger"
+title: "Add Scheduled Backup to Flow Debugger"
+linkTitle: "Add Scheduled Backup to Flow Debugger"
 description: "Instructions to add scheduled backups to the Flow Debugger."
 weight: 30
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-gateway.md
@@ -1,6 +1,6 @@
 ---
-title: "Add Scheduled Backup To Gateway"
-linkTitle: "Add Scheduled Backup To Gateway"
+title: "Add Scheduled Backup to Gateway"
+linkTitle: "Add Scheduled Backup to Gateway"
 description: "Instructions to add scheduled backups to Gateway."
 weight: 40
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md
@@ -1,6 +1,6 @@
 ---
-title: "Recover Application Server From Scheduled Backup"
-linkTitle: "Recover Application Server From Scheduled Backup"
+title: "Recover Application Server from Scheduled Backup"
+linkTitle: "Recover Application Server from Scheduled Backup"
 description: "Instructions to recover the Application Server from scheduled backups."
 weight: 40
 ---
@@ -9,14 +9,14 @@ weight: 40
 
 This guide describes how to recover the Application Servers from a backup. This will recover the application's reliable collections. Any recovery needed for the cluster's configuration, the service's appsettings, manifests or settings must be done manually.
 
-### Configure the Recover Script
+### Configure the Recovery Script
 
 {{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}
 
-### Run the Recover Script
+### Run the Recovery Script
 
-{{% alert title="Note" %}}
-A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" title="Add Scheduled Backup To Application Server" >}} for further information.
+{{% alert title="Warning" color="warning" %}}
+A backup policy must be configured on the Application Server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" title="Add Scheduled Backup to Application Server" >}} for further information.
 {{% /alert %}}
 
 {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup.md
@@ -1,38 +1,38 @@
 ---
-title: "Recover Encryption Key From Backup"
-linkTitle: "Recover Encryption Key From Backup"
+title: "Recover Encryption Key from Backup"
+linkTitle: "Recover Encryption Key from Backup"
 description: "Instructions to recover the Encryption Key from backups."
 weight: 30
 ---
 
 # {{% param title %}}
 
-This guide describes how to recover the Encryption Key from a backup. This will recover the Encryption Key to the application servers, the web application server, and the load balancer server if a built-in load balancer is used.
+This guide describes how to recover the Encryption Key from a backup. This will recover the Encryption Key to the application servers, the web application server, and the load balancer server if the built-in load balancer is used.
 
 {{% alert title="Warning" color="warning" %}}
-The Encryption Key must be recovered before any installation of {{% ctx %}}.
+If recovering to new hardware, the Encryption Key must be recovered before {{% ctx %}} is installed.
 {{% /alert %}}
 
-### Configure the Recover Script
+### Configure the Recovery Script
 1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.EncryptionKey.Recover.ps1` script and open it with a text editor.
 1. Configure the script according to the details given below:
 
     ```powershell
     .\Cortex.EncryptionKey.Recover.ps1 `
-        -TargetMachines @("app-server1","app-server2","app-server3", "lb-server","web-server") `
+        -TargetMachines @("app-server1", "app-server2", "app-server3", "lb-server", "web-server") `
         -BackupPath "\\UncPath\BackupLocation" `
         -Credential $Credential
     ```
 
     | Name                                           | Description |
     |------------------------------------------------|-------------|
     |`TargetMachines`                                | Configure the value with the names of the application servers, the web application server and load balancer server if using the built-in load balancer.|
-    |`BackupPath`                                    | Replace `\\UncPath\BackupLocation` with the path of the location the backups are stored in. if the path is a network path then the `Credentials` will be used to access that location.|
+    |`BackupPath`                                    | Replace `\\UncPath\BackupLocation` with the path of the location the backups are stored in. If the path is a network path then the `Credentials` will be used to access that location.|
     |`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.|
 
 1. Save and close `Cortex.Innovation.EncryptionKey.Recover.ps1`.
 
-### Run the Recover Script
+### Run the Recovery Script
 
 {{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}}
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md
@@ -1,6 +1,6 @@
 ---
-title: "Recover Web Application From Scheduled Backups"
-linkTitle: "Recover Web Application From Scheduled Backups"
+title: "Recover Web Application from Scheduled Backups"
+linkTitle: "Recover Web Application from Scheduled Backups"
 description: "Instructions to recover the Web Application Server from scheduled backups."
 weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup.md
@@ -1,6 +1,6 @@
 ---
-title: "Recover Flow Debugger From Scheduled Backup"
-linkTitle: "Recover Flow Debugger From Scheduled Backup"
+title: "Recover Flow Debugger from Scheduled Backup"
+linkTitle: "Recover Flow Debugger from Scheduled Backup"
 description: "Instructions to recover the Flow Debugger from scheduled backups."
 weight: 30
 ---
@@ -9,14 +9,14 @@ weight: 30
 
 This guide describes how to recover the Flow Debugger from a backup. This will recover the application's reliable collections. Any recovery needed for the cluster's configuration, the service's appsettings, manifests or settings must be done manually.
 
-### Configure the Recover Script
+### Configure the Recovery Script
 
 {{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}
 
-### Run the Recover Script
+### Run the Recovery Script
 
-{{% alert title="Note" %}}
-A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToFlowDebugger" title="Add Scheduled Backup to Flow Debugger" >}} for further information.
+{{% alert title="Warning" color="warning" %}}
+A backup policy must be configured on the Application Server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToFlowDebugger" title="Add Scheduled Backup to Flow Debugger" >}} for further information.
 {{% /alert %}}
 
 {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-gateway-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-gateway-from-backup.md
@@ -1,6 +1,6 @@
 ---
-title: "Recover Gateway From Scheduled Backup"
-linkTitle: "Recover Gateway From Scheduled Backup"
+title: "Recover Gateway from Scheduled Backup"
+linkTitle: "Recover Gateway from Scheduled Backup"
 description: "Instructions to recover Gateway from scheduled backups."
 weight: 40
 ---
@@ -9,11 +9,11 @@ weight: 40
 
 This guide describes how to recover Gateway from a backup. This will recover the flow repositories and the OpenAPI definitions. Any recovery needed for the web config must be done manually.
 
-### Configure the Recover Script
+### Configure the Recovery Script
 
 {{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}}
 
-### Run the Recover Script
+### Run the Recovery Script
 
 {{% alert title="Note" %}}
 A backup policy should be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToGateway" title="Add Scheduled Backup to Gateway" >}} for further information.
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md
@@ -1,6 +1,6 @@
 ---
-title: "Remove Scheduled Backup From Application Server"
-linkTitle: "Remove Scheduled Backup From Application Server"
+title: "Remove Scheduled Backup from Application Server"
+linkTitle: "Remove Scheduled Backup from Application Server"
 description: "Instructions to remove scheduled backups from the Application Server."
 weight: 50
 ---
@@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve
 
 ## Next Steps?
 
-1. [Remove Scheduled Backups From Web Application Server][]
+1. [Remove Scheduled Backups from Web Application Server][]
 
-[Remove Scheduled Backups From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}}
+[Remove Scheduled Backups from Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/_index.md
@@ -1,6 +1,6 @@
 ---
-title: "Remove Scheduled Backups From Web Application Server"
-linkTitle: "Remove Scheduled Backups From Web Application Server"
+title: "Remove Scheduled Backups from Web Application Server"
+linkTitle: "Remove Scheduled Backups from Web Application Server"
 description: "Instructions to remove scheduled backups from the Web Application Server."
 weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger.md
@@ -1,6 +1,6 @@
 ---
-title: "Remove Scheduled Backup From Flow Debugger"
-linkTitle: "Remove Scheduled Backup From Flow Debugger"
+title: "Remove Scheduled Backup from Flow Debugger"
+linkTitle: "Remove Scheduled Backup from Flow Debugger"
 description: "Instructions to remove scheduled backups from the Flow Debugger."
 weight: 50
 ---
@@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th
 
 ## Next Steps?
 
-1. [Remove Scheduled Backup From Gateway][]
+1. [Remove Scheduled Backup from Gateway][]
 
-[Remove Scheduled Backup From Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}}
+[Remove Scheduled Backup from Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-gateway.md
@@ -1,13 +1,13 @@
 ---
-title: "Remove Scheduled Backup From Gateway"
-linkTitle: "Remove Scheduled Backup From Gateway"
+title: "Remove Scheduled Backup from Gateway"
+linkTitle: "Remove Scheduled Backup from Gateway"
 description: "Instructions to remove scheduled backups from Gateway."
 weight: 50
 ---
 
 # {{% param title %}}
 
-This guide describes how to delete a scheduled backup of Gateway. This will not delete any files created from the backup.
+This guide describes how to remove a scheduled backup of Gateway. This will not delete any files created from the backup.
 
 ## Configure the Backup Script
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md
@@ -9,11 +9,11 @@ weight: 40
 
 This guide describes how to recover the Application Server from a backup. This will recover the application's reliable collections. Any recovery needed for the cluster's configuration, the service's appsettings, manifests or settings must be done manually.
 
-### Configure the Recover Script
+### Configure the Recovery Script
 
 {{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}
 
-### Run the Recover Script
+### Run the Recovery Script
 
 {{% alert title="Note" %}}
 A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information.
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-encryption-key-from-backup.md
@@ -13,7 +13,7 @@ This guide describes how to recover the Encryption Key from a backup. This will
 The Encryption Key must be recovered before any installation of {{% ctx %}}.
 {{% /alert %}}
 
-### Configure the Recover Script
+### Configure the Recovery Script
 1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.EncryptionKey.Recover.ps1` script and open it with a text editor.
 1. Configure the script according to the details given below:
 
@@ -32,7 +32,7 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}.
 
 1. Save and close `Cortex.Innovation.EncryptionKey.Recover.ps1`.
 
-### Run the Recover Script
+### Run the Recovery Script
 
 {{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}}
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-web-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-web-application-from-backup.md
@@ -9,11 +9,11 @@ weight: 50
 
 This guide describes how to recover the Web Application Server from a backup. This will recover the flow repositories and the OpenAPI definitions. Any recovery needed for the web config must be done manually.
 
-### Configure the Recover Script
+### Configure the Recovery Script
 
 {{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}}
 
-### Run the Recover Script
+### Run the Recovery Script
 
 {{% alert title="Note" %}}
 A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information.
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-application.md
@@ -1,6 +1,6 @@
 ---
-title: "Remove Scheduled Backup From Application Server"
-linkTitle: "Remove Scheduled Backup From Application Server"
+title: "Remove Scheduled Backup from Application Server"
+linkTitle: "Remove Scheduled Backup from Application Server"
 description: "Instructions to remove scheduled backups from the Application Server."
 weight: 40
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-web-application.md
@@ -1,6 +1,6 @@
 ---
-title: "Remove Scheduled Backup From Web Application Server"
-linkTitle: "Remove Scheduled Backup From Web Application Server"
+title: "Remove Scheduled Backup from Web Application Server"
+linkTitle: "Remove Scheduled Backup from Web Application Server"
 description: "Instructions to remove scheduled backups from the Web Application Server."
 weight: 50
 ---
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-backup-script.md
@@ -24,7 +24,9 @@
     | `BackupSchedule`                               | Configure this value with either `Daily` or `Weekly`, depending on when the schedule will run. |
     | `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 (e.g. `@("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")`). |
     | `BackupTimes`                                  | Configure this value with the times that the backup will run. The format of the value should be in ISO8601 format (e.g. `@("12:00:00", "1:15:00", "2:20:30")`). |
-    | `BackupPath`                                   | Replace `\\UncPath\BackupLocation` with the path of the location where the backups will be stored. If the path is a network path, the `Credential` will be used to access that location. |
+    | `BackupPath`                                   | Replace `\\UncPath\BackupLocation` with the path of the location where the backups will be stored. If the path is a network path, the `Credential` will be used to access that location. {{% alert title="Warning" color="warning" %}}
+This location must not be the same as any other scheduled Application Server or Flow Debugger backup.
+{{% /alert %}} |
     | `RetentionDuration`                            | Configure this value with the minimum duration for which a backup will remain stored in the storage. It might get deleted after that span of time. The format of the value should be in ISO8601 format (e.g. `"12:00:00"`). |
     | `MinimumNumberOfBackups`                       | Configure this value with the minimum number of backups to be retained at any point in time. If specified with a non-zero value, backups will not be deleted even if they have exceeded the retention duration, as long as the number of backups is less than or equal to this value. |
     | `Credential`                                   | The credentials of the user that will be used to access the `BackupPath`. It must be a domain user who 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. |
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script.md
@@ -1,5 +1,4 @@
 
-1. Save and close `Cortex.Innovation.Backup.ps1`.
 1. Open a Windows PowerShell (x64) window as administrator.
 1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
 
@@ -13,7 +12,7 @@
     .\Cortex.Innovation.Backup.ps1
     ```
 
-1. Run the PowerShell command to backup the application services.
+1. Run the PowerShell command to remove the scheduled backup for the application services.
 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.
-1. Wait for the script to finish running. This should take approximately 1 minute.
+1. Wait for the script to finish running. This should take seconds.
 1. Check that there have been no errors in the script; these would appear in red in the console.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/run-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/run-recover-script.md
@@ -13,5 +13,5 @@
 
 1. Run the PowerShell command to recover the application services.
 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.
-1. Wait for the script to finish running. This should take approximately 2 minute.
+1. Wait for the script to finish running. This could take some time depending on the size of the reliable collections.
 1. Check that there have been no errors in the script; these would appear in red in the console.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-backup-script.md
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-backup-script.md
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script.md
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/configure-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/configure-recover-script.md
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/run-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/run-recover-script.md
