Feature/add detailed backup and recovery instructions for encryption key and application servers in disaster recovery documentation

cortex-sa · cortex-sa · commit 394691416d5e · 2025-04-16T16:38:34.000+01:00
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Backup"
 linkTitle: "Backup"
-description: "The backup process."
+description: "Instructions to backup CORTEX on multiple on-premise servers with high availability (HA)."
 weight: 100
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key.md
@@ -1,13 +1,13 @@
 ---
 title: "Add Backup of Encryption Key"
 linkTitle: "Add Backup of Encryption Key"
-description: "Information about backing up the encryption key."
+description: "Instructions to back up the Encryption Key."
 weight: 30
 ---
 
 # {{% param title %}}
 
-This guide describes how to configure a scheduled backup of the Encryption Key.
+{{< section "/disaster-recovery/encryption-key/backup/description.md">}}
 
 ## Configure the Backup Script
 
@@ -19,7 +19,7 @@ This guide describes how to configure a scheduled backup of the Encryption Key.
 
 ## Preserve installation files
 
-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.
+{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}
 
 ## Next Steps?
 
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,7 +1,7 @@
 ---
 title: "Add Scheduled Backup To Application Server"
 linkTitle: "Add Scheduled Backup To Application Server"
-description: "Information about adding a scheduled backup to the 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/pre-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md
@@ -1,13 +1,13 @@
 ---
 title: "Pre-Backup"
 linkTitle: "Pre-Backup"
-description: "Information about the steps required to be completed prior to starting the disaster recovery process."
+description: "Information about the steps required to be completed prior to starting the backup process."
 weight: 20
 ---
 
 # {{% param title %}}
 
-This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}.
+This guide describes how to perform the steps required before starting the backup of {{% ctx %}}.
 
 ## Make Installation Artefacts Available on all Servers
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Add Scheduled Backups to Web Application Server"
 linkTitle: "Add Scheduled Backups to Web Application Server"
-description: "TODO."
+description: "Instructions to add scheduled backups to the Web Application Server."
 weight: 200
 ---
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,7 +1,7 @@
 ---
 title: "Add Scheduled Backup To Flow Debugger"
 linkTitle: "Add Scheduled Backup To Flow Debugger"
-description: "Information about adding a scheduled backup to the 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,7 +1,7 @@
 ---
 title: "Add Scheduled Backup To Gateway"
 linkTitle: "Add Scheduled Backup To Gateway"
-description: "Information about adding a 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/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Recovery"
 linkTitle: "Recovery"
-description: "The recovery process."
+description: "Instructions to recover CORTEX on multiple on-premise servers with high availability (HA)."
 weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/pre-recovery.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/pre-recovery.md
@@ -1,13 +1,13 @@
 ---
 title: "Pre-Recovery"
 linkTitle: "Pre-Recovery"
-description: "Information about the steps required to be completed prior to starting the disaster recovery process."
+description: "Information about the steps required to be completed prior to starting the recovery process."
 weight: 20
 ---
 
 # {{% param title %}}
 
-This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}.
+This guide describes how to perform the steps required before starting the recovery of {{% ctx %}}.
 
 ## Make Installation Artefacts Available on all Servers
 
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,13 +1,13 @@
 ---
 title: "Recover Application Server From Scheduled Backup"
 linkTitle: "Recover Application Server From Scheduled Backup"
-description: "Information about recovering the application server from a backup."
+description: "Instructions to recover the Application Server from scheduled backups."
 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 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.
 
 ### 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
@@ -1,25 +1,44 @@
 ---
 title: "Recover Encryption Key From Backup"
 linkTitle: "Recover Encryption Key From Backup"
-description: "Information about recovering the encryption key."
+description: "Instructions to recover the Encryption Key from backups."
 weight: 30
 ---
 
 # {{% param title %}}
 
-This guide describes how to recover the Application Server from a backup. This will recovery the application's reliable collections.
+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.
+
+{{% alert title="Warning" color="warning" %}}
+The Encryption Key must be recovered before any installation of {{% ctx %}}.
+{{% /alert %}}
 
 ### Configure the Recover 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") `
