Skip to content

Commit aa987d1

Browse files
cortex-sacortex-sa
authored
Feature/disaster recovery docs (#213)
* Feature/add disaster recovery guides for 2025.3 * Feature/add disaster recovery scripts and update backup configurations for 2025.3 * Fix typos in disaster recovery guide links and update backup script documentation * Feature/add encryption key backup guides and update script paths for versioning * Feature/add backup and recovery guides for encryption key in disaster recovery documentation * Refactor disaster recovery guides by removing outdated sections on installation artifacts * Feature/add encryption key backup guides for single and multiple server disaster recovery * Remove unnecessary blank line in disaster recovery URLs configuration * Feature/add backup and recovery guides for single and multiple server disaster recovery * Feature/add detailed backup and recovery instructions for encryption key and application servers in disaster recovery documentation * Fix capitalization of "Installation" in disaster recovery documentation * Feature/update disaster recovery documentation for removing scheduled backups from web application server * Feature/update disaster recovery documentation for single and multiple server configurations * Feature/update disaster recovery documentation for clarity and consistency in backup instructions * Feature/add preserve scripts documentation for disaster recovery and update references * Feature/add documentation for Encryption Key backup and improve consistency in disaster recovery guides * Feature/update disaster recovery documentation to use {{% ctx %}} placeholder for consistency * Feature/update disaster recovery documentation for consistency and clarity in backup and recovery instructions * Feature/update disaster recovery documentation for title consistency and clarity in backup and recovery instructions * Feature/update disaster recovery documentation for clarity and consistency in recovery instructions
1 parent 8081e0e commit aa987d1

File tree

57 files changed

+1076
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

57 files changed

+1076
-0
lines changed

‎content/en/docs/2025.3/Guides/disaster-recovery/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Disaster Recovery Guides"
3+
linkTitle: "Disaster Recovery Guides"
4+
description: "This section includes all disaster recovery guides for the {{% ctx %}} platform."
5+
weight: 30
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Multiple Server - With HA"
3+
linkTitle: "Multiple Server - With HA"
4+
description: "Instructions for disaster recovery of a {{% ctx %}} platform installed on multiple on-premise servers with high availability (HA)."
5+
weight: 50
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Backup"
3+
linkTitle: "Backup"
4+
description: "Instructions to backup {{% ctx %}} on multiple on-premise servers with high availability (HA)."
5+
weight: 100
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Add Backup of Encryption Key"
3+
linkTitle: "Add Backup of Encryption Key"
4+
description: "Instructions to backup the Encryption Key."
5+
weight: 30
6+
---
7+
8+
# {{% param title %}}
9+
10+
{{< section "/disaster-recovery/encryption-key/backup/description.md">}}
11+
12+
## Configure the Backup Script
13+
14+
{{< section "/disaster-recovery/encryption-key/backup/configure-backup-script.md">}}
15+
16+
## Run the Backup Script
17+
18+
{{< section "/disaster-recovery/encryption-key/backup/run-backup-script.md">}}
19+
20+
## Preserve Installation Files
21+
22+
{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}
23+
24+
## Next Steps?
25+
26+
1. [Add Scheduled Backup to Application Server][]
27+
28+
[Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Add Scheduled Backup to Application Server"
3+
linkTitle: "Add Scheduled Backup to Application Server"
4+
description: "Instructions to add scheduled backups to the Application Server."
5+
weight: 40
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
## Configure the Backup Script
13+
14+
{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}}
15+
16+
## Run the Backup Script
17+
18+
{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}}
19+
20+
## Preserve Installation Files
21+
22+
{{< section "/disaster-recovery/preserve-scripts.md">}}
23+
24+
## Next Steps?
25+
26+
1. [Add Scheduled Backups to Web Application Server][]
27+
28+
[Add Scheduled Backups to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupsToWebApplicationServer" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Pre-Backup"
3+
linkTitle: "Pre-Backup"
4+
description: "Information about the steps required to be completed prior to starting the backup process."
5+
weight: 20
6+
---
7+
8+
# {{% param title %}}
9+
10+
This guide describes how to perform the steps required before starting the backup of {{% ctx %}}.
11+
12+
## Make Installation Artefacts Available on all Servers
13+
14+
{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}}
15+
16+
## Next Steps?
17+
18+
1. [Add Backup of Encryption Key][]
19+
20+
[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Add Scheduled Backups to Web Application Server"
3+
linkTitle: "Add Scheduled Backups to Web Application Server"
4+
description: "Instructions to add scheduled backups to the Web Application Server."
5+
weight: 200
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Add Scheduled Backup to Flow Debugger"
3+
linkTitle: "Add Scheduled Backup to Flow Debugger"
4+
description: "Instructions to add scheduled backups to the Flow Debugger."
5+
weight: 30
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
## Configure the Backup Script
13+
14+
{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}}
15+
16+
## Run the Backup Script
17+
18+
{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}}
19+
20+
## Preserve Installation Files
21+
22+
{{< section "/disaster-recovery/preserve-scripts.md">}}
23+
24+
## Next Steps?
25+
26+
1. [Add Scheduled Backup to Gateway][]
27+
28+
[Add Scheduled Backup to Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToGateway" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-gateway.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
---
2+
title: "Add Scheduled Backup to Gateway"
3+
linkTitle: "Add Scheduled Backup to Gateway"
4+
description: "Instructions to add scheduled backups to Gateway."
5+
weight: 40
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
## Configure the Backup Script
13+
14+
{{< section "/disaster-recovery/web-application-server/backup/configure-backup-script.md">}}
15+
16+
## Run the Backup Script
17+
18+
{{< section "/disaster-recovery/web-application-server/backup/run-backup-script.md">}}
19+
20+
## Preserve Installation Files
21+
22+
{{< section "/disaster-recovery/preserve-scripts.md">}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Recovery"
3+
linkTitle: "Recovery"
4+
description: "Instructions to recover {{% ctx %}} on multiple on-premise servers with high availability (HA)."
5+
weight: 200
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/pre-recovery.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
title: "Pre-Recovery"
3+
linkTitle: "Pre-Recovery"
4+
description: "Information about the steps required to be completed prior to starting the recovery process."
5+
weight: 20
6+
---
7+
8+
# {{% param title %}}
9+
10+
This guide describes how to perform the steps required before starting the recovery of {{% ctx %}}.
11+
12+
## Make Installation Artefacts Available on all Servers
13+
14+
{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}}
15+
16+
## Next Steps?
17+
18+
1. [Recover Encryption Key from Backup][]
19+
20+
[Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoveryEncryptionKeyFromBackup" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Recover Application Server from Scheduled Backup"
3+
linkTitle: "Recover Application Server from Scheduled Backup"
4+
description: "Instructions to recover the Application Server from scheduled backups."
5+
weight: 40
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
### Configure the Recovery Script
13+
14+
{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}
15+
16+
### Run the Recovery Script
17+
18+
{{% alert title="Warning" color="warning" %}}
19+
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.
20+
{{% /alert %}}
21+
22+
{{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}}
23+
24+
## Preserve Installation Files
25+
26+
{{< section "/disaster-recovery/preserve-scripts.md">}}
27+
28+
## Next Steps?
29+
30+
1. [Recover Web Application Server from Scheduled Backups][]
31+
32+
[Recover Web Application Server from Scheduled Backups]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverWebApplicationServerFromBackups" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup.md

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: "Recover Encryption Key from Backup"
3+
linkTitle: "Recover Encryption Key from Backup"
4+
description: "Instructions to recover the Encryption Key from backups."
5+
weight: 30
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
{{% alert title="Warning" color="warning" %}}
13+
If recovering to new hardware, the Encryption Key must be recovered before {{% ctx %}} is installed.
14+
{{% /alert %}}
15+
16+
### Configure the Recovery Script
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.
18+
1. Configure the script according to the details given below:
19+
20+
```powershell
21+
.\Cortex.EncryptionKey.Recover.ps1 `
22+
-TargetMachines @("app-server1", "app-server2", "app-server3", "lb-server", "web-server") `
23+
-BackupPath "\\UncPath\BackupLocation" `
24+
-Credential $Credential
25+
```
26+
27+
| Name | Description |
28+
|------------------------------------------------|-------------|
29+
|`TargetMachines` | Configure the values to contain the NETBIOS name or fully qualified domain name of the application servers, the web application server and load balancer server if using the built-in load balancer.|
30+
|`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.|
31+
|`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.|
32+
33+
1. Save and close `Cortex.Innovation.EncryptionKey.Recover.ps1`.
34+
35+
### Run the Recovery Script
36+
37+
{{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}}
38+
39+
## Preserve Installation Files
40+
41+
{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}
42+
43+
## Next Steps?
44+
45+
1. [Recover Application Server from Scheduled Backup][]
46+
47+
[Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverApplicationServerFromBackup" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Recover Web Application from Scheduled Backups"
3+
linkTitle: "Recover Web Application from Scheduled Backups"
4+
description: "Instructions to recover the Web Application Server from scheduled backups."
5+
weight: 200
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
title: "Recover Flow Debugger from Scheduled Backup"
3+
linkTitle: "Recover Flow Debugger from Scheduled Backup"
4+
description: "Instructions to recover the Flow Debugger from scheduled backups."
5+
weight: 30
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
### Configure the Recovery Script
13+
14+
{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}
15+
16+
### Run the Recovery Script
17+
18+
{{% alert title="Warning" color="warning" %}}
19+
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.
20+
{{% /alert %}}
21+
22+
{{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}}
23+
24+
## Preserve Installation Files
25+
26+
{{< section "/disaster-recovery/preserve-scripts.md">}}
27+
28+
## Next Steps?
29+
30+
1. [Recover Gateway from Scheduled Backup][]
31+
32+
[Recover Gateway from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverGatewayFromBackup" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-gateway-from-backup.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: "Recover Gateway from Scheduled Backup"
3+
linkTitle: "Recover Gateway from Scheduled Backup"
4+
description: "Instructions to recover Gateway from scheduled backups."
5+
weight: 40
6+
---
7+
8+
# {{% param title %}}
9+
10+
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.
11+
12+
### Configure the Recovery Script
13+
14+
{{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}}
15+
16+
### Run the Recovery Script
17+
18+
{{% alert title="Note" %}}
19+
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.
20+
{{% /alert %}}
21+
22+
{{< section "/disaster-recovery/web-application-server/recover/run-recover-script.md">}}
23+
24+
## Preserve Installation Files
25+
26+
{{< section "/disaster-recovery/preserve-scripts.md">}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Remove Scheduled Backups"
3+
linkTitle: "Remove Scheduled Backups"
4+
description: "Instructions to remove any scheduled backups of CORTEX on multiple on-premise servers with high availability (HA)."
5+
weight: 300
6+
---

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
---
2+
title: "Remove Scheduled Backup from Application Server"
3+
linkTitle: "Remove Scheduled Backup from Application Server"
4+
description: "Instructions to remove scheduled backups from the Application Server."
5+
weight: 50
6+
---
7+
8+
# {{% param title %}}
9+
10+
This guide describes how to remove a scheduled backup from the Application Server. This will not delete any files created from the backup.
11+
12+
## Configure the Backup Script
13+
14+
{{< section "/disaster-recovery/application-server/backup/configure-remove-backup-script.md">}}
15+
16+
## Run the Backup Script
17+
18+
{{< section "/disaster-recovery/application-server/backup/run-remove-backup-script.md">}}
19+
20+
## Preserve Installation Files
21+
22+
{{< section "/disaster-recovery/preserve-scripts.md">}}
23+
24+
## Next Steps?
25+
26+
1. [Remove Scheduled Backups from Web Application Server][]
27+
28+
[Remove Scheduled Backups from Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}}

‎content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/_index.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "Remove Scheduled Backups from Web Application Server"
3+
linkTitle: "Remove Scheduled Backups from Web Application Server"
4+
description: "Instructions to remove scheduled backups from the Web Application Server."
5+
weight: 200
6+
---

0 commit comments

Comments
 (0)