Feature/add documentation for Encryption Key backup and improve consistency in disaster recovery guides

cortex-sa · cortex-sa · commit 455b1bb56ae9 · 2025-04-22T13:06:40.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
@@ -7,7 +7,7 @@ weight: 40
 
 # {{% param title %}}
 
-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, the service's appsettings, manifests and settings.
+This guide describes how to configure a scheduled backup of the Application Servers. This will backup the application's reliable collections, the cluster's configuration, the service's appsettings, manifests and settings.
 
 ## Configure the Backup Script
 
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
@@ -7,7 +7,7 @@ weight: 30
 
 # {{% param title %}}
 
-This guide describes how to configure a scheduled backup of the Flow Debugger of the web application server. This will backup the application's reliable collections, the cluster's configuration and the service's appsettings.
+This guide describes how to configure a scheduled backup of the Flow Debugger on the Web Application Server. This will backup the application's reliable collections, the cluster's configuration and the service's appsettings.
 
 ## Configure the Backup Script
 
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
@@ -7,7 +7,7 @@ weight: 40
 
 # {{% param title %}}
 
-This guide describes how to configure a scheduled backup of Gateway on the Web Application Server. This will backup the flow repositories, openApi definitions and web config file.
+This guide describes how to configure a scheduled backup of Gateway on the Web Application Server. This will back up the flow repositories, OpenAPI definitions, and the web config file.
 
 ## Configure the Backup Script
 
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
@@ -7,7 +7,7 @@ weight: 40
 
 # {{% param title %}}
 
-This guide describes how to recover the Application Servers from a backup. This will recovery the application's reliable collections. Any recovery need for the cluster's configuration, the service's appsettings, manifests or settings must be done manually.
+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
 
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
@@ -7,7 +7,7 @@ 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, web application server and load balancer server if a built-in loadbalancer 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 a built-in load balancer is used.
 
 {{% alert title="Warning" color="warning" %}}
 The Encryption Key must be recovered before any installation of {{% ctx %}}.
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
@@ -7,7 +7,7 @@ weight: 30
 
 # {{% param title %}}
 
-This guide describes how to recover the Flow Debugger from a backup. This will recovery the application's reliable collections. Any recovery need for the cluster's configuration, the service's appsettings, manifests or settings must be done manually.
+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
 
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
@@ -7,7 +7,7 @@ weight: 40
 
 # {{% param title %}}
 
-This guide describes how to recover Gateway from a backup. This will recovery the flow repositories and the openApi definitions. Any recovery need for the web config must be done manually.
+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
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-web-application.md
@@ -7,7 +7,7 @@ weight: 40
 
 # {{% param title %}}
 
-This guide describes how to configure a scheduled backup of the Web Application Server. This will backup the flow repositories, openApi definitions and web config file.
+This guide describes how to configure a scheduled backup of the Web Application Server. This will back up the flow repositories, OpenAPI definitions, and the web config file.
 
 ## 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
@@ -7,7 +7,7 @@ weight: 40
 
 # {{% param title %}}
 
-This guide describes how to recover the Application Server from a backup. This will recovery the application's reliable collections. Any recovery need for the cluster's configuration, the service's appsettings, manifests or settings must be done manually.
+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
 
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
@@ -7,7 +7,7 @@ weight: 50
 
 # {{% param title %}}
 
-This guide describes how to recover the Web Application Server from a backup. This will recovery the flow repositories and the openApi definitions. Any recovery need for the web config must be done manually.
+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
 
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
@@ -18,15 +18,15 @@
 
     | Name                                           | Description |
     |------------------------------------------------|-------------|
-    |`BackupPolicyName`                              | Configure this value with the unique name of the backup policy that will be set for the application policy and scheduled Windows task. |
-    |`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.|
-    |`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 />&nbsp;- The replica has never taken a full backup since it has become primary,<br /><br />&nbsp;- Some of the log records since the last backup has been truncated, or<br /><br />&nbsp;- Replica passed the MaxAccumulatedBackupLogSizeInMB limit.|
-    |`BackupSchedule`                                | Configure the 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.|
-    |`BackupTimes`                                   | Configure the value with the times that the backup will run. The format of the value should be in ISO8601 format, date specified along with time will be ignored. |
-    |`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.|
-    |`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.|
-    |`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.|
-    |`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.|
+    | `BackupPolicyName`                             | Configure this value with the unique name of the backup policy that will be set for the application policy and the scheduled Windows task. |
+    | `AutoRestoreOnDataLoss`                        | Configure this value as `$true` if you want to trigger a restore automatically using the latest available backup in case the partition experiences a data loss event on your current application server. |
+    | `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 the specified number of incremental backups are completed in one of the following conditions:<br /><br />&nbsp; - The replica has never taken a full backup since it became primary,<br /><br />&nbsp; - Some of the log records since the last backup have been truncated, or<br /><br />&nbsp; - The replica passed the `MaxAccumulatedBackupLogSizeInMB` limit. |
+    | `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. |
+    | `BackupTimes`                                  | Configure this value with the times that the backup will run. The format of the value should be in ISO8601 format. The date specified along with the time will be ignored. |
+    | `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. |
+    | `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. The date specified along with the time will be ignored. |
+    | `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. |
 
 1. Save and close `Cortex.Innovation.Backup.ps1`.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-remove-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-remove-backup-script.md
@@ -8,9 +8,9 @@
         -Remove
     ```
 