+        -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.|
+    |`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.|
 
-{{< section "/disaster-recovery/encryption-key/recover/configure-recover-script.md">}}
+1. Save and close `Cortex.Innovation.EncryptionKey.Recover.ps1`.
 
 ### Run the Recover Script
 
 {{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}}
 
 ## Preserve installation files
 
-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 the application in the future.
+{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}
 
 ## Next Steps?
 
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,7 +1,7 @@
 ---
 title: "Recover Flow Debugger From Scheduled Backup"
 linkTitle: "Recover Flow Debugger From Scheduled Backup"
-description: "Information about recovering the Flow Debugger from a backup."
+description: "Instructions to recover the Flow Debugger from scheduled backups."
 weight: 30
 ---
 
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,13 +1,13 @@
 ---
 title: "Recover Gateway From Scheduled Backup"
 linkTitle: "Recover Gateway From Scheduled Backup"
-description: "Information about recovering Gateway from a backup."
+description: "Instructions to recover Gateway from scheduled backups."
 weight: 40
 ---
 
 # {{% param title %}}
 
-This guide describes how to recover the 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 recovery the flow repositories and the openApi definitions. Any recovery need for the web config must be done manually.
 
 ### Configure the Recover Script
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Remove Scheduled Backups"
 linkTitle: "Remove Scheduled Backups"
-description: "TODO."
+description: "Instructions to remove any scheduled backups of CORTEX on multiple on-premise servers with high availability (HA)."
 weight: 300
 ---
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,7 +1,7 @@
 ---
 title: "Remove Scheduled Backup From Application Server"
 linkTitle: "Remove Scheduled Backup From Application Server"
-description: "Information about remove a scheduled backup from the application server."
+description: "Instructions to remove scheduled backups from the Application Server."
 weight: 50
 ---
 
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: "Multiple Server - With HA"
 linkTitle: "Multiple Server - With HA"
-description: "Disaster recovery instructions for multiple on-premise servers with high availability (HA)."
+description: "Instructions to recover the Web Application Server from scheduled backups."
 weight: 10
 ---
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,7 +1,7 @@
 ---
 title: "Remove Scheduled Backup From Flow Debugger"
 linkTitle: "Remove Scheduled Backup From Flow Debugger"
-description: "Information about remove a scheduled backup from the Flow Debugger."
+description: "Instructions to remove scheduled backups from the Flow Debugger."
 weight: 50
 ---
 
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,7 +1,7 @@
 ---
 title: "Remove Scheduled Backup From Web Application Server"
 linkTitle: "Remove Scheduled Backup From Web Application Server"
-description: "Information about remove a scheduled backup from Gateway."
+description: "Instructions to remove scheduled backups from Gateway."
 weight: 40
 ---
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Backup"
 linkTitle: "Backup"
-description: "The backup process."
+description: "Instructions to backup CORTEX on a single on-premise server without high availability (HA)."
 weight: 100
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-of-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-of-encryption-key.md
@@ -1,13 +1,13 @@
 ---
 title: "Add Backup of Encryption Key"
 linkTitle: "Add Backup of Encryption Key"
-description: "Information about backing up the encryption key."
+description: "Instructions to back up the Encryption Key."
 weight: 30
 ---
 
 # {{% param title %}}
 
-This guide describes how to configure a scheduled backup of the Encryption Key.
+{{< section "/disaster-recovery/encryption-key/backup/description.md">}}
 
 ## Configure the Backup Script
 
@@ -19,7 +19,7 @@ This guide describes how to configure a scheduled backup of the Encryption Key.
 
 ## Preserve installation files
 
-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.
+{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}
 
 ## Next Steps?
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md
@@ -1,7 +1,7 @@
 ---
 title: "Add Scheduled Backup To Application Server"
 linkTitle: "Add Scheduled Backup To Application Server"
-description: "Information about adding a scheduled backup to the 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/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
@@ -1,7 +1,7 @@
 ---
 title: "Add Scheduled Backup To Web Application Server"
 linkTitle: "Add Scheduled Backup To Web Application Server"
-description: "Information about adding a scheduled backup to the web application server."
+description: "Instructions to add scheduled backups to the Web Application Server."
 weight: 40
 ---
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/pre-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/pre-backup.md
@@ -1,13 +1,13 @@
 ---
 title: "Pre-Backup"
 linkTitle: "Pre-Backup"
-description: "Information about the steps required to be completed prior to starting the disaster recovery process."
+description: "Information about the steps required to be completed prior to starting the backup process."
 weight: 20
 ---
 
 # {{% param title %}}
 
-This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}.
+This guide describes how to perform the steps required before starting the backup of {{% ctx %}}.
 
 ## Make Installation Artefacts Available on all Servers
 
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md
@@ -1,6 +1,6 @@
 ---
 title: "Recovery"
 linkTitle: "Recovery"
-description: "The recovery process."
+description: "Instructions to recover CORTEX on a single on-premise server without high availability (HA)."
 weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/pre-recovery.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/pre-recovery.md
@@ -0,0 +1,20 @@
+---
+title: "Pre-Recovery"
+linkTitle: "Pre-Recovery"
+description: "Information about the steps required to be completed prior to starting the recovery process."
+weight: 20
+---
+
+# {{% param title %}}
+
+This guide describes how to perform the steps required before starting the recovery of {{% ctx %}}.
+
+## Make Installation Artefacts Available on all Servers
+
+{{< section "/disaster-recovery/make-installation-artefacts-available.md">}}
+
+## Next Steps?
+
+[Recover Encryption Key from Backup][]
+
+[Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoveryEncryptionKeyFromBackup" >}}
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
@@ -1,7 +1,7 @@
 ---
 title: "Recover Application Server From Scheduled Backup"
 linkTitle: "Recover Application Server From Scheduled Backup"
-description: "Information about recovering the application server from a backup."
+description: "Instructions to recover the Application Server from scheduled backups."
 weight: 40
 ---
 
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
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
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/_index.md
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
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
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/description.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/description.md
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
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/configure-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/configure-recover-script.md
