Feature/add encryption key backup guides and update script paths for versioning

cortex-sa · cortex-sa · commit 933845529c87 · 2025-04-14T17:06:51.000+01:00
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md
@@ -1,12 +1,6 @@
 ---
-title: "Multiple Server - With HA (Recommended)"
+title: "Multiple Server - With HA"
 linkTitle: "Multiple Server - With HA"
-description: "Information about installing {{% ctx %}} across multiple on-premise servers with high availability (HA), including: information about components, supported architectures, server requirements, pre-installation steps and installation instructions."
+description: "TODO."
 weight: 10
 ---
-
-{{% pageinfo %}}
-Multiple server installations with HA are recommended for the following scenarios:
-
-* Production installations that are required to scale and support HA
-{{% /pageinfo %}}
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/_index.md
@@ -2,5 +2,5 @@
 title: "Application Server"
 linkTitle: "Application Server"
 description: "The backup and recovery process of the application server."
-weight: 300
+weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/_index.md
@@ -0,0 +1,6 @@
+---
+title: "Encryption Key"
+linkTitle: "Encryption Key"
+description: "The backup and recovery process of the encryption key."
+weight: 100
+---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/backup-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/backup-encryption-key.md
@@ -0,0 +1,22 @@
+---
+title: "Backup Encryption Key"
+linkTitle: "Backup Encryption Key"
+description: "Information about backing up the encryption key."
+weight: 40
+---
+
+# {{% param title %}}
+
+This guide describes how to configure a scheduled backup of the Encryption Key.
+
+## Configure the Backup Script
+
+{{< section "/disaster-recovery/encryption-key/backup/configure-backup-script.md">}}
+
+## Run the Backup Script
+
+{{< section "/disaster-recovery/encryption-key/backup/run-backup-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 delete or configure further scheduled backups in the future.
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key.md
@@ -0,0 +1,25 @@
+---
+title: "Recover Application Server"
+linkTitle: "Recover Application Server"
+description: "Information about recovering the application server."
+weight: 40
+---
+
+# {{% param title %}}
+
+This guide describes how to recover the Application Server from a backup. This will recovery the application's reliable collections.
+
+## Make Installation Artefacts Available
+{{< section "/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md" >}}
+
+### Configure the Recover Script
+
+{{< section "/disaster-recovery/encryption-key/recover/configure-recover-script.md">}}
+
+### 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.
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/_index.md
@@ -2,5 +2,5 @@
 title: "Application Server"
 linkTitle: "Application Server"
 description: "The backup and recovery process of the application server."
-weight: 300
+weight: 200
 ---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/_index.md
@@ -0,0 +1,6 @@
+---
+title: "Encryption Key"
+linkTitle: "Encryption Key"
+description: "The backup and recovery process of the encryption key."
+weight: 100
+---
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/backup-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/backup-encryption-key.md
@@ -0,0 +1,22 @@
+---
+title: "Backup Encryption Key"
+linkTitle: "Backup Encryption Key"
+description: "Information about backing up the encryption key."
+weight: 40
+---
+
+# {{% param title %}}
+
+This guide describes how to configure a scheduled backup of the Encryption Key.
+
+## Configure the Backup Script
+
+{{< section "/disaster-recovery/encryption-key/backup/configure-backup-script.md">}}
+
+## Run the Backup Script
+
+{{< section "/disaster-recovery/encryption-key/backup/run-backup-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 delete or configure further scheduled backups in the future.
diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key.md
@@ -0,0 +1,25 @@
+---
+title: "Recover Application Server"
+linkTitle: "Recover Application Server"
+description: "Information about recovering the application server."
+weight: 40
+---
+
+# {{% param title %}}
+
+This guide describes how to recover the Application Server from a backup. This will recovery the application's reliable collections.
+
+## Make Installation Artefacts Available
+{{< section "/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md" >}}
+
+### Configure the Recover Script
+
+{{< section "/disaster-recovery/encryption-key/recover/configure-recover-script.md">}}
+
+### 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.
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
@@ -1,4 +1,4 @@
-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.
+1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Backup.ps1` script and open it with a text editor.
 1. Configure the script according to the details given below:
     
     ```powershell
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,10 +1,10 @@
 
 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 2025.3 - App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
+1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
 
     ```powershell
-    cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery"
+    cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery"
     ```
 
 1. Type the following command into PowerShell:
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
@@ -1,8 +1,8 @@
 1. Open a Windows PowerShell (x64) window as administrator.
-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:
+1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
 
     ```powershell
-    cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery"
+    cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery"
     ```
 
 1. Type the following command into PowerShell:
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
@@ -0,0 +1,15 @@
+1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.EncryptionKey.Backup.ps1` script and open it with a text editor.
+1. Configure the script according to the details given below:
+
+    ```powershell
+    .\Cortex.EncryptionKey.Backup.ps1 `
+        -BackupPath "\\UncPath\BackupLocation" `
+        -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.|
+
+1. Save and close `Cortex.Innovation.EncryptionKey.Backup.ps1`.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/run-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/run-backup-script.md
@@ -0,0 +1,17 @@
+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:
+
+    ```powershell
+    cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery"
+    ```
+
+1. Type the following command into PowerShell:
+
+    ```powershell
+    .\Cortex.Innovation.EncryptionKey.Backup.ps1
+    ```
+
+1. Run the PowerShell command to backup 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 1 minutes.
+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/encryption-key/recover/configure-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/configure-recover-script.md
@@ -0,0 +1,17 @@
+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-server1") `
+        -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.|
+
+1. Save and close `Cortex.Innovation.EncryptionKey.Recover.ps1`.
diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/run-recover-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/run-recover-script.md
@@ -0,0 +1,17 @@
+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:
+
+    ```powershell
+    cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery"
+    ```
+
+1. Type the following command into PowerShell:
+
+    ```powershell
+    .\Cortex.Innovation.EncryptionKey.Recover.ps1
+    ```
+
+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 1 minutes.
+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-remove-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md
@@ -1,4 +1,4 @@
-1. In the `Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Gateway.Backup.ps1` script and open it with a text editor.
+1. In the `Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Gateway.Backup.ps1` script and open it with a text editor.
 1. Configure the script according to the details given below:
     
     ```powershell
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
@@ -1,8 +1,8 @@
 1. Open a Windows PowerShell (x64) window as administrator.
-1. Navigate PowerShell to inside the `Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
+1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
 
     ```powershell
-    cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery"
+    cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery"
     ```
 
 1. Type the following command into PowerShell:
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
@@ -1,9 +1,9 @@
 1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`.
 1. Open a Windows PowerShell (x64) window as administrator.
-1. Navigate PowerShell to inside the `Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
+1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
 
     ```powershell
-    cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery"
+    cd "C:\Install\Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery"
     ```
 
 1. Type the following command into PowerShell:
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
@@ -1,4 +1,4 @@
-1. In the `Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Gateway.Recover.ps1` script and open it with a text editor.
+1. In the `Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Gateway.Recover.ps1` script and open it with a text editor.
 1. Configure the script according to the details given below:
 
     ```powershell
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
@@ -1,8 +1,8 @@
 1. Open a Windows PowerShell (x64) window as administrator.
-1. Navigate PowerShell to inside the `Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
+1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary:
 
     ```powershell
-    cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery"
+    cd "C:\Install\Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery"
     ```
 
 1. Type the following command into PowerShell:

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		-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.
	`1`	+1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Backup.ps1` script and open it with a text editor.
`2`	`2`	`1. Configure the script according to the details given below:`
`3`	`3`
`4`	`4`	```powershell