-    | Name                                           | Description |
-    |------------------------------------------------|-------------|
-    |`BackupPolicyName`                              | Configure this value with the unique name of the backup policy that has been set for the application policy and scheduled windows task. |
-    |`Remove`                                        | Parameter used to indicate that the backup policy should be removed.|
+    | Name                | Description |
+    |---------------------|-------------|
+    | `BackupPolicyName`  | Configure this value with the unique name of the backup policy that was set for the application policy and the scheduled Windows task. |
+    | `Remove`            | Parameter used to indicate that the backup policy should be removed. |
 
 1. Save and close `Cortex.Innovation.Backup.ps1`.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/configure-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/configure-recover-script.md
@@ -8,9 +8,9 @@
         -Credential $Credential
     ```
 
-    | Name                                           | Description |
-    |------------------------------------------------|-------------|
-    |`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.|
+    | Name         | Description |
+    |--------------|-------------|
+    | `BackupPath` | Replace `\\UncPath\BackupLocation` with the path of the location where the backups are stored. If the path is a network path, the `Credential` will be used to access that location. |
+    | `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. |
 
 1. Save and close `Cortex.Innovation.Recover.ps1`.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/description.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/description.md
@@ -0,0 +1 @@
+This guide describes how to create a backup of the Encryption Key.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/configure-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/configure-backup-script.md
@@ -7,9 +7,9 @@
         -Credential $Credential
     ```
 
-    | Name                                           | Description |
-    |------------------------------------------------|-------------|
-    |`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.|
-    |`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.|
+    | Name         | Description |
+    |--------------|-------------|
+    | `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. |
+    | `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. |
 
 1. Save and close `Cortex.Innovation.EncryptionKey.Backup.ps1`.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/preserve-installation-files.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/preserve-installation-files.md
@@ -1 +1 @@
-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 backup and recover the Encryption Key in the future.
+Ensure that the installation files are backed up or kept on the server, especially the scripts and configuration files that have been modified. This will make it easier to backup and recover the Encryption Key in the future.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/preserve-scripts.md b/content/en/docs/2025.3/_shared/disaster-recovery/preserve-scripts.md
@@ -1 +1 @@
-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 recover, remove or configure further scheduled backups in the future.
+Ensure that the installation files are backed up or kept on the server, especially the scripts and configuration files that have been modified. This will make it easier to recover, remove or configure further scheduled backups in the future.
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
@@ -15,16 +15,16 @@
         -Credential $Credential
     ```
 
-    | Name                                           | Description |
-    |------------------------------------------------|-------------|
-    |`BackupTaskName`                              | Configure this value with the unique name of the backup task that will be set for the scheduled Windows task. |
-    |`BackupSchedule`                                | Configure the value with either `Daily` or `Weekly` depending on when the schedule will run.|
-    |`BackupDay`                                    | This is only needed if the `BackupSchedule` is set to `Weekly`. Configure this value with the day of the week when the backup should run.|
-    |`BackupTime`                                   | Configure the value with the time that the backup will run. The format of the value should be in ISO8601 format, date specified along with time will be ignored. |
-    |`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.|
-    |`BackupRetention`                             | Configure this value with the maximum number of backups that should be retained.|
-    |`SiteName`                        | Configure this value with the name of the site that should be backed up.|
-    |`GatewayApplicationName`                        | Configure this value with the name of the application under the specified site that should be backed up.|
-    |`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.|
+    | Name                       | Description |
+    |----------------------------|-------------|
+    | `BackupTaskName`           | Configure this value with the unique name of the backup task that will be set for the scheduled Windows task. |
+    | `BackupSchedule`           | Configure this value with either `Daily` or `Weekly`, depending on when the schedule will run. |
+    | `BackupDay`                | This is only needed if the `BackupSchedule` is set to `Weekly`. Configure this value with the day of the week when the backup should run. |
+    | `BackupTime`               | Configure this value with the time that the backup will run. The format of the value should be in ISO8601 format. The date specified along with the time will be ignored. |
+    | `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. |
+    | `BackupRetention`          | Configure this value with the maximum number of backups that should be retained. |
+    | `SiteName`                 | Configure this value with the name of the site that should be backed up. |
+    | `GatewayApplicationName`   | Configure this value with the name of the application under the specified site that should be backed up. |
+    | `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. |
 
 1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`.
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/recover/configure-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/configure-recover-script.md
