Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
36fc76f
Feature/add disaster recovery guides for 2025.3
cortex-sa Apr 14, 2025
a45014a
Feature/add disaster recovery scripts and update backup configuration…
cortex-sa Apr 14, 2025
a9c0e8a
Fix typos in disaster recovery guide links and update backup script d…
cortex-sa Apr 14, 2025
9338455
Feature/add encryption key backup guides and update script paths for …
cortex-sa Apr 14, 2025
59b6da1
Feature/add backup and recovery guides for encryption key in disaster…
cortex-sa Apr 14, 2025
edb34ad
Refactor disaster recovery guides by removing outdated sections on in…
cortex-sa Apr 15, 2025
13c7a89
Feature/add encryption key backup guides for single and multiple serv…
cortex-sa Apr 15, 2025
cac5126
Remove unnecessary blank line in disaster recovery URLs configuration
cortex-sa Apr 15, 2025
9196030
Feature/add backup and recovery guides for single and multiple server…
cortex-sa Apr 16, 2025
3946914
Feature/add detailed backup and recovery instructions for encryption …
cortex-sa Apr 16, 2025
c93fbba
Fix capitalization of "Installation" in disaster recovery documentation
cortex-sa Apr 22, 2025
0d2cd35
Feature/update disaster recovery documentation for removing scheduled…
cortex-sa Apr 22, 2025
ab64eb7
Feature/update disaster recovery documentation for single and multipl…
cortex-sa Apr 22, 2025
5c6d321
Feature/update disaster recovery documentation for clarity and consis…
cortex-sa Apr 22, 2025
b17d0aa
Feature/add preserve scripts documentation for disaster recovery and …
cortex-sa Apr 22, 2025
455b1bb
Feature/add documentation for Encryption Key backup and improve consi…
cortex-sa Apr 22, 2025
490fb7f
Feature/update disaster recovery documentation to use {{% ctx %}} pla…
cortex-sa Apr 24, 2025
cb4d1e7
Feature/update disaster recovery documentation for consistency and cl…
cortex-sa Apr 24, 2025
e1ea301
Feature/update disaster recovery documentation for title consistency …
cortex-sa Apr 24, 2025
edce0bc
Feature/update disaster recovery documentation for clarity and consis…
cortex-sa Apr 29, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions content/en/docs/2025.3/Guides/disaster-recovery/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Disaster Recovery Guides"
linkTitle: "Disaster Recovery Guides"
description: "This section includes all disaster recovery guides for the {{% ctx %}} platform."
weight: 30
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Multiple Server - With HA"
linkTitle: "Multiple Server - With HA"
description: "Instructions for disaster recovery of a {{% ctx %}} platform installed on multiple on-premise servers with high availability (HA)."
weight: 50
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Backup"
linkTitle: "Backup"
description: "Instructions to backup {{% ctx %}} on multiple on-premise servers with high availability (HA)."
weight: 100
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
title: "Add Backup of Encryption Key"
linkTitle: "Add Backup of Encryption Key"
description: "Instructions to backup the Encryption Key."
weight: 30
---

# {{% param title %}}

{{< section "/disaster-recovery/encryption-key/backup/description.md">}}

## 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

{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}

## Next Steps?

1. [Add Scheduled Backup to Application Server][]

[Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
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
---

# {{% param title %}}

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

{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}}

## Run the Backup Script

{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}

## Next Steps?

1. [Add Scheduled Backups to Web Application Server][]

[Add Scheduled Backups to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupsToWebApplicationServer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
title: "Pre-Backup"
linkTitle: "Pre-Backup"
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 backup of {{% ctx %}}.

## Make Installation Artefacts Available on all Servers

{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}}

## Next Steps?

1. [Add Backup of Encryption Key][]

[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Add Scheduled Backups to Web Application Server"
linkTitle: "Add Scheduled Backups to Web Application Server"
description: "Instructions to add scheduled backups to the Web Application Server."
weight: 200
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
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
---

# {{% param title %}}

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

{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}}

## Run the Backup Script

{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}

## Next Steps?

1. [Add Scheduled Backup to Gateway][]

[Add Scheduled Backup to Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToGateway" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: "Add Scheduled Backup to Gateway"
linkTitle: "Add Scheduled Backup to Gateway"
description: "Instructions to add scheduled backups to Gateway."
weight: 40
---

# {{% param title %}}

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

{{< section "/disaster-recovery/web-application-server/backup/configure-backup-script.md">}}

## Run the Backup Script

{{< section "/disaster-recovery/web-application-server/backup/run-backup-script.md">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Recovery"
linkTitle: "Recovery"
description: "Instructions to recover {{% ctx %}} on multiple on-premise servers with high availability (HA)."
weight: 200
---
Original file line number Diff line number Diff line change
@@ -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/multi-make-installation-artefacts-available.md">}}

## Next Steps?

1. [Recover Encryption Key from Backup][]

[Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoveryEncryptionKeyFromBackup" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
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
---

# {{% param title %}}

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 Recovery Script

{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}

### Run the Recovery Script

{{% 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">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}

## Next Steps?

1. [Recover Web Application Server from Scheduled Backups][]

[Recover Web Application Server from Scheduled Backups]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverWebApplicationServerFromBackups" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
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 the built-in load balancer is used.

{{% alert title="Warning" color="warning" %}}
If recovering to new hardware, the Encryption Key must be recovered before {{% ctx %}} is installed.
{{% /alert %}}

### 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") `
-BackupPath "\\UncPath\BackupLocation" `
-Credential $Credential
```

| Name | Description |
|------------------------------------------------|-------------|
|`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.|
|`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 Recovery Script

{{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}}

## Preserve Installation Files

{{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}}

## Next Steps?

1. [Recover Application Server from Scheduled Backup][]

[Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverApplicationServerFromBackup" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
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
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
---
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
---

# {{% param title %}}

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 Recovery Script

{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}}

### Run the Recovery Script

{{% 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">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}

## Next Steps?

1. [Recover Gateway from Scheduled Backup][]

[Recover Gateway from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverGatewayFromBackup" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
---
title: "Recover Gateway from Scheduled Backup"
linkTitle: "Recover Gateway from Scheduled Backup"
description: "Instructions to recover Gateway from scheduled backups."
weight: 40
---

# {{% param title %}}

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 Recovery Script

{{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}}

### 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.
{{% /alert %}}

{{< section "/disaster-recovery/web-application-server/recover/run-recover-script.md">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "Remove Scheduled Backups"
linkTitle: "Remove Scheduled Backups"
description: "Instructions to remove any scheduled backups of CORTEX on multiple on-premise servers with high availability (HA)."
weight: 300
---
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
---
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
---

# {{% param title %}}

This guide describes how to remove a scheduled backup from the Application Server. This will not delete any files created from the backup.

## Configure the Backup Script

{{< section "/disaster-recovery/application-server/backup/configure-remove-backup-script.md">}}

## Run the Backup Script

{{< section "/disaster-recovery/application-server/backup/run-remove-backup-script.md">}}

## Preserve Installation Files

{{< section "/disaster-recovery/preserve-scripts.md">}}

## Next Steps?

1. [Remove Scheduled Backups from Web Application Server][]

[Remove Scheduled Backups from Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}}
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
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
---
Loading