From 36fc76f2a30da3528dcf3724046f789d9c6fb10d Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Mon, 14 Apr 2025 15:23:54 +0100 Subject: [PATCH 01/20] Feature/add disaster recovery guides for 2025.3 --- .../2025.3/Guides/disaster-recovery/_index.md | 6 ++ .../multiple-server-with-ha/_index.md | 12 ++++ .../application-server/_index.md | 6 ++ .../add-backup-to-application.md | 69 +++++++++++++++++++ .../recover-application-from-backup.md | 57 +++++++++++++++ .../remove-backup-from-application.md | 52 ++++++++++++++ .../pre-installation.md | 23 +++++++ .../web-application-server/_index.md | 6 ++ .../flow-debugger/_index.md | 6 ++ .../add-backup-to-flow-debugger.md | 69 +++++++++++++++++++ .../recover-flow-debugger-from-backup.md | 57 +++++++++++++++ .../remove-backup-from-flow-debugger.md | 52 ++++++++++++++ .../web-application-server/gateway/_index.md | 6 ++ .../gateway/add-backup-to-gateway.md | 67 ++++++++++++++++++ .../gateway/recover-gateway-from-backup.md | 61 ++++++++++++++++ .../gateway/remove-backup-from-gateway.md | 54 +++++++++++++++ .../single-server-without-ha/_index.md | 12 ++++ .../application-server/_index.md | 6 ++ .../add-backup-to-application.md | 69 +++++++++++++++++++ .../recover-application-from-backup.md | 57 +++++++++++++++ .../remove-backup-from-application.md | 52 ++++++++++++++ .../pre-installation.md | 23 +++++++ .../web-application-server/_index.md | 6 ++ .../add-backup-to-web-application.md | 67 ++++++++++++++++++ .../recover-web-application-from-backup.md | 61 ++++++++++++++++ .../remove-backup-from-web-application.md | 54 +++++++++++++++ .../make-installation-artefacts-available.md | 4 ++ .../make-installation-artefacts-available.md | 24 +++++++ .../make-installation-artefacts-available.md | 24 +++++++ data/urls.toml | 20 ++++++ 30 files changed, 1082 insertions(+) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/make-installation-artefacts-available.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/_index.md new file mode 100644 index 000000000..dce15ff01 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/_index.md @@ -0,0 +1,6 @@ +--- +title: "Disaster Recovery Guides" +linkTitle: "Disaster Recovery Guides" +description: "The backup and recovery process of the {{% ctx %}} platform." +weight: 30 +--- 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 new file mode 100644 index 000000000..7962032e3 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/_index.md @@ -0,0 +1,12 @@ +--- +title: "Multiple Server - With HA (Recommended)" +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." +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 new file mode 100644 index 000000000..6fad13550 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/_index.md @@ -0,0 +1,6 @@ +--- +title: "Application Server" +linkTitle: "Application Server" +description: "The backup and recovery process of the application server." +weight: 300 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md new file mode 100644 index 000000000..af34526ca --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md @@ -0,0 +1,69 @@ +--- +title: "Add Scheduled Backup To Application Server" +linkTitle: "Add Scheduled Backup To Application Server" +description: "Information about backing up the application server." +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 and the service's appsettings. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -AutoRestoreOnDataLoss $false ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -MaxIncrementalBackups 5 ` + -BackupSchedule "Weekly" ` + -BackupDays @("Monday") ` + -BackupTimes @("00:00:00") ` + -BackupPath "\\UncPath\BackupLocation" ` + -RetentionDuration "24:00:00" ` + -MinimumNumberOfBackups 1 ` + -Credential $Credential + ``` + + | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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. \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md new file mode 100644 index 000000000..4365c21aa --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md @@ -0,0 +1,57 @@ +--- +title: "Recover Application Server From Scheduled Backup" +linkTitle: "Recover Application Server From Scheduled Backup" +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. + +### Configure the Recover Script + +1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. +1. Configure the script according to the details given below: + + ```powershell + .\Cortex.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -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.

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`. + +### Run the Recover Script + +{{% alert title="Note" %}} +A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. +{{% /alert %}} + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/multiple-server-with-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md new file mode 100644 index 000000000..ca4315181 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md @@ -0,0 +1,52 @@ +--- +title: "Remove Scheduled Backup From Application Server" +linkTitle: "Remove Scheduled Backup From Application Server" +description: "Information about deleting a scheduled backup of the application server." +weight: 50 +--- + +# {{% param title %}} + +This guide describes how to delete a scheduled backup of the Application Server. This will not delete the backed up files. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -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.| + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/pre-installation.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md new file mode 100644 index 000000000..c9fd68437 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md @@ -0,0 +1,23 @@ +--- +title: "Pre-Installation" +linkTitle: "Pre-Installation" +description: "Information about the steps required to be completed prior to starting the installation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. + +## Make Installation Artefacts Available on all Servers + +{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} + +## Next Steps? + +1. [Installation][] + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Installation" >}} +[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Requirements" >}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md new file mode 100644 index 000000000..a6c64a172 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md @@ -0,0 +1,6 @@ +--- +title: "Web Application Server" +linkTitle: "Web Application Server" +description: "The backup and recovery process of the web application server." +weight: 300 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md new file mode 100644 index 000000000..5dcd8c056 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md @@ -0,0 +1,6 @@ +--- +title: "Flow Debugger" +linkTitle: "Flow Debugger" +description: "The backup and recovery process of the Flow Debugger on the web application server." +weight: 300 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md new file mode 100644 index 000000000..af34526ca --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md @@ -0,0 +1,69 @@ +--- +title: "Add Scheduled Backup To Application Server" +linkTitle: "Add Scheduled Backup To Application Server" +description: "Information about backing up the application server." +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 and the service's appsettings. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -AutoRestoreOnDataLoss $false ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -MaxIncrementalBackups 5 ` + -BackupSchedule "Weekly" ` + -BackupDays @("Monday") ` + -BackupTimes @("00:00:00") ` + -BackupPath "\\UncPath\BackupLocation" ` + -RetentionDuration "24:00:00" ` + -MinimumNumberOfBackups 1 ` + -Credential $Credential + ``` + + | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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. \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md new file mode 100644 index 000000000..7963f6ad8 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md @@ -0,0 +1,57 @@ +--- +title: "Recover Application Server From Scheduled Backup" +linkTitle: "Recover Application Server From Scheduled Backup" +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. + +### Configure the Recover Script + +1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. +1. Configure the script according to the details given below: + + ```powershell + .\Cortex.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -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.

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`. + +### Run the Recover Script + +{{% alert title="Note" %}} +A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToFlowDebugger" title="Backup Flow Debugger" >}} for further information. +{{% /alert %}} + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md new file mode 100644 index 000000000..ca4315181 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md @@ -0,0 +1,52 @@ +--- +title: "Remove Scheduled Backup From Application Server" +linkTitle: "Remove Scheduled Backup From Application Server" +description: "Information about deleting a scheduled backup of the application server." +weight: 50 +--- + +# {{% param title %}} + +This guide describes how to delete a scheduled backup of the Application Server. This will not delete the backed up files. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -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.| + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/web-application-server/gateway/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md new file mode 100644 index 000000000..c545bae64 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md @@ -0,0 +1,6 @@ +--- +title: "Gateway" +linkTitle: "Gateway" +description: "The backup and recovery process of the Gateway on the web application server." +weight: 300 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md new file mode 100644 index 000000000..7b2f05803 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md @@ -0,0 +1,67 @@ +--- +title: "Add Scheduled Backup To Web Application Server" +linkTitle: "Add Scheduled Backup To Web Application Server" +description: "Information about backing up the web application server." +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. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupTaskName "Customer1.BackupPolicy1" ` + -BackupSchedule "Weekly" ` + -BackupDay "Monday" ` + -BackupTime "00:00:00" ` + -BackupPath "\\UncPath\BackupLocation" ` + -BackupRetention 5 ` + -SiteName "Cortex" ` + -GatewayApplicationName "gateway" ` + -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 back up 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.

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`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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. \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md new file mode 100644 index 000000000..4712304ba --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md @@ -0,0 +1,61 @@ +--- +title: "Recover Web Application Server From Scheduled Backup" +linkTitle: "Recover Web Application Server From Scheduled Backup" +description: "Information about recovering the web application server." +weight: 40 +--- + +# {{% 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. + +### Configure the Recover Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -SiteName "Cortex" ` + -GatewayApplicationName "gateway" ` + -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.| + |`SiteName` | Configure this value with the name of the site that should be restored.| + |`GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored.| + |`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.

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.Recover.ps1`. + +### Run the Recover 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.AddBackupToGateway" title="Backup Gateway" >}} for further information. +{{% /alert %}} + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.Recover.ps1 + ``` + +1. Run the PowerShell command to recover the web application. +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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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 web application in the future. diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md new file mode 100644 index 000000000..be8f51f60 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md @@ -0,0 +1,54 @@ +--- +title: "Remove Scheduled Backup From Web Application Server" +linkTitle: "Remove Scheduled Backup From Web Application Server" +description: "TODO." +weight: 40 +--- + +# {{% param title %}} + +This guide describes how to delete a scheduled backup of the Web Application Server. This will not delete the backed up files. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupTaskName "Customer1.BackupPolicy1" ` + -Remove + ``` + + | Name | Description | + |------------------------------------------------|-------------| + |`BackupTaskName` | Configure this value with the unique name of the backup task that has set for the scheduled Windows task. | + |`Remove` | Parameter used to indicate that the backup task should be removed.| + +1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md new file mode 100644 index 000000000..82c0f34e4 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md @@ -0,0 +1,12 @@ +--- +title: "Single Server - Without HA" +linkTitle: "Single Server - Without HA" +description: "To Do." +weight: 50 +--- + +{{% pageinfo %}} +Single server installations without HA are not 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/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 new file mode 100644 index 000000000..6fad13550 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/_index.md @@ -0,0 +1,6 @@ +--- +title: "Application Server" +linkTitle: "Application Server" +description: "The backup and recovery process of the application server." +weight: 300 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md new file mode 100644 index 000000000..af34526ca --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md @@ -0,0 +1,69 @@ +--- +title: "Add Scheduled Backup To Application Server" +linkTitle: "Add Scheduled Backup To Application Server" +description: "Information about backing up the application server." +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 and the service's appsettings. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -AutoRestoreOnDataLoss $false ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -MaxIncrementalBackups 5 ` + -BackupSchedule "Weekly" ` + -BackupDays @("Monday") ` + -BackupTimes @("00:00:00") ` + -BackupPath "\\UncPath\BackupLocation" ` + -RetentionDuration "24:00:00" ` + -MinimumNumberOfBackups 1 ` + -Credential $Credential + ``` + + | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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. \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md new file mode 100644 index 000000000..4365c21aa --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md @@ -0,0 +1,57 @@ +--- +title: "Recover Application Server From Scheduled Backup" +linkTitle: "Recover Application Server From Scheduled Backup" +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. + +### Configure the Recover Script + +1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. +1. Configure the script according to the details given below: + + ```powershell + .\Cortex.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -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.

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`. + +### Run the Recover Script + +{{% alert title="Note" %}} +A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. +{{% /alert %}} + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md new file mode 100644 index 000000000..ca4315181 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md @@ -0,0 +1,52 @@ +--- +title: "Remove Scheduled Backup From Application Server" +linkTitle: "Remove Scheduled Backup From Application Server" +description: "Information about deleting a scheduled backup of the application server." +weight: 50 +--- + +# {{% param title %}} + +This guide describes how to delete a scheduled backup of the Application Server. This will not delete the backed up files. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -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.| + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/pre-installation.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md new file mode 100644 index 000000000..ac88a8ec4 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md @@ -0,0 +1,23 @@ +--- +title: "Pre-Disaster Recovery" +linkTitle: "Pre-Disaster Recovery" +description: "Information about the steps required to be completed prior to starting the installation." +weight: 30 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. + +## Make Installation Artefacts Available + +{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} + +## Next Steps? + +1. [Backup Application Server][] + +[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} +[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Installation" >}} +[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} +[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md new file mode 100644 index 000000000..a6c64a172 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md @@ -0,0 +1,6 @@ +--- +title: "Web Application Server" +linkTitle: "Web Application Server" +description: "The backup and recovery process of the web application server." +weight: 300 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md new file mode 100644 index 000000000..7b2f05803 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md @@ -0,0 +1,67 @@ +--- +title: "Add Scheduled Backup To Web Application Server" +linkTitle: "Add Scheduled Backup To Web Application Server" +description: "Information about backing up the web application server." +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. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupTaskName "Customer1.BackupPolicy1" ` + -BackupSchedule "Weekly" ` + -BackupDay "Monday" ` + -BackupTime "00:00:00" ` + -BackupPath "\\UncPath\BackupLocation" ` + -BackupRetention 5 ` + -SiteName "Cortex" ` + -GatewayApplicationName "gateway" ` + -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 back up 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.

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`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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. \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md new file mode 100644 index 000000000..901d5caaf --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md @@ -0,0 +1,61 @@ +--- +title: "Recover Web Application Server From Scheduled Backup" +linkTitle: "Recover Web Application Server From Scheduled Backup" +description: "Information about recovering the web application server." +weight: 40 +--- + +# {{% 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. + +### Configure the Recover Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -SiteName "Cortex" ` + -GatewayApplicationName "gateway" ` + -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.| + |`SiteName` | Configure this value with the name of the site that should be restored.| + |`GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored.| + |`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.

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.Recover.ps1`. + +### Run the Recover Script + +{{% alert title="Note" %}} +A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information. +{{% /alert %}} + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.Recover.ps1 + ``` + +1. Run the PowerShell command to recover the web application. +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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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 web application in the future. diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md new file mode 100644 index 000000000..be8f51f60 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md @@ -0,0 +1,54 @@ +--- +title: "Remove Scheduled Backup From Web Application Server" +linkTitle: "Remove Scheduled Backup From Web Application Server" +description: "TODO." +weight: 40 +--- + +# {{% param title %}} + +This guide describes how to delete a scheduled backup of the Web Application Server. This will not delete the backed up files. + +## Configure the Backup Script + +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupTaskName "Customer1.BackupPolicy1" ` + -Remove + ``` + + | Name | Description | + |------------------------------------------------|-------------| + |`BackupTaskName` | Configure this value with the unique name of the backup task that has set for the scheduled Windows task. | + |`Remove` | Parameter used to indicate that the backup task should be removed.| + +1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`. + +## Run the Backup Script + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. + +## 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/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md new file mode 100644 index 000000000..5688e0148 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md @@ -0,0 +1,4 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation 2025.3 - Web App Server Install Scripts.zip + +1. Extract the `Cortex Innovation 2025.3 - Web App Server Install Scripts.zip` file to a folder with the same name. diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md new file mode 100644 index 000000000..47cce10f5 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md @@ -0,0 +1,24 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: + + ```powershell + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/make-installation-artefacts-available.md new file mode 100644 index 000000000..47cce10f5 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/make-installation-artefacts-available.md @@ -0,0 +1,24 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: + + ```powershell + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" \ No newline at end of file diff --git a/data/urls.toml b/data/urls.toml index 094440cc5..f373e8688 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -722,6 +722,26 @@ Download = "/docs/guides/upgrade-observability/dashboards/grafana/upgrade-dashboards/#download-the-default-dashboards" UpgradeDashboards = "/docs/guides/upgrade-observability/dashboards/grafana/upgrade-dashboards" TryItOut = "/docs/guides/upgrade-observability/dashboards/grafana/try-it-out" + [Cortex.Guides.DisasterRecoveryGuides] + MainDoc = "/docs/guides/disaster-recovery/" + [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA] + AddBackupToApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application" + RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application" + RecoveryApplicationServerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup" + AddBackupToFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger" + RemoveBackupFromFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger" + RecoveryFlowDebuggerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup" + AddBackupToGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway" + RemoveBackupFromGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway" + RecoveryGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup" + + [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA] + AddBackupToApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application" + RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application" + RecoveryApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup" + AddBackupToWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application" + RemoveBackupFromWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application" + RecoveryWebApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup" [Cortex.Guides.UpgradeGuides] MainDoc = "/docs/guides/upgrade-guides/" [Cortex.Guides.UpgradeGuides.UpgradeCortex] From a45014a1488f414e82f87a2a0607acf14061beb8 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Mon, 14 Apr 2025 16:19:31 +0100 Subject: [PATCH 02/20] Feature/add disaster recovery scripts and update backup configurations for 2025.3 --- .../add-backup-to-application.md | 53 +--------------- .../recover-application-from-backup.md | 37 +---------- .../remove-backup-from-application.md | 36 +---------- .../add-backup-to-flow-debugger.md | 61 +++---------------- .../recover-flow-debugger-from-backup.md | 37 +---------- .../remove-backup-from-flow-debugger.md | 36 +---------- .../gateway/add-backup-to-gateway.md | 51 +--------------- .../gateway/recover-gateway-from-backup.md | 41 +------------ .../gateway/remove-backup-from-gateway.md | 38 +----------- .../add-backup-to-application.md | 53 +--------------- .../recover-application-from-backup.md | 37 +---------- .../remove-backup-from-application.md | 36 +---------- .../add-backup-to-web-application.md | 51 +--------------- .../recover-web-application-from-backup.md | 41 +------------ .../remove-backup-from-web-application.md | 38 +----------- .../backup/configure-backup-script.md | 32 ++++++++++ .../backup/configure-remove-backup-script.md | 16 +++++ .../backup/run-backup-script.md | 17 ++++++ .../backup/run-remove-backup-script copy.md | 19 ++++++ .../application-server/preserve-scripts.md | 1 + .../recover/configure-recover-script.md | 16 +++++ .../recover/run-recover-script.md | 17 ++++++ .../make-installation-artefacts-available.md | 4 -- .../make-installation-artefacts-available.md | 24 -------- .../backup/configure-backup-script.md | 30 +++++++++ .../backup/configure-remove-backup-script.md | 16 +++++ .../backup/run-backup-script.md | 17 ++++++ .../backup/run-remove-backup-script copy.md | 18 ++++++ .../preserve-scripts.md | 1 + .../recover/configure-recover-script.md | 20 ++++++ .../recover/run-recover-script.md | 17 ++++++ 31 files changed, 286 insertions(+), 625 deletions(-) create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-remove-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script copy.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/preserve-scripts.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/configure-recover-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/run-recover-script.md delete mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md delete mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script copy.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/configure-recover-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/run-recover-script.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md index af34526ca..bca9d997a 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md @@ -11,59 +11,12 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -AutoRestoreOnDataLoss $false ` - -BackupPolicyName "Customer1.BackupPolicy1" ` - -MaxIncrementalBackups 5 ` - -BackupSchedule "Weekly" ` - -BackupDays @("Monday") ` - -BackupTimes @("00:00:00") ` - -BackupPath "\\UncPath\BackupLocation" ` - -RetentionDuration "24:00:00" ` - -MinimumNumberOfBackups 1 ` - -Credential $Credential - ``` - - | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. +{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 between 2 to 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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. \ No newline at end of file +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md index 4365c21aa..5cfa8034d 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md @@ -11,22 +11,7 @@ This guide describes how to recover the Application Server from a backup. This w ### Configure the Recover Script -1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. -1. Configure the script according to the details given below: - - ```powershell - .\Cortex.Recover.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPath "\\UncPath\BackupLocation" ` - -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.

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`. +{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}} ### Run the Recover Script @@ -34,24 +19,8 @@ This guide describes how to recover the Application Server from a backup. This w A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. {{% /alert %}} -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 2 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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/application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md index ca4315181..2a11a789d 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md @@ -11,42 +11,12 @@ This guide describes how to delete a scheduled backup of the Application Server. ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPolicyName "Customer1.BackupPolicy1" ` - -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.| +{{< section "/disaster-recovery/application-server/backup/configure-remove-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 minute. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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. +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md index af34526ca..cd5035fc3 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md @@ -1,69 +1,22 @@ --- -title: "Add Scheduled Backup To Application Server" -linkTitle: "Add Scheduled Backup To Application Server" -description: "Information about backing up the application server." +title: "Add Scheduled Backup To Flow Debugger" +linkTitle: "Add Scheduled Backup To Flow Debugger" +description: "Information about backing up the Flow Debugger." 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 and the service's appsettings. +This guide describes how to configure a scheduled backup of the Flow Debugger. This will backup the application's reliable collections, the cluster's configuration and the service's appsettings. ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -AutoRestoreOnDataLoss $false ` - -BackupPolicyName "Customer1.BackupPolicy1" ` - -MaxIncrementalBackups 5 ` - -BackupSchedule "Weekly" ` - -BackupDays @("Monday") ` - -BackupTimes @("00:00:00") ` - -BackupPath "\\UncPath\BackupLocation" ` - -RetentionDuration "24:00:00" ` - -MinimumNumberOfBackups 1 ` - -Credential $Credential - ``` - - | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. +{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 between 2 to 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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. \ No newline at end of file +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md index 7963f6ad8..aeea5eb64 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md @@ -11,22 +11,7 @@ This guide describes how to recover the Application Server from a backup. This w ### Configure the Recover Script -1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. -1. Configure the script according to the details given below: - - ```powershell - .\Cortex.Recover.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPath "\\UncPath\BackupLocation" ` - -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.

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`. +{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}} ### Run the Recover Script @@ -34,24 +19,8 @@ This guide describes how to recover the Application Server from a backup. This w A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToFlowDebugger" title="Backup Flow Debugger" >}} for further information. {{% /alert %}} -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 2 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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/application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md index ca4315181..2a11a789d 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md @@ -11,42 +11,12 @@ This guide describes how to delete a scheduled backup of the Application Server. ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPolicyName "Customer1.BackupPolicy1" ` - -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.| +{{< section "/disaster-recovery/application-server/backup/configure-remove-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 minute. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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. +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md index 7b2f05803..e3a6fa2eb 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md @@ -11,57 +11,12 @@ This guide describes how to configure a scheduled backup of the Web Application ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Gateway.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupTaskName "Customer1.BackupPolicy1" ` - -BackupSchedule "Weekly" ` - -BackupDay "Monday" ` - -BackupTime "00:00:00" ` - -BackupPath "\\UncPath\BackupLocation" ` - -BackupRetention 5 ` - -SiteName "Cortex" ` - -GatewayApplicationName "gateway" ` - -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 back up 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.

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`. +{{< section "/disaster-recovery/web-application-server/backup/configure-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Gateway.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 between 2 to 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/web-application-server/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. \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md index 4712304ba..241a929ae 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md @@ -11,26 +11,7 @@ This guide describes how to recover the Web Application Server from a backup. Th ### Configure the Recover Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Gateway.Recover.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPath "\\UncPath\BackupLocation" ` - -SiteName "Cortex" ` - -GatewayApplicationName "gateway" ` - -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.| - |`SiteName` | Configure this value with the name of the site that should be restored.| - |`GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored.| - |`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.

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.Recover.ps1`. +{{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}} ### Run the Recover Script @@ -38,24 +19,8 @@ This guide describes how to recover the Web Application Server from a backup. Th A backup policy should be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToGateway" title="Backup Gateway" >}} for further information. {{% /alert %}} -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Gateway.Recover.ps1 - ``` - -1. Run the PowerShell command to recover the web application. -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 2 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/web-application-server/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 web application in the future. +{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md index be8f51f60..d3e86ed65 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md @@ -11,44 +11,12 @@ This guide describes how to delete a scheduled backup of the Web Application Ser ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Gateway.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupTaskName "Customer1.BackupPolicy1" ` - -Remove - ``` - - | Name | Description | - |------------------------------------------------|-------------| - |`BackupTaskName` | Configure this value with the unique name of the backup task that has set for the scheduled Windows task. | - |`Remove` | Parameter used to indicate that the backup task should be removed.| - -1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`. +{{< section "/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Gateway.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 minute. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/web-application-server/backup/run-remove-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. +{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md index af34526ca..bca9d997a 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md @@ -11,59 +11,12 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -AutoRestoreOnDataLoss $false ` - -BackupPolicyName "Customer1.BackupPolicy1" ` - -MaxIncrementalBackups 5 ` - -BackupSchedule "Weekly" ` - -BackupDays @("Monday") ` - -BackupTimes @("00:00:00") ` - -BackupPath "\\UncPath\BackupLocation" ` - -RetentionDuration "24:00:00" ` - -MinimumNumberOfBackups 1 ` - -Credential $Credential - ``` - - | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. +{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 between 2 to 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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. \ No newline at end of file +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md index 4365c21aa..5cfa8034d 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md @@ -11,22 +11,7 @@ This guide describes how to recover the Application Server from a backup. This w ### Configure the Recover Script -1. In the `Cortex Innovation 2025.3 - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. -1. Configure the script according to the details given below: - - ```powershell - .\Cortex.Recover.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPath "\\UncPath\BackupLocation" ` - -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.

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`. +{{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}} ### Run the Recover Script @@ -34,24 +19,8 @@ This guide describes how to recover the Application Server from a backup. This w A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. {{% /alert %}} -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 2 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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/application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md index ca4315181..23bad0334 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md @@ -11,42 +11,12 @@ This guide describes how to delete a scheduled backup of the Application Server. ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPolicyName "Customer1.BackupPolicy1" ` - -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.| +{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.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 minute. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/application-server/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. +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md index 7b2f05803..ec3a12be9 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md @@ -11,57 +11,12 @@ This guide describes how to configure a scheduled backup of the Web Application ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Gateway.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupTaskName "Customer1.BackupPolicy1" ` - -BackupSchedule "Weekly" ` - -BackupDay "Monday" ` - -BackupTime "00:00:00" ` - -BackupPath "\\UncPath\BackupLocation" ` - -BackupRetention 5 ` - -SiteName "Cortex" ` - -GatewayApplicationName "gateway" ` - -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 back up 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.

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`. +{{< section "/disaster-recovery/web-application-server/backup/configure-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Gateway.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 between 2 to 10 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/web-application-server/backup/configure-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. \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md index 901d5caaf..0494da4f5 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md @@ -11,26 +11,7 @@ This guide describes how to recover the Web Application Server from a backup. Th ### Configure the Recover Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Gateway.Recover.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupPath "\\UncPath\BackupLocation" ` - -SiteName "Cortex" ` - -GatewayApplicationName "gateway" ` - -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.| - |`SiteName` | Configure this value with the name of the site that should be restored.| - |`GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored.| - |`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.

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.Recover.ps1`. +{{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}} ### Run the Recover Script @@ -38,24 +19,8 @@ This guide describes how to recover the Web Application Server from a backup. Th A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information. {{% /alert %}} -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Gateway.Recover.ps1 - ``` - -1. Run the PowerShell command to recover the web application. -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 2 minutes. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/web-application-server/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 web application in the future. +{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md index be8f51f60..c5f0a36cd 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md @@ -11,44 +11,12 @@ This guide describes how to delete a scheduled backup of the Web Application Ser ## Configure the Backup Script -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. Configure the script according to the details given below: - - ```powershell - .\Cortex.Gateway.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -BackupTaskName "Customer1.BackupPolicy1" ` - -Remove - ``` - - | Name | Description | - |------------------------------------------------|-------------| - |`BackupTaskName` | Configure this value with the unique name of the backup task that has set for the scheduled Windows task. | - |`Remove` | Parameter used to indicate that the backup task should be removed.| - -1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`. +{{< section "/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md">}} ## Run the Backup Script -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: - - ```powershell - cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" - ``` - -1. Type the following command into PowerShell: - - ```powershell - .\Cortex.Innovation.Gateway.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 minute. -1. Check that there have been no errors in the script; these would appear in red in the console. +{{< section "/disaster-recovery/web-application-server/backup/run-remove-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. +{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} 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 new file mode 100644 index 000000000..1646e27ae --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-backup-script.md @@ -0,0 +1,32 @@ +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 + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -AutoRestoreOnDataLoss $false ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -MaxIncrementalBackups 5 ` + -BackupSchedule "Weekly" ` + -BackupDays @("Monday") ` + -BackupTimes @("00:00:00") ` + -BackupPath "\\UncPath\BackupLocation" ` + -RetentionDuration "24:00:00" ` + -MinimumNumberOfBackups 1 ` + -Credential $Credential + ``` + + | 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up 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.

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`. \ No newline at end of file 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 new file mode 100644 index 000000000..f21352e3b --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/configure-remove-backup-script.md @@ -0,0 +1,16 @@ +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPolicyName "Customer1.BackupPolicy1" ` + -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.| + +1. Save and close `Cortex.Innovation.Backup.ps1`. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-backup-script.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-backup-script.md new file mode 100644 index 000000000..704d977b4 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/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.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script copy.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script copy.md new file mode 100644 index 000000000..a78b28f67 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script copy.md @@ -0,0 +1,19 @@ + +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/preserve-scripts.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/preserve-scripts.md new file mode 100644 index 000000000..d8c88c35b --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/preserve-scripts.md @@ -0,0 +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, delete or configure further scheduled backups in the future. \ No newline at end of file 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 new file mode 100644 index 000000000..8162cde64 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/configure-recover-script.md @@ -0,0 +1,16 @@ +1. In the `Cortex Innovation {{< version >}} - App Server Install Scripts\Recovery` folder, locate the `Cortex.Innovation.Recover.ps1` script and open it with a text editor. +1. Configure the script according to the details given below: + + ```powershell + .\Cortex.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -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.

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`. \ No newline at end of file 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 new file mode 100644 index 000000000..05f93319a --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/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 2025.3 - 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" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md deleted file mode 100644 index 5688e0148..000000000 --- a/content/en/docs/2025.3/_shared/disaster-recovery/cortex-gateway/make-installation-artefacts-available.md +++ /dev/null @@ -1,4 +0,0 @@ -1. Copy the following artefacts to a folder on the server: - * Cortex Innovation 2025.3 - Web App Server Install Scripts.zip - -1. Extract the `Cortex Innovation 2025.3 - Web App Server Install Scripts.zip` file to a folder with the same name. diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md deleted file mode 100644 index 47cce10f5..000000000 --- a/content/en/docs/2025.3/_shared/disaster-recovery/cortex-innovation/make-installation-artefacts-available.md +++ /dev/null @@ -1,24 +0,0 @@ -1. Copy the following artefacts to a folder on the server: - * Cortex Innovation {{< version >}} - App Server Install Scripts.zip - * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip - - {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} - -1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. -1. Open a Windows PowerShell (x64) window as administrator. -1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: - - ```powershell - cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" - ``` - -1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: - - ```powershell - Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 - ``` - -1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: - - ```powershell - .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1") -WebApplicationServer "webapp-server" \ No newline at end of file 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 new file mode 100644 index 000000000..4b1adf545 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-backup-script.md @@ -0,0 +1,30 @@ +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 + .\Cortex.Gateway.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupTaskName "Customer1.BackupPolicy1" ` + -BackupSchedule "Weekly" ` + -BackupDay "Monday" ` + -BackupTime "00:00:00" ` + -BackupPath "\\UncPath\BackupLocation" ` + -BackupRetention 5 ` + -SiteName "Cortex" ` + -GatewayApplicationName "gateway" ` + -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 back up 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.

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`. \ No newline at end of file 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 new file mode 100644 index 000000000..2b2de8832 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/configure-remove-backup-script.md @@ -0,0 +1,16 @@ +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Backup.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupTaskName "Customer1.BackupPolicy1" ` + -Remove + ``` + + | Name | Description | + |------------------------------------------------|-------------| + |`BackupTaskName` | Configure this value with the unique name of the backup task that has set for the scheduled Windows task. | + |`Remove` | Parameter used to indicate that the backup task should be removed.| + +1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`. \ No newline at end of file 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 new file mode 100644 index 000000000..4a1f681d2 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/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 2025.3 - 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" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.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 between 2 to 10 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script copy.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script copy.md new file mode 100644 index 000000000..82dd1bc2d --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script copy.md @@ -0,0 +1,18 @@ +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: + + ```powershell + cd "C:\Install\Cortex Innovation 2025.3 - Web App Server Install Scripts\Recovery" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.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 minute. +1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md new file mode 100644 index 000000000..d8c88c35b --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md @@ -0,0 +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, delete or configure further scheduled backups in the future. \ No newline at end of file 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 new file mode 100644 index 000000000..ed7f9e31c --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/recover/configure-recover-script.md @@ -0,0 +1,20 @@ +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. Configure the script according to the details given below: + + ```powershell + .\Cortex.Gateway.Recover.ps1 ` + -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -BackupPath "\\UncPath\BackupLocation" ` + -SiteName "Cortex" ` + -GatewayApplicationName "gateway" ` + -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.| + |`SiteName` | Configure this value with the name of the site that should be restored.| + |`GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored.| + |`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.

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.Recover.ps1`. \ No newline at end of file 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 new file mode 100644 index 000000000..c0a390a5e --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/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 2025.3 - 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" + ``` + +1. Type the following command into PowerShell: + + ```powershell + .\Cortex.Innovation.Gateway.Recover.ps1 + ``` + +1. Run the PowerShell command to recover the web application. +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 2 minutes. +1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file From a9c0e8ae0487fe20737a596a4281bdecdc9ebebb Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Mon, 14 Apr 2025 16:24:07 +0100 Subject: [PATCH 03/20] Fix typos in disaster recovery guide links and update backup script documentation --- .../web-application-server/gateway/add-backup-to-gateway.md | 2 +- .../gateway/recover-gateway-from-backup.md | 2 +- .../gateway/remove-backup-from-gateway.md | 2 +- .../web-application-server/add-backup-to-web-application.md | 2 +- .../recover-web-application-from-backup.md | 2 +- .../remove-backup-from-web-application.md | 2 +- ...remove-backup-script copy.md => run-remove-backup-script.md} | 0 7 files changed, 6 insertions(+), 6 deletions(-) rename content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/{run-remove-backup-script copy.md => run-remove-backup-script.md} (100%) diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md index e3a6fa2eb..041241ecc 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md @@ -19,4 +19,4 @@ This guide describes how to configure a scheduled backup of the Web Application ## Preserve installation files -{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md index 241a929ae..dff1020db 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md @@ -23,4 +23,4 @@ A backup policy should be configured on the application server before running a ## Preserve installation files -{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md index d3e86ed65..aaddd9a3b 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md @@ -19,4 +19,4 @@ This guide describes how to delete a scheduled backup of the Web Application Ser ## Preserve installation files -{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md index ec3a12be9..1370f8828 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md @@ -19,4 +19,4 @@ This guide describes how to configure a scheduled backup of the Web Application ## Preserve installation files -{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md index 0494da4f5..c505e1ba0 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md @@ -23,4 +23,4 @@ A backup policy should be configured on the web application server before runnin ## Preserve installation files -{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md index c5f0a36cd..8540fbec9 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md @@ -19,4 +19,4 @@ This guide describes how to delete a scheduled backup of the Web Application Ser ## Preserve installation files -{{< section "/disaster-recovery/web-application-server/preserver-scripts.md">}} +{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script copy.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script.md similarity index 100% rename from content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script copy.md rename to content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/backup/run-remove-backup-script.md From 933845529c87bcc163f13528d8806d692c1bb93a Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Mon, 14 Apr 2025 17:06:51 +0100 Subject: [PATCH 04/20] Feature/add encryption key backup guides and update script paths for versioning --- .../multiple-server-with-ha/_index.md | 10 ++------ .../application-server/_index.md | 2 +- .../encryption key/_index.md | 6 +++++ .../encryption key/backup-encryption-key.md | 22 ++++++++++++++++ .../encryption key/recover-encryption-key.md | 25 +++++++++++++++++++ .../application-server/_index.md | 2 +- .../encryption key/_index.md | 6 +++++ .../encryption key/backup-encryption-key.md | 22 ++++++++++++++++ .../encryption key/recover-encryption-key.md | 25 +++++++++++++++++++ .../backup/configure-remove-backup-script.md | 2 +- ...pt copy.md => run-remove-backup-script.md} | 4 +-- .../recover/run-recover-script.md | 4 +-- .../backup/configure-backup-script.md | 15 +++++++++++ .../backup/run-backup-script.md | 17 +++++++++++++ .../recover/configure-recover-script.md | 17 +++++++++++++ .../recover/run-recover-script.md | 17 +++++++++++++ .../backup/configure-remove-backup-script.md | 2 +- .../backup/run-backup-script.md | 4 +-- .../backup/run-remove-backup-script.md | 4 +-- .../recover/configure-recover-script.md | 2 +- .../recover/run-recover-script.md | 4 +-- 21 files changed, 189 insertions(+), 23 deletions(-) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/backup-encryption-key.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/backup-encryption-key.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key.md rename content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/{run-remove-backup-script copy.md => run-remove-backup-script.md} (69%) create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/configure-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/run-backup-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/configure-recover-script.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/run-recover-script.md 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 index 7962032e3..3e0ac8b72 100644 --- 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 index 6fad13550..5c7a42a32 100644 --- 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 new file mode 100644 index 000000000..ffa180e07 --- /dev/null +++ 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 new file mode 100644 index 000000000..516bb23af --- /dev/null +++ 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. \ No newline at end of file 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 new file mode 100644 index 000000000..1f580c7de --- /dev/null +++ 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 index 6fad13550..5c7a42a32 100644 --- 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 new file mode 100644 index 000000000..ffa180e07 --- /dev/null +++ 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 new file mode 100644 index 000000000..516bb23af --- /dev/null +++ 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. \ No newline at end of file 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 new file mode 100644 index 000000000..1f580c7de --- /dev/null +++ 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 index f21352e3b..df82ff68b 100644 --- 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 copy.md b/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script.md similarity index 69% rename from content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script copy.md rename to content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script.md index a78b28f67..fdae8bdd3 100644 --- a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/backup/run-remove-backup-script copy.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 index 05f93319a..a30392e8c 100644 --- 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 new file mode 100644 index 000000000..57c667915 --- /dev/null +++ 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.

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`. \ No newline at end of file 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 new file mode 100644 index 000000000..ea5686251 --- /dev/null +++ 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. \ No newline at end of file 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 new file mode 100644 index 000000000..75b959857 --- /dev/null +++ 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.

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`. \ No newline at end of file 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 new file mode 100644 index 000000000..ab7d2ab5e --- /dev/null +++ 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. \ No newline at end of file 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 index 2b2de8832..7f1228b48 100644 --- 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 index 4a1f681d2..78b45e4b6 100644 --- 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 index 82dd1bc2d..ff272975a 100644 --- 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 index ed7f9e31c..afd3a9a44 100644 --- 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 index c0a390a5e..310074b5f 100644 --- 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: From 59b6da1667741f0b0be753db2888d15e22baece0 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Mon, 14 Apr 2025 17:10:13 +0100 Subject: [PATCH 05/20] Feature/add backup and recovery guides for encryption key in disaster recovery documentation --- ...up-encryption-key.md => add-backup-of-encryption-key.md} | 6 +++--- ...ryption-key.md => recover-encryption-key-from-backup.md} | 6 +++--- ...up-encryption-key.md => add-backup-of-encryption-key.md} | 6 +++--- ...ryption-key.md => recover-encryption-key-from-backup.md} | 6 +++--- 4 files changed, 12 insertions(+), 12 deletions(-) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/{backup-encryption-key.md => add-backup-of-encryption-key.md} (87%) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/{recover-encryption-key.md => recover-encryption-key-from-backup.md} (83%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/{backup-encryption-key.md => add-backup-of-encryption-key.md} (87%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/{recover-encryption-key.md => recover-encryption-key-from-backup.md} (83%) 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/add-backup-of-encryption-key.md similarity index 87% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/backup-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/add-backup-of-encryption-key.md index 516bb23af..ae2b9079f 100644 --- 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/add-backup-of-encryption-key.md @@ -1,8 +1,8 @@ --- -title: "Backup Encryption Key" -linkTitle: "Backup Encryption Key" +title: "Add Backup of Encryption Key" +linkTitle: "Add Backup of Encryption Key" description: "Information about backing up the encryption key." -weight: 40 +weight: 30 --- # {{% param title %}} 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-from-backup.md similarity index 83% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md index 1f580c7de..c6950be50 100644 --- 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-from-backup.md @@ -1,7 +1,7 @@ --- -title: "Recover Application Server" -linkTitle: "Recover Application Server" -description: "Information about recovering the application server." +title: "Recover Encryption Key From Backup" +linkTitle: "Recover Encryption Key From Backup" +description: "Information about recovering the encryption key." weight: 40 --- 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/add-backup-of-encryption-key.md similarity index 87% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/backup-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/add-backup-of-encryption-key.md index 516bb23af..ae2b9079f 100644 --- 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/add-backup-of-encryption-key.md @@ -1,8 +1,8 @@ --- -title: "Backup Encryption Key" -linkTitle: "Backup Encryption Key" +title: "Add Backup of Encryption Key" +linkTitle: "Add Backup of Encryption Key" description: "Information about backing up the encryption key." -weight: 40 +weight: 30 --- # {{% param title %}} 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-from-backup.md similarity index 83% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md index 1f580c7de..c6950be50 100644 --- 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-from-backup.md @@ -1,7 +1,7 @@ --- -title: "Recover Application Server" -linkTitle: "Recover Application Server" -description: "Information about recovering the application server." +title: "Recover Encryption Key From Backup" +linkTitle: "Recover Encryption Key From Backup" +description: "Information about recovering the encryption key." weight: 40 --- From edb34adb833fd8f2731e718304b39f8eb9e8724b Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 15 Apr 2025 13:37:06 +0100 Subject: [PATCH 06/20] Refactor disaster recovery guides by removing outdated sections on installation artifacts --- .../encryption key/recover-encryption-key-from-backup.md | 3 --- .../encryption key/recover-encryption-key-from-backup.md | 3 --- 2 files changed, 6 deletions(-) diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md index c6950be50..c7e30c628 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md @@ -9,9 +9,6 @@ weight: 40 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">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md index c6950be50..c7e30c628 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md @@ -9,9 +9,6 @@ weight: 40 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">}} From 13c7a89d1ff3eb1446e925bbd4d2bf4032afb4fa Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 15 Apr 2025 15:24:45 +0100 Subject: [PATCH 07/20] Feature/add encryption key backup guides for single and multiple server disaster recovery --- .../multiple-server-with-ha/_index.md | 2 +- .../add-backup-to-application.md | 12 +++++++++--- .../recover-application-from-backup.md | 10 ++++++++-- .../remove-backup-from-application.md | 4 ++-- .../_index.md | 0 .../add-backup-of-encryption-key.md | 8 +++++++- .../recover-encryption-key-from-backup.md | 6 ++++++ .../multiple-server-with-ha/pre-installation.md | 17 +++++++---------- .../add-backup-to-flow-debugger.md | 4 ++-- .../recover-flow-debugger-from-backup.md | 4 ++-- .../remove-backup-from-flow-debugger.md | 8 ++++---- .../gateway/add-backup-to-gateway.md | 8 ++++---- .../gateway/recover-gateway-from-backup.md | 4 ++-- .../gateway/remove-backup-from-gateway.md | 2 +- .../single-server-without-ha/_index.md | 10 ++-------- .../add-backup-to-application.md | 2 +- .../recover-application-from-backup.md | 4 ++-- .../remove-backup-from-application.md | 4 ++-- .../_index.md | 0 .../add-backup-of-encryption-key.md | 0 .../recover-encryption-key-from-backup.md | 0 .../pre-installation.md | 6 +++--- .../add-backup-to-web-application.md | 2 +- .../recover-web-application-from-backup.md | 4 ++-- .../remove-backup-from-web-application.md | 2 +- data/urls.toml | 14 +++++++++----- 26 files changed, 78 insertions(+), 59 deletions(-) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{encryption key => encryption-key}/_index.md (100%) rename content/en/docs/2025.3/Guides/disaster-recovery/{single-server-without-ha/encryption key => multiple-server-with-ha/encryption-key}/add-backup-of-encryption-key.md (75%) rename content/en/docs/2025.3/Guides/disaster-recovery/{single-server-without-ha/encryption key => multiple-server-with-ha/encryption-key}/recover-encryption-key-from-backup.md (79%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{encryption key => encryption-key}/_index.md (100%) rename content/en/docs/2025.3/Guides/disaster-recovery/{multiple-server-with-ha/encryption key => single-server-without-ha/encryption-key}/add-backup-of-encryption-key.md (100%) rename content/en/docs/2025.3/Guides/disaster-recovery/{multiple-server-with-ha/encryption key => single-server-without-ha/encryption-key}/recover-encryption-key-from-backup.md (100%) 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 index 3e0ac8b72..0899f6be1 100644 --- 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,6 +1,6 @@ --- title: "Multiple Server - With HA" linkTitle: "Multiple Server - With HA" -description: "TODO." +description: "Disaster recovery instructions for multiple on-premise servers with high availability (HA)." weight: 10 --- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md index bca9d997a..4c37ed813 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md @@ -1,13 +1,13 @@ --- title: "Add Scheduled Backup To Application Server" linkTitle: "Add Scheduled Backup To Application Server" -description: "Information about backing up the application server." +description: "Information about adding a scheduled backup to the application server." 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 and the service's appsettings. +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. ## Configure the Backup Script @@ -19,4 +19,10 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Preserve installation files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Recover Application Server From Backup][] + +[Recover Application Server From Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.RecoverApplicationServerFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md index 5cfa8034d..3b719fc1c 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/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." +description: "Information about recovering the application server from a backup." weight: 40 --- # {{% 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 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. ### Configure the Recover Script @@ -24,3 +24,9 @@ A backup policy must be configured on the application server before running a re ## Preserve installation files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Remove Backup From Application Server][] + +[Remove Backup From Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.RemoveBackupFromApplicationServer" >}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md index 2a11a789d..5ac6316d8 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md @@ -1,13 +1,13 @@ --- title: "Remove Scheduled Backup From Application Server" linkTitle: "Remove Scheduled Backup From Application Server" -description: "Information about deleting a scheduled backup of the application server." +description: "Information about remove a scheduled backup from the application server." weight: 50 --- # {{% param title %}} -This guide describes how to delete a scheduled backup of the Application Server. This will not delete the backed up files. +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 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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/_index.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/_index.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/add-backup-of-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/add-backup-of-encryption-key.md similarity index 75% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/add-backup-of-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/add-backup-of-encryption-key.md index ae2b9079f..4e58c0965 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/add-backup-of-encryption-key.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/add-backup-of-encryption-key.md @@ -19,4 +19,10 @@ 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. \ No newline at end of file +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. + +## Next Steps? + +[Recover Encryption Key from backup][] + +[Adding Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.RecoveryEncryptionKeyFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/recover-encryption-key-from-backup.md similarity index 79% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/recover-encryption-key-from-backup.md index c7e30c628..044f8ad12 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/recover-encryption-key-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/recover-encryption-key-from-backup.md @@ -20,3 +20,9 @@ This guide describes how to recover the Application Server from a backup. This w ## 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. + +## Next Steps? + +[Adding Backup to Application Server][] + +[Adding Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md index c9fd68437..828123523 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md @@ -1,13 +1,13 @@ --- -title: "Pre-Installation" -linkTitle: "Pre-Installation" -description: "Information about the steps required to be completed prior to starting the installation." -weight: 30 +title: "Pre-Disaster Recovery" +linkTitle: "Pre-Disaster Recovery" +description: "Information about the steps required to be completed prior to starting the disaster recovery process." +weight: 20 --- # {{% param title %}} -This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}. ## Make Installation Artefacts Available on all Servers @@ -15,9 +15,6 @@ This guide describes how to perform the steps required before starting the insta ## Next Steps? -1. [Installation][] +[Adding Backup of Encryption Key][] -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Installation" >}} -[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.ConfigureCortexGatewayInstallationScriptNew2" >}} -[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.MultipleServerWithHA.Requirements" >}} +[Adding Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupOfEncryptionKey" >}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md index cd5035fc3..743ced833 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md @@ -1,13 +1,13 @@ --- title: "Add Scheduled Backup To Flow Debugger" linkTitle: "Add Scheduled Backup To Flow Debugger" -description: "Information about backing up the Flow Debugger." +description: "Information about adding a scheduled backup to the Flow Debugger." weight: 40 --- # {{% param title %}} -This guide describes how to configure a scheduled backup of the Flow Debugger. 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 of 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/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md index aeea5eb64..bc1c180d5 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-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." +description: "Information about recovering the Flow Debugger from a backup." weight: 40 --- # {{% 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 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. ### Configure the Recover Script diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md index 2a11a789d..d05477eea 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md @@ -1,13 +1,13 @@ --- -title: "Remove Scheduled Backup From Application Server" -linkTitle: "Remove Scheduled Backup From Application Server" -description: "Information about deleting a scheduled backup of the application server." +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." weight: 50 --- # {{% param title %}} -This guide describes how to delete a scheduled backup of the Application Server. This will not delete the backed up files. +This guide describes how to remove a scheduled backup from the Flow Debugger. This will not delete any files created from the backup. ## Configure the Backup Script diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md index 041241ecc..54d00c47d 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md @@ -1,13 +1,13 @@ --- -title: "Add Scheduled Backup To Web Application Server" -linkTitle: "Add Scheduled Backup To Web Application Server" -description: "Information about backing up the web application server." +title: "Add Scheduled Backup To Gateway" +linkTitle: "Add Scheduled Backup To Gateway" +description: "Information about adding a scheduled backup to Gateway." 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 Gateway on the Web Application Server. This will backup the flow repositories, openApi definitions and web config file. ## Configure the Backup Script diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md index dff1020db..2a2e2167e 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md @@ -1,13 +1,13 @@ --- title: "Recover Web Application Server From Scheduled Backup" linkTitle: "Recover Web Application Server From Scheduled Backup" -description: "Information about recovering the web application server." +description: "Information about recovering Gateway from a backup." weight: 40 --- # {{% 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. +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. ### Configure the Recover Script diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md index aaddd9a3b..e4cd155d3 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/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: "TODO." +description: "Information about remove a scheduled backup from Gateway." weight: 40 --- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md index 82c0f34e4..5b46da3b5 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md @@ -1,12 +1,6 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "To Do." +description: "Disaster recovery instructions for a single on-premise server without high availability (HA)." weight: 50 ---- - -{{% pageinfo %}} -Single server installations without HA are not recommended for the following scenarios: - -* Production installations that are required to scale and support HA -{{% /pageinfo %}} +--- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md index bca9d997a..097272150 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/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 backing up the application server." +description: "Information about adding a scheduled backup to the application server." weight: 40 --- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md index 5cfa8034d..31c95cb73 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/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." +description: "Information about recovering the application server from a backup." weight: 40 --- # {{% 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 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. ### Configure the Recover Script diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md index 23bad0334..d607d764b 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md @@ -1,13 +1,13 @@ --- title: "Remove Scheduled Backup From Application Server" linkTitle: "Remove Scheduled Backup From Application Server" -description: "Information about deleting a scheduled backup of the application server." +description: "Information about remove a scheduled backup from the application server." weight: 50 --- # {{% param title %}} -This guide describes how to delete a scheduled backup of the Application Server. This will not delete the backed up files. +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 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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption key/_index.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/_index.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/add-backup-of-encryption-key.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/add-backup-of-encryption-key.md similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/add-backup-of-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/add-backup-of-encryption-key.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/recover-encryption-key-from-backup.md similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption key/recover-encryption-key-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/recover-encryption-key-from-backup.md 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 index ac88a8ec4..4c9718cc4 100644 --- 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 @@ -1,13 +1,13 @@ --- title: "Pre-Disaster Recovery" linkTitle: "Pre-Disaster Recovery" -description: "Information about the steps required to be completed prior to starting the installation." -weight: 30 +description: "Information about the steps required to be completed prior to starting the disaster recovery process." +weight: 20 --- # {{% param title %}} -This guide describes how to perform the steps required before starting the installation of {{% ctx %}}. Please ensure that the [Requirements][] have been read and met before starting this installation. +This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}. ## Make Installation Artefacts Available diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md index 1370f8828..db4de1b09 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/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 backing up the web application server." +description: "Information about adding a scheduled backup to the web application server." weight: 40 --- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md index c505e1ba0..d850a3bae 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md @@ -1,13 +1,13 @@ --- title: "Recover Web Application Server From Scheduled Backup" linkTitle: "Recover Web Application Server From Scheduled Backup" -description: "Information about recovering the web application server." +description: "Information about recovering the web application server from a backup" weight: 40 --- # {{% 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. +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. ### Configure the Recover Script diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md index 8540fbec9..bde27eed0 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md @@ -1,7 +1,7 @@ --- title: "Remove Scheduled Backup From Web Application Server" linkTitle: "Remove Scheduled Backup From Web Application Server" -description: "TODO." +description: "Information about remove a scheduled backup from the web application server." weight: 40 --- diff --git a/data/urls.toml b/data/urls.toml index f373e8688..34d803836 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -725,23 +725,27 @@ [Cortex.Guides.DisasterRecoveryGuides] MainDoc = "/docs/guides/disaster-recovery/" [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA] + AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/multiple-server-with-ha/encryption-key/add-backup-of-encryption-key" + RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/encryption-key/recover-encryption-key-from-backup" AddBackupToApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application" RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application" - RecoveryApplicationServerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup" + RecoverApplicationServerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup" AddBackupToFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger" RemoveBackupFromFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger" - RecoveryFlowDebuggerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup" + RecoverFlowDebuggerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup" AddBackupToGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway" RemoveBackupFromGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway" - RecoveryGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup" + RecoverGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup" [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA] + AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/single-server-without-ha/encryption-key/add-backup-of-encryption-key" + RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/encryption-key/recover-encryption-key-from-backup" AddBackupToApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application" RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application" - RecoveryApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup" + RecoverApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup" AddBackupToWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application" RemoveBackupFromWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application" - RecoveryWebApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup" + RecoverWebApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup" [Cortex.Guides.UpgradeGuides] MainDoc = "/docs/guides/upgrade-guides/" [Cortex.Guides.UpgradeGuides.UpgradeCortex] From cac5126fb297d8c1383583bf6775309d8d185308 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 15 Apr 2025 16:56:22 +0100 Subject: [PATCH 08/20] Remove unnecessary blank line in disaster recovery URLs configuration --- data/urls.toml | 1 - 1 file changed, 1 deletion(-) diff --git a/data/urls.toml b/data/urls.toml index 34d803836..05410dfbb 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -736,7 +736,6 @@ AddBackupToGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway" RemoveBackupFromGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway" RecoverGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup" - [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA] AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/single-server-without-ha/encryption-key/add-backup-of-encryption-key" RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/encryption-key/recover-encryption-key-from-backup" From 919603012fa4193339a7afcccdce74be9151cfc0 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Wed, 16 Apr 2025 14:01:35 +0100 Subject: [PATCH 09/20] Feature/add backup and recovery guides for single and multiple server disaster recovery --- .../multiple-server-with-ha/_index.md | 6 +-- .../application-server/_index.md | 6 --- .../multiple-server-with-ha/backup/_index.md | 6 +++ .../add-backup-of-encryption-key.md | 4 +- .../add-backup-to-application.md | 4 +- .../pre-backup.md} | 8 ++-- .../backup/web-application-server/_index.md | 6 +++ .../add-backup-to-flow-debugger.md | 10 +++- .../add-backup-to-gateway.md | 0 .../encryption-key/_index.md | 6 --- .../recovery/_index.md | 6 +++ .../recovery/pre-recovery.md | 20 ++++++++ .../recover-application-from-backup.md | 8 +++- .../recover-encryption-key-from-backup.md | 8 +++- .../recovery/web-application-server/_index.md | 6 +++ .../recover-flow-debugger-from-backup.md | 16 +++++-- .../recover-gateway-from-backup.md | 6 +-- .../multiple-server-with-ha/remove/_index.md | 6 +++ .../remove-backup-from-application.md | 0 .../remove/web-application-server/_index.md | 6 +++ .../remove-backup-from-flow-debugger.md | 0 .../remove-backup-from-gateway.md | 0 .../web-application-server/_index.md | 6 --- .../flow-debugger/_index.md | 6 --- .../web-application-server/gateway/_index.md | 6 --- .../application-server/_index.md | 6 --- .../single-server-without-ha/backup/_index.md | 6 +++ .../add-backup-of-encryption-key.md | 8 +++- .../add-backup-to-application.md | 8 +++- .../add-backup-to-web-application.md | 0 .../backup/pre-backup.md | 20 ++++++++ .../encryption-key/_index.md | 6 --- .../recovery/_index.md | 6 +++ .../recover-application-from-backup.md | 6 +-- .../recover-encryption-key-from-backup.md | 4 +- .../recover-web-application-from-backup.md | 2 +- .../single-server-without-ha/remove/_index.md | 6 +++ .../remove-backup-from-application.md | 0 .../remove-backup-from-web-application.md | 0 .../web-application-server/_index.md | 6 --- data/urls.toml | 46 +++++++++++-------- 41 files changed, 188 insertions(+), 98 deletions(-) delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{encryption-key => backup}/add-backup-of-encryption-key.md (78%) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{application-server => backup}/add-backup-to-application.md (78%) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{pre-installation.md => backup/pre-backup.md} (63%) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{web-application-server/flow-debugger => backup/web-application-server}/add-backup-to-flow-debugger.md (78%) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{web-application-server/gateway => backup/web-application-server}/add-backup-to-gateway.md (100%) delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/pre-recovery.md rename content/en/docs/2025.3/Guides/disaster-recovery/{single-server-without-ha/application-server => multiple-server-with-ha/recovery}/recover-application-from-backup.md (71%) rename content/en/docs/2025.3/Guides/disaster-recovery/{single-server-without-ha/encryption-key => multiple-server-with-ha/recovery}/recover-encryption-key-from-backup.md (75%) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{web-application-server/flow-debugger => recovery/web-application-server}/recover-flow-debugger-from-backup.md (62%) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{web-application-server/gateway => recovery/web-application-server}/recover-gateway-from-backup.md (77%) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{application-server => remove}/remove-backup-from-application.md (100%) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{web-application-server/flow-debugger => remove/web-application-server}/remove-backup-from-flow-debugger.md (100%) rename content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/{web-application-server/gateway => remove/web-application-server}/remove-backup-from-gateway.md (100%) delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{encryption-key => backup}/add-backup-of-encryption-key.md (73%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{application-server => backup}/add-backup-to-application.md (75%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{web-application-server => backup}/add-backup-to-web-application.md (100%) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/pre-backup.md delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/_index.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/{multiple-server-with-ha/application-server => single-server-without-ha/recovery}/recover-application-from-backup.md (73%) rename content/en/docs/2025.3/Guides/disaster-recovery/{multiple-server-with-ha/encryption-key => single-server-without-ha/recovery}/recover-encryption-key-from-backup.md (78%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{web-application-server => recovery}/recover-web-application-from-backup.md (86%) create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/_index.md rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{application-server => remove}/remove-backup-from-application.md (100%) rename content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/{web-application-server => remove}/remove-backup-from-web-application.md (100%) delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md 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 index 0899f6be1..3ddc859c2 100644 --- 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,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)." -weight: 10 ---- +description: "Disaster recovery instructions for a single on-premise server without high availability (HA)." +weight: 50 +--- \ No newline at end of file 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 deleted file mode 100644 index 5c7a42a32..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Application Server" -linkTitle: "Application Server" -description: "The backup and recovery process of the application server." -weight: 200 ---- 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 new file mode 100644 index 000000000..4dd20ae45 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/_index.md @@ -0,0 +1,6 @@ +--- +title: "Backup" +linkTitle: "Backup" +description: "The backup process." +weight: 100 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/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 similarity index 78% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/add-backup-of-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key.md index 4e58c0965..e2859249b 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/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 @@ -23,6 +23,6 @@ Ensure that the installation files are backed up or kept on the server, especial ## Next Steps? -[Recover Encryption Key from backup][] +[Add Scheduled Backup to Application Server][] -[Adding Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.RecoveryEncryptionKeyFromBackup" >}} \ No newline at end of file +[Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md similarity index 78% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md index 4c37ed813..b4dd8ddda 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application.md @@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Next Steps? -[Recover Application Server From Backup][] +[Add Scheduled Backups to Web Application Server][] -[Recover Application Server From Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.RecoverApplicationServerFromBackup" >}} \ No newline at end of file +[Add Scheduled Backups to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupsToWebApplicationServer" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md similarity index 63% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md index 828123523..34bf43612 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/pre-installation.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/pre-backup.md @@ -1,6 +1,6 @@ --- -title: "Pre-Disaster Recovery" -linkTitle: "Pre-Disaster Recovery" +title: "Pre-Backup" +linkTitle: "Pre-Backup" description: "Information about the steps required to be completed prior to starting the disaster recovery process." weight: 20 --- @@ -15,6 +15,6 @@ This guide describes how to perform the steps required before starting the disas ## Next Steps? -[Adding Backup of Encryption Key][] +[Add Backup of Encryption Key][] -[Adding Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupOfEncryptionKey" >}} +[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}} 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 new file mode 100644 index 000000000..4fb8bef6b --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/_index.md @@ -0,0 +1,6 @@ +--- +title: "Add Scheduled Backups to Web Application Server" +linkTitle: "Add Scheduled Backups to Web Application Server" +description: "TODO." +weight: 200 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/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 similarity index 78% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger.md index 743ced833..aa9a054a3 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/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 @@ -2,7 +2,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." -weight: 40 +weight: 30 --- # {{% param title %}} @@ -19,4 +19,10 @@ This guide describes how to configure a scheduled backup of the Flow Debugger of ## Preserve installation files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Add Scheduled Backup to Gateway][] + +[Add Scheduled Backup to Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToGateway" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-gateway.md 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 deleted file mode 100644 index ffa180e07..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -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/recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md new file mode 100644 index 000000000..3de3352df --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/_index.md @@ -0,0 +1,6 @@ +--- +title: "Recovery" +linkTitle: "Recovery" +description: "The recovery process." +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 new file mode 100644 index 000000000..c6546523a --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-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 disaster recovery process." +weight: 20 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the disaster 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.MultipleServerWithHA.Recovery.RecoveryEncryptionKeyFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md similarity index 71% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md index 31c95cb73..dff5ceb89 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md @@ -16,7 +16,7 @@ This guide describes how to recover the Application Server from a backup. This w ### Run the Recover Script {{% alert title="Note" %}} -A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. +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">}} @@ -24,3 +24,9 @@ A backup policy must be configured on the application server before running a re ## Preserve installation files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Recover Web Application Server from Scheduled Backups][] + +[Recover Web Application Server from Scheduled Backups]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverWebApplicationServerFromBackups" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/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 similarity index 75% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/recover-encryption-key-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup.md index c7e30c628..7d3930360 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/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 @@ -2,7 +2,7 @@ title: "Recover Encryption Key From Backup" linkTitle: "Recover Encryption Key From Backup" description: "Information about recovering the encryption key." -weight: 40 +weight: 30 --- # {{% param title %}} @@ -20,3 +20,9 @@ This guide describes how to recover the Application Server from a backup. This w ## 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. + +## Next Steps? + +[Recover Application Server from Scheduled Backup][] + +[Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverApplicationServerFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md new file mode 100644 index 000000000..0d850a8be --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md @@ -0,0 +1,6 @@ +--- +title: "Recover Web Application From Scheduled Backups" +linkTitle: "Recover Web Application From Scheduled Backups" +description: "TODO." +weight: 200 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/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 similarity index 62% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup.md index bc1c180d5..1c3ad4f2a 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/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,8 +1,8 @@ --- -title: "Recover Application Server From Scheduled Backup" -linkTitle: "Recover Application Server From Scheduled Backup" +title: "Recover Flow Debugger From Scheduled Backup" +linkTitle: "Recover Flow Debugger From Scheduled Backup" description: "Information about recovering the Flow Debugger from a backup." -weight: 40 +weight: 30 --- # {{% param title %}} @@ -16,11 +16,17 @@ This guide describes how to recover the Flow Debugger from a backup. This will r ### Run the Recover Script {{% alert title="Note" %}} -A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToFlowDebugger" title="Backup Flow Debugger" >}} for further information. +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 +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Recover Gateway from Scheduled Backup][] + +[Recover Gateway from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverGatewayFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/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 similarity index 77% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-gateway-from-backup.md index 2a2e2167e..9e2d71785 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/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,6 +1,6 @@ --- -title: "Recover Web Application Server From Scheduled Backup" -linkTitle: "Recover Web Application Server From Scheduled Backup" +title: "Recover Gateway From Scheduled Backup" +linkTitle: "Recover Gateway From Scheduled Backup" description: "Information about recovering Gateway from a backup." weight: 40 --- @@ -16,7 +16,7 @@ This guide describes how to recover the Gateway from a backup. This will recover ### Run the Recover 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.AddBackupToGateway" title="Backup Gateway" >}} for further information. +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">}} 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 new file mode 100644 index 000000000..cd0647a3f --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/_index.md @@ -0,0 +1,6 @@ +--- +title: "Remove Scheduled Backups" +linkTitle: "Remove Scheduled Backups" +description: "TODO." +weight: 300 +--- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application.md 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 new file mode 100644 index 000000000..0899f6be1 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/_index.md @@ -0,0 +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)." +weight: 10 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway.md rename to content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-gateway.md diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md deleted file mode 100644 index a6c64a172..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Web Application Server" -linkTitle: "Web Application Server" -description: "The backup and recovery process of the web application server." -weight: 300 ---- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md deleted file mode 100644 index 5dcd8c056..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Flow Debugger" -linkTitle: "Flow Debugger" -description: "The backup and recovery process of the Flow Debugger on the web application server." -weight: 300 ---- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md deleted file mode 100644 index c545bae64..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Gateway" -linkTitle: "Gateway" -description: "The backup and recovery process of the Gateway on the web application server." -weight: 300 ---- 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 deleted file mode 100644 index 5c7a42a32..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Application Server" -linkTitle: "Application Server" -description: "The backup and recovery process of the application server." -weight: 200 ---- 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 new file mode 100644 index 000000000..4dd20ae45 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/_index.md @@ -0,0 +1,6 @@ +--- +title: "Backup" +linkTitle: "Backup" +description: "The backup process." +weight: 100 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/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 similarity index 73% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/add-backup-of-encryption-key.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-of-encryption-key.md index ae2b9079f..fa1eea09d 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/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 @@ -19,4 +19,10 @@ 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. \ No newline at end of file +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. + +## Next Steps? + +[Add Scheduled Backup to Application Server][] + +[Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToApplicationServer" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md similarity index 75% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md index 097272150..dab4aad53 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application.md @@ -19,4 +19,10 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Preserve installation files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Add Scheduled Backup to Web Application Server][] + +[Add Scheduled Backup to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-web-application.md 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 new file mode 100644 index 000000000..34bf43612 --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/backup/pre-backup.md @@ -0,0 +1,20 @@ +--- +title: "Pre-Backup" +linkTitle: "Pre-Backup" +description: "Information about the steps required to be completed prior to starting the disaster recovery process." +weight: 20 +--- + +# {{% param title %}} + +This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}. + +## Make Installation Artefacts Available on all Servers + +{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} + +## Next Steps? + +[Add Backup of Encryption Key][] + +[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}} 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 deleted file mode 100644 index ffa180e07..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/encryption-key/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -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/recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md new file mode 100644 index 000000000..3de3352df --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/_index.md @@ -0,0 +1,6 @@ +--- +title: "Recovery" +linkTitle: "Recovery" +description: "The recovery process." +weight: 200 +--- diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md similarity index 73% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md index 3b719fc1c..e7eb3f5db 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup.md @@ -16,7 +16,7 @@ This guide describes how to recover the Application Server from a backup. This w ### Run the Recover Script {{% alert title="Note" %}} -A backup policy must be configured on the application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. +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 Backup To Application Server" >}} for further information. {{% /alert %}} {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}} @@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re ## Next Steps? -[Remove Backup From Application Server][] +[Recover Web Application Server from Scheduled Backup][] -[Remove Backup From Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.RemoveBackupFromApplicationServer" >}} +[Recover Web Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoverWebApplicationServerFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/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 similarity index 78% rename from content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/recover-encryption-key-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-encryption-key-from-backup.md index 044f8ad12..7660672ca 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/encryption-key/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 @@ -23,6 +23,6 @@ Ensure that the installation files are backed up or kept on the server, especial ## Next Steps? -[Adding Backup to Application Server][] +[Recover Application Server from Scheduled Backup][] -[Adding Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.AddBackupToApplicationServer" >}} \ No newline at end of file +[Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoverApplicationServerFromBackup" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/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 similarity index 86% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup.md rename to content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/recover-web-application-from-backup.md index d850a3bae..09cfb1d58 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/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 @@ -16,7 +16,7 @@ This guide describes how to recover the Web Application Server from a backup. Th ### Run the Recover Script {{% alert title="Note" %}} -A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information. +A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information. {{% /alert %}} {{< section "/disaster-recovery/web-application-server/recover/run-recover-script.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 new file mode 100644 index 000000000..cd0647a3f --- /dev/null +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/_index.md @@ -0,0 +1,6 @@ +--- +title: "Remove Scheduled Backups" +linkTitle: "Remove Scheduled Backups" +description: "TODO." +weight: 300 +--- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-application.md similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application.md rename to 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/web-application-server/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 similarity index 100% rename from content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application.md rename to 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/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md deleted file mode 100644 index a6c64a172..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/web-application-server/_index.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -title: "Web Application Server" -linkTitle: "Web Application Server" -description: "The backup and recovery process of the web application server." -weight: 300 ---- diff --git a/data/urls.toml b/data/urls.toml index 05410dfbb..f0f495285 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -725,26 +725,34 @@ [Cortex.Guides.DisasterRecoveryGuides] MainDoc = "/docs/guides/disaster-recovery/" [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA] - AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/multiple-server-with-ha/encryption-key/add-backup-of-encryption-key" - RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/encryption-key/recover-encryption-key-from-backup" - AddBackupToApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/add-backup-to-application" - RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/remove-backup-from-application" - RecoverApplicationServerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/application-server/recover-application-from-backup" - AddBackupToFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/add-backup-to-flow-debugger" - RemoveBackupFromFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/remove-backup-from-flow-debugger" - RecoverFlowDebuggerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/flow-debugger/recover-flow-debugger-from-backup" - AddBackupToGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/add-backup-to-gateway" - RemoveBackupFromGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/remove-backup-from-gateway" - RecoverGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/web-application-server/gateway/recover-gateway-from-backup" + [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup] + AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-of-encryption-key" + AddBackupToApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/backup/add-backup-to-application" + AddBackupsToWebApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server" + AddBackupToFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-flow-debugger" + AddBackupToGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/backup/web-application-server/add-backup-to-gateway" + [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery] + RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/recovery/recover-encryption-key-from-backup" + RecoverApplicationServerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup" + RecoverWebApplicationServerFromBackups = "/docs/guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server" + RecoverFlowDebuggerFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-flow-debugger-from-backup" + RecoverGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-gateway-from-backup" + [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove] + RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application" + RemoveBackupFromFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger" + RemoveBackupFromGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-gateway" [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA] - AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/single-server-without-ha/encryption-key/add-backup-of-encryption-key" - RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/encryption-key/recover-encryption-key-from-backup" - AddBackupToApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/add-backup-to-application" - RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/remove-backup-from-application" - RecoverApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/application-server/recover-application-from-backup" - AddBackupToWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/add-backup-to-web-application" - RemoveBackupFromWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/remove-backup-from-web-application" - RecoverWebApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/web-application-server/recover-web-application-from-backup" + [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup] + AddBackupOfEncryptionKey = "/docs/guides/disaster-recovery/single-server-without-ha/backup/add-backup-of-encryption-key" + AddBackupToApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-application" + AddBackupToWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/backup/add-backup-to-web-application" + [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery] + RecoveryEncryptionKeyFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/recovery/recover-encryption-key-from-backup" + RecoverApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/recovery/recover-application-from-backup" + RecoverWebApplicationServerFromBackup = "/docs/guides/disaster-recovery/single-server-without-ha/recovery/recover-web-application-from-backup" + [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Remove] + RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-application" + RemoveBackupFromWebApplicationServer = "/docs/guides/disaster-recovery/single-server-without-ha/remove/remove-backup-from-web-application" [Cortex.Guides.UpgradeGuides] MainDoc = "/docs/guides/upgrade-guides/" [Cortex.Guides.UpgradeGuides.UpgradeCortex] From 394691416d5ed021cf6b4139c143cedca2b6baa8 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Wed, 16 Apr 2025 16:38:34 +0100 Subject: [PATCH 10/20] Feature/add detailed backup and recovery instructions for encryption key and application servers in disaster recovery documentation --- .../multiple-server-with-ha/backup/_index.md | 2 +- .../backup/add-backup-of-encryption-key.md | 6 ++-- .../backup/add-backup-to-application.md | 2 +- .../backup/pre-backup.md | 4 +-- .../backup/web-application-server/_index.md | 2 +- .../add-backup-to-flow-debugger.md | 2 +- .../add-backup-to-gateway.md | 2 +- .../recovery/_index.md | 2 +- .../recovery/pre-recovery.md | 4 +-- .../recover-application-from-backup.md | 4 +-- .../recover-encryption-key-from-backup.md | 27 ++++++++++++++--- .../recover-flow-debugger-from-backup.md | 2 +- .../recover-gateway-from-backup.md | 4 +-- .../multiple-server-with-ha/remove/_index.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove/web-application-server/_index.md | 2 +- .../remove-backup-from-flow-debugger.md | 2 +- .../remove-backup-from-gateway.md | 2 +- .../single-server-without-ha/backup/_index.md | 2 +- .../backup/add-backup-of-encryption-key.md | 6 ++-- .../backup/add-backup-to-application.md | 2 +- .../backup/add-backup-to-web-application.md | 2 +- .../backup/pre-backup.md | 4 +-- .../pre-installation.md | 23 --------------- .../recovery/_index.md | 2 +- .../recovery/pre-recovery.md | 20 +++++++++++++ .../recover-application-from-backup.md | 2 +- .../recover-encryption-key-from-backup.md | 29 +++++++++++++++---- .../recover-web-application-from-backup.md | 2 +- .../single-server-without-ha/remove/_index.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove-backup-from-web-application.md | 4 +-- .../encryption-key/backup/description.md | 1 + .../preserve-installation-files.md | 1 + .../recover/configure-recover-script.md | 17 ----------- 35 files changed, 107 insertions(+), 87 deletions(-) delete mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md create mode 100644 content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/recovery/pre-recovery.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/description.md create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/preserve-installation-files.md delete mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/configure-recover-script.md 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 index 4dd20ae45..c9687f130 100644 --- 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 index e2859249b..ce8fac305 100644 --- 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 index b4dd8ddda..7fdeb7078 100644 --- 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 index 34bf43612..7ba655755 100644 --- 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 index 4fb8bef6b..085855920 100644 --- 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 index aa9a054a3..f232350a5 100644 --- 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 index 54d00c47d..31e7d0cba 100644 --- 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 index 3de3352df..83add03cb 100644 --- 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 index c6546523a..ad76dc879 100644 --- 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 index dff5ceb89..4f7738ac5 100644 --- 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 index 7d3930360..8071c51cd 100644 --- 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,17 +1,36 @@ --- 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.

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 @@ -19,7 +38,7 @@ This guide describes how to recover the Application Server from a backup. This w ## 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 index 1c3ad4f2a..93edd84d0 100644 --- 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 index 9e2d71785..e38669469 100644 --- 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 index cd0647a3f..b6cc3f281 100644 --- 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 --- \ No newline at end of file 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 index 5ac6316d8..b9ed32738 100644 --- 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 index 0899f6be1..e0d7d2439 100644 --- 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 index d05477eea..50f5af071 100644 --- 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 index e4cd155d3..405c987cd 100644 --- 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 index 4dd20ae45..b0ce3f78c 100644 --- 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 index fa1eea09d..113a9d312 100644 --- 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 index dab4aad53..ea0ae1bd4 100644 --- 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 index db4de1b09..23d265075 100644 --- 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 index 34bf43612..7ba655755 100644 --- 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 deleted file mode 100644 index 4c9718cc4..000000000 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/pre-installation.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: "Pre-Disaster Recovery" -linkTitle: "Pre-Disaster Recovery" -description: "Information about the steps required to be completed prior to starting the disaster recovery process." -weight: 20 ---- - -# {{% param title %}} - -This guide describes how to perform the steps required before starting the disaster recovery of {{% ctx %}}. - -## Make Installation Artefacts Available - -{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} - -## Next Steps? - -1. [Backup Application Server][] - -[CORTEX Service Portal]: {{< url path="Cortex.ServicePortal.MainDoc" >}} -[Installation]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Installation" >}} -[Installing Gateway]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.ConfigureCortexGatewayInstallationScriptNew" >}} -[Requirements]: {{< url path="Cortex.GettingStarted.OnPremise.InstallInnovationOnly.SingleServerWithoutHA.Requirements" >}} 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 index 3de3352df..74d055df8 100644 --- 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 new file mode 100644 index 000000000..b68ad98c5 --- /dev/null +++ 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" >}} \ No newline at end of file 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 index e7eb3f5db..469d8cb5b 100644 --- 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 index 7660672ca..5882a0e43 100644 --- 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 @@ -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: 40 --- # {{% 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 web application server. + +{{% 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 @("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.

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 +## 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/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 index 09cfb1d58..04c14be13 100644 --- 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 @@ -1,7 +1,7 @@ --- title: "Recover Web Application Server From Scheduled Backup" linkTitle: "Recover Web Application Server From Scheduled Backup" -description: "Information about recovering the web application server from a backup" +description: "Instructions to recover the Web Application Server from scheduled backups." weight: 40 --- 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 index cd0647a3f..db9d8083e 100644 --- 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 @@ -1,6 +1,6 @@ --- title: "Remove Scheduled Backups" linkTitle: "Remove Scheduled Backups" -description: "TODO." +description: "Instructions to remove any scheduled backups of CORTEX on a single on-premise server without high availability (HA)" weight: 300 --- \ No newline at end of file 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 index d607d764b..71e70636d 100644 --- 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 @@ -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/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 index bde27eed0..ae7189916 100644 --- 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 @@ -1,13 +1,13 @@ --- title: "Remove Scheduled Backup From Web Application Server" linkTitle: "Remove Scheduled Backup From Web Application Server" -description: "Information about remove a scheduled backup from the web application server." +description: "Instructions to remove scheduled backups from the Web Application Server." weight: 40 --- # {{% param title %}} -This guide describes how to delete a scheduled backup of the Web Application Server. This will not delete the backed up files. +This guide describes how to remove a scheduled backup from the Web Application Server. This will not delete any files created from the backup. ## Configure the Backup Script 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 new file mode 100644 index 000000000..39c27d72d --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/backup/description.md @@ -0,0 +1 @@ +This guide describes how to create a backup of the Encryption Key. \ No newline at end of file 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 new file mode 100644 index 000000000..0921dbb72 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/preserve-installation-files.md @@ -0,0 +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. \ No newline at end of file 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 deleted file mode 100644 index 75b959857..000000000 --- a/content/en/docs/2025.3/_shared/disaster-recovery/encryption-key/recover/configure-recover-script.md +++ /dev/null @@ -1,17 +0,0 @@ -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.

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`. \ No newline at end of file From c93fbba3ee3e63889a6d0b6b6779ea1f721231e5 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 22 Apr 2025 09:45:17 +0100 Subject: [PATCH 11/20] Fix capitalization of "Installation" in disaster recovery documentation --- .../backup/add-backup-of-encryption-key.md | 2 +- .../backup/add-backup-to-application.md | 2 +- .../web-application-server/add-backup-to-flow-debugger.md | 2 +- .../backup/web-application-server/add-backup-to-gateway.md | 2 +- .../recovery/recover-application-from-backup.md | 2 +- .../recovery/recover-encryption-key-from-backup.md | 2 +- .../web-application-server/recover-gateway-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove-backup-from-flow-debugger.md | 2 +- .../web-application-server/remove-backup-from-gateway.md | 2 +- .../backup/add-backup-of-encryption-key.md | 2 +- .../backup/add-backup-to-application.md | 2 +- .../backup/add-backup-to-web-application.md | 2 +- .../recovery/recover-application-from-backup.md | 2 +- .../recovery/recover-web-application-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove/remove-backup-from-web-application.md | 2 +- .../application-server/recover/run-recover-script.md | 2 +- .../encryption-key/backup/run-backup-script.md | 2 +- .../encryption-key/recover/run-recover-script.md | 2 +- .../web-application-server/backup/run-backup-script.md | 4 ++-- .../web-application-server/backup/run-remove-backup-script.md | 2 +- 22 files changed, 23 insertions(+), 23 deletions(-) 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 index ce8fac305..a02fbac64 100644 --- 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 @@ -17,7 +17,7 @@ weight: 30 {{< section "/disaster-recovery/encryption-key/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}} 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 index 7fdeb7078..d729f6c54 100644 --- 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 @@ -17,7 +17,7 @@ This guide describes how to configure a scheduled backup of the Application Serv {{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} 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 index f232350a5..4d535c339 100644 --- 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 @@ -17,7 +17,7 @@ This guide describes how to configure a scheduled backup of the Flow Debugger of {{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} 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 index 31e7d0cba..ec7e79bba 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to configure a scheduled backup of Gateway on the Web A {{< section "/disaster-recovery/web-application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file 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 index 4f7738ac5..464946f80 100644 --- 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 @@ -21,7 +21,7 @@ A backup policy must be configured on the application server before running a re {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} 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 index 8071c51cd..d08550be4 100644 --- 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 @@ -36,7 +36,7 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. {{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}} 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 index e38669469..5844e01cb 100644 --- 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 @@ -21,6 +21,6 @@ A backup policy should be configured on the application server before running a {{< section "/disaster-recovery/web-application-server/recover/run-recover-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file 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 index b9ed32738..2669cc252 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to remove a scheduled backup from the Application Serve {{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} 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 index 50f5af071..27629f4ba 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th {{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} 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 index 405c987cd..6a9806d30 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to delete a scheduled backup of the Web Application Ser {{< section "/disaster-recovery/web-application-server/backup/run-remove-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file 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 index 113a9d312..79a21562b 100644 --- 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 @@ -17,7 +17,7 @@ weight: 30 {{< section "/disaster-recovery/encryption-key/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/encryption-key/preserve-installation-files.md">}} 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 index ea0ae1bd4..e480c1078 100644 --- 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 @@ -17,7 +17,7 @@ This guide describes how to configure a scheduled backup of the Application Serv {{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} 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 index 23d265075..99769354e 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to configure a scheduled backup of the Web Application {{< section "/disaster-recovery/web-application-server/backup/configure-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file 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 index 469d8cb5b..2914e79c9 100644 --- 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 @@ -21,7 +21,7 @@ A backup policy must be configured on the application server before running a re {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.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 index 04c14be13..9e8e77cbd 100644 --- 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 @@ -21,6 +21,6 @@ A backup policy should be configured on the web application server before runnin {{< section "/disaster-recovery/web-application-server/recover/run-recover-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file 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 index 71e70636d..807e36681 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to remove a scheduled backup from the Application Serve {{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.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 index ae7189916..38cdcafb7 100644 --- 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 @@ -17,6 +17,6 @@ This guide describes how to remove a scheduled backup from the Web Application S {{< section "/disaster-recovery/web-application-server/backup/run-remove-backup-script.md">}} -## Preserve installation files +## Preserve Installation Files {{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} 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 index a30392e8c..762963b85 100644 --- 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 @@ -13,5 +13,5 @@ 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 2 minutes. +1. Wait for the script to finish running. This should take approximately 2 minute. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index ea5686251..bd961e827 100644 --- 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 @@ -13,5 +13,5 @@ 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. Wait for the script to finish running. This should take approximately 1 minute. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index ab7d2ab5e..a53c5ba8a 100644 --- 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 @@ -13,5 +13,5 @@ 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. Wait for the script to finish running. This should take approximately 1 minute. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index 78b45e4b6..effdf8095 100644 --- 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 @@ -2,7 +2,7 @@ 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 {{< version >}} - App Server Install Scripts\Recovery" + cd "C:\Install\Cortex Innovation {{< version >}} - Web App Server Install Scripts\Recovery" ``` 1. Type the following command into PowerShell: @@ -13,5 +13,5 @@ 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 between 2 to 10 minutes. +1. Wait for the script to finish running. This should take 2 to 10 minutes. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index ff272975a..5e9f27f82 100644 --- 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 @@ -14,5 +14,5 @@ 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 minute. +1. Wait for the script to finish running. This should take approximately 1 minute. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file From 0d2cd35d9ba4ce63c4f1c9eaba09de1a86d19a50 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 22 Apr 2025 11:02:53 +0100 Subject: [PATCH 12/20] Feature/update disaster recovery documentation for removing scheduled backups from web application server --- .../recovery/web-application-server/_index.md | 2 +- .../remove/remove-backup-from-application.md | 8 +++++++- .../remove/web-application-server/_index.md | 8 ++++---- .../remove-backup-from-flow-debugger.md | 8 +++++++- .../web-application-server/remove-backup-from-gateway.md | 8 ++++---- .../remove/remove-backup-from-application.md | 6 ++++++ .../application-server/backup/run-remove-backup-script.md | 2 +- data/urls.toml | 1 + 8 files changed, 31 insertions(+), 12 deletions(-) diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md index 0d850a8be..ef924ffd5 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md @@ -1,6 +1,6 @@ --- title: "Recover Web Application From Scheduled Backups" linkTitle: "Recover Web Application From Scheduled Backups" -description: "TODO." +description: "Instructions to recover the Web Application Server from scheduled backups." weight: 200 --- 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 index 2669cc252..a340a223b 100644 --- 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 @@ -15,8 +15,14 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Run the Backup Script -{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} +{{< section "/disaster-recovery/application-server/backup/run-remove-backup-script.md">}} ## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Remove Scheduled Backups From Web Application Server][] + +[Remove Scheduled Backups From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}} 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 index e0d7d2439..9cb586006 100644 --- 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: "Instructions to recover the Web Application Server from scheduled backups." -weight: 10 +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 --- 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 index 27629f4ba..8fa27b6b2 100644 --- 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 @@ -15,8 +15,14 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th ## Run the Backup Script -{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} +{{< section "/disaster-recovery/application-server/backup/run-remove-backup-script.md">}} ## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Remove Scheduled Backup From Gateway][] + +[Remove Scheduled Backup From Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}} \ No newline at end of file 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 index 6a9806d30..1b2860f72 100644 --- 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,13 +1,13 @@ --- -title: "Remove Scheduled Backup From Web Application Server" -linkTitle: "Remove Scheduled Backup From Web Application Server" +title: "Remove Scheduled Backup From Gateway" +linkTitle: "Remove Scheduled Backup From Gateway" description: "Instructions to remove scheduled backups from Gateway." -weight: 40 +weight: 50 --- # {{% param title %}} -This guide describes how to delete a scheduled backup of the Web Application Server. This will not delete the backed up files. +This guide describes how to delete a scheduled backup of Gateway. This will not delete any files created from the backup. ## Configure the Backup Script 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 index 807e36681..3fe2863bf 100644 --- 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 @@ -20,3 +20,9 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Preserve Installation Files {{< section "/disaster-recovery/application-server/preserve-scripts.md">}} + +## Next Steps? + +[Remove Scheduled Backup From Web Application Server][] + +[Remove Scheduled Backup From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Remove.RemoveBackupFromWebApplicationServer" >}} \ No newline at end of file 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 index fdae8bdd3..2eaab0e0d 100644 --- 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 @@ -15,5 +15,5 @@ 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 minute. +1. Wait for the script to finish running. This should take approximately 1 minute. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/data/urls.toml b/data/urls.toml index f0f495285..8ad95c7df 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -739,6 +739,7 @@ RecoverGatewayFromBackup = "/docs/guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/recover-gateway-from-backup" [Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove] RemoveBackupFromApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/remove-backup-from-application" + RemoveBackupsFromWebApplicationServer = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server" RemoveBackupFromFlowDebugger = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-flow-debugger" RemoveBackupFromGateway = "/docs/guides/disaster-recovery/multiple-server-with-ha/remove/web-application-server/remove-backup-from-gateway" [Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA] From ab64eb734811a3c86a41e0418702542855995d69 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 22 Apr 2025 12:20:13 +0100 Subject: [PATCH 13/20] Feature/update disaster recovery documentation for single and multiple server configurations --- .../Guides/disaster-recovery/multiple-server-with-ha/_index.md | 2 +- .../Guides/disaster-recovery/single-server-without-ha/_index.md | 2 +- .../backup/add-backup-to-web-application.md | 2 +- .../single-server-without-ha/backup/pre-backup.md | 2 +- .../recovery/recover-encryption-key-from-backup.md | 2 +- .../recovery/recover-web-application-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove/remove-backup-from-web-application.md | 2 +- 8 files changed, 8 insertions(+), 8 deletions(-) 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 index 3ddc859c2..06cee65d1 100644 --- 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,6 +1,6 @@ --- title: "Multiple Server - With HA" linkTitle: "Multiple Server - With HA" -description: "Disaster recovery instructions for a single on-premise server without high availability (HA)." +description: "Instructions for Disaster recovery of CORTEX on multiple on-premise servers with high availability (HA)." weight: 50 --- \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md index 5b46da3b5..dd83ba0ed 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md @@ -1,6 +1,6 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Disaster recovery instructions for a single on-premise server without high availability (HA)." +description: "Instructions for Disaster recovery of CORTEX on a single on-premise server without high availability (HA)." weight: 50 --- \ No newline at end of file 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 index 99769354e..93cf9214a 100644 --- 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 @@ -15,7 +15,7 @@ This guide describes how to configure a scheduled backup of the Web Application ## Run the Backup Script -{{< section "/disaster-recovery/web-application-server/backup/configure-backup-script.md">}} +{{< section "/disaster-recovery/web-application-server/backup/run-backup-script.md">}} ## Preserve Installation Files 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 index 7ba655755..2f751778d 100644 --- 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 @@ -17,4 +17,4 @@ This guide describes how to perform the steps required before starting the backu [Add Backup of Encryption Key][] -[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}} +[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupOfEncryptionKey" >}} 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 index 5882a0e43..727cbfb4a 100644 --- 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 @@ -2,7 +2,7 @@ title: "Recover Encryption Key From Backup" linkTitle: "Recover Encryption Key From Backup" description: "Instructions to recover the Encryption Key from backups." -weight: 40 +weight: 30 --- # {{% param title %}} 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 index 9e8e77cbd..448ee487d 100644 --- 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 @@ -2,7 +2,7 @@ title: "Recover Web Application Server From Scheduled Backup" linkTitle: "Recover Web Application Server From Scheduled Backup" description: "Instructions to recover the Web Application Server from scheduled backups." -weight: 40 +weight: 50 --- # {{% param title %}} 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 index 3fe2863bf..b9cdf8fc4 100644 --- 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 @@ -2,7 +2,7 @@ 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 +weight: 40 --- # {{% param title %}} 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 index 38cdcafb7..22fa70dba 100644 --- 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 @@ -2,7 +2,7 @@ title: "Remove Scheduled Backup From Web Application Server" linkTitle: "Remove Scheduled Backup From Web Application Server" description: "Instructions to remove scheduled backups from the Web Application Server." -weight: 40 +weight: 50 --- # {{% param title %}} From 5c6d321aaff97422876f371466048aa79cc20401 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 22 Apr 2025 12:28:39 +0100 Subject: [PATCH 14/20] Feature/update disaster recovery documentation for clarity and consistency in backup instructions --- content/en/docs/2025.3/Guides/disaster-recovery/_index.md | 2 +- .../backup/add-backup-of-encryption-key.md | 2 +- .../backup/add-backup-of-encryption-key.md | 2 +- .../application-server/backup/configure-backup-script.md | 2 +- .../web-application-server/backup/configure-backup-script.md | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/_index.md index dce15ff01..c6443f390 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/_index.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/_index.md @@ -1,6 +1,6 @@ --- title: "Disaster Recovery Guides" linkTitle: "Disaster Recovery Guides" -description: "The backup and recovery process of the {{% ctx %}} platform." +description: "This section includes all disaster recovery guides for the {{% ctx %}} platform." weight: 30 --- 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 index a02fbac64..d3208285b 100644 --- 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,7 +1,7 @@ --- title: "Add Backup of Encryption Key" linkTitle: "Add Backup of Encryption Key" -description: "Instructions to back up the Encryption Key." +description: "Instructions to backup the Encryption Key." weight: 30 --- 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 index 79a21562b..f00fea3d0 100644 --- 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,7 +1,7 @@ --- title: "Add Backup of Encryption Key" linkTitle: "Add Backup of Encryption Key" -description: "Instructions to back up the Encryption Key." +description: "Instructions to backup the Encryption Key." weight: 30 --- 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 index 1646e27ae..91c4d539e 100644 --- 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 @@ -23,7 +23,7 @@ |`MaxIncrementalBackups` | Configure this value with the maximum number of incremental backups to be taken between two full backups.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

 - 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 back up will run. The format of the value should be in ISO8601 format, date specified along with time will be ignored. | + |`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.| 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 index 4b1adf545..9abde785c 100644 --- 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 @@ -20,7 +20,7 @@ |`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 back up will run. The format of the value should be in ISO8601 format, date specified along with time will be ignored. | + |`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.| From b17d0aaff79ad158d603583fbc84b74f49b4712a Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 22 Apr 2025 12:40:19 +0100 Subject: [PATCH 15/20] Feature/add preserve scripts documentation for disaster recovery and update references --- .../multiple-server-with-ha/backup/add-backup-to-application.md | 2 +- .../web-application-server/add-backup-to-flow-debugger.md | 2 +- .../backup/web-application-server/add-backup-to-gateway.md | 2 +- .../recovery/recover-application-from-backup.md | 2 +- .../web-application-server/recover-flow-debugger-from-backup.md | 2 +- .../web-application-server/recover-gateway-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../web-application-server/remove-backup-from-flow-debugger.md | 2 +- .../remove/web-application-server/remove-backup-from-gateway.md | 2 +- .../backup/add-backup-to-application.md | 2 +- .../backup/add-backup-to-web-application.md | 2 +- .../recovery/recover-application-from-backup.md | 2 +- .../recovery/recover-web-application-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove/remove-backup-from-web-application.md | 2 +- .../{application-server => }/preserve-scripts.md | 2 +- .../web-application-server/preserve-scripts.md | 1 - 17 files changed, 16 insertions(+), 17 deletions(-) rename content/en/docs/2025.3/_shared/disaster-recovery/{application-server => }/preserve-scripts.md (72%) delete mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md 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 index d729f6c54..4de2398db 100644 --- 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 @@ -19,7 +19,7 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 4d535c339..9da0832d6 100644 --- 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 @@ -19,7 +19,7 @@ This guide describes how to configure a scheduled backup of the Flow Debugger of ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index ec7e79bba..c5e7b5afe 100644 --- 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 @@ -19,4 +19,4 @@ This guide describes how to configure a scheduled backup of Gateway on the Web A ## Preserve Installation Files -{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/preserve-scripts.md">}} \ No newline at end of file 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 index 464946f80..9c3d43533 100644 --- 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 @@ -23,7 +23,7 @@ A backup policy must be configured on the application server before running a re ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.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 index 93edd84d0..0a3d08a98 100644 --- 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 @@ -23,7 +23,7 @@ A backup policy must be configured on the application server before running a re ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 5844e01cb..d890c3339 100644 --- 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 @@ -23,4 +23,4 @@ A backup policy should be configured on the application server before running a ## Preserve Installation Files -{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/preserve-scripts.md">}} \ No newline at end of file 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 index a340a223b..de757fdec 100644 --- 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 @@ -19,7 +19,7 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 8fa27b6b2..850b1e91c 100644 --- 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 @@ -19,7 +19,7 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 1b2860f72..d358fb73a 100644 --- 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 @@ -19,4 +19,4 @@ This guide describes how to delete a scheduled backup of Gateway. This will not ## Preserve Installation Files -{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/preserve-scripts.md">}} \ No newline at end of file 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 index e480c1078..07475ed53 100644 --- 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 @@ -19,7 +19,7 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 93cf9214a..7a4d5fbf8 100644 --- 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 @@ -19,4 +19,4 @@ This guide describes how to configure a scheduled backup of the Web Application ## Preserve Installation Files -{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/preserve-scripts.md">}} \ No newline at end of file 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 index 2914e79c9..b04ac6455 100644 --- 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 @@ -23,7 +23,7 @@ A backup policy must be configured on the application server before running a re ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 448ee487d..e9df83538 100644 --- 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 @@ -23,4 +23,4 @@ A backup policy should be configured on the web application server before runnin ## Preserve Installation Files -{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} \ No newline at end of file +{{< section "/disaster-recovery/preserve-scripts.md">}} \ No newline at end of file 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 index b9cdf8fc4..5a799be1f 100644 --- 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 @@ -19,7 +19,7 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Preserve Installation Files -{{< section "/disaster-recovery/application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} ## Next Steps? 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 index 22fa70dba..419852ae7 100644 --- 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 @@ -19,4 +19,4 @@ This guide describes how to remove a scheduled backup from the Web Application S ## Preserve Installation Files -{{< section "/disaster-recovery/web-application-server/preserve-scripts.md">}} +{{< section "/disaster-recovery/preserve-scripts.md">}} diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/preserve-scripts.md b/content/en/docs/2025.3/_shared/disaster-recovery/preserve-scripts.md similarity index 72% rename from content/en/docs/2025.3/_shared/disaster-recovery/application-server/preserve-scripts.md rename to content/en/docs/2025.3/_shared/disaster-recovery/preserve-scripts.md index d8c88c35b..18ba55ebe 100644 --- a/content/en/docs/2025.3/_shared/disaster-recovery/application-server/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, delete or configure further scheduled backups in the future. \ No newline at end of file +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. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md b/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md deleted file mode 100644 index d8c88c35b..000000000 --- a/content/en/docs/2025.3/_shared/disaster-recovery/web-application-server/preserve-scripts.md +++ /dev/null @@ -1 +0,0 @@ -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, delete or configure further scheduled backups in the future. \ No newline at end of file From 455b1bb56ae9e1dde8ae88c1d1b661d9810fd9e5 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 22 Apr 2025 13:06:40 +0100 Subject: [PATCH 16/20] Feature/add documentation for Encryption Key backup and improve consistency in disaster recovery guides --- .../backup/add-backup-to-application.md | 2 +- .../add-backup-to-flow-debugger.md | 2 +- .../add-backup-to-gateway.md | 2 +- .../recover-application-from-backup.md | 2 +- .../recover-encryption-key-from-backup.md | 2 +- .../recover-flow-debugger-from-backup.md | 2 +- .../recover-gateway-from-backup.md | 2 +- .../backup/add-backup-to-web-application.md | 2 +- .../recover-application-from-backup.md | 2 +- .../recover-web-application-from-backup.md | 2 +- .../backup/configure-backup-script.md | 20 ++++++++--------- .../backup/configure-remove-backup-script.md | 8 +++---- .../recover/configure-recover-script.md | 8 +++---- .../application-server/recover/description.md | 1 + .../backup/configure-backup-script.md | 8 +++---- .../preserve-installation-files.md | 2 +- .../disaster-recovery/preserve-scripts.md | 2 +- .../backup/configure-backup-script.md | 22 +++++++++---------- .../backup/configure-remove-backup-script.md | 8 +++---- .../recover/configure-recover-script.md | 12 +++++----- 20 files changed, 56 insertions(+), 55 deletions(-) create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/application-server/recover/description.md 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 index 4de2398db..1ed8623fc 100644 --- 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 index 9da0832d6..9e8551f77 100644 --- 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 index c5e7b5afe..71ef66c19 100644 --- 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 index 9c3d43533..17fd0c49d 100644 --- 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 index d08550be4..53a2bd794 100644 --- 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 index 0a3d08a98..a032ac837 100644 --- 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 index d890c3339..bc0ed7dc8 100644 --- 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 index 7a4d5fbf8..c50fa1dc3 100644 --- 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 index b04ac6455..591bf8d60 100644 --- 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 index e9df83538..cbdf58e25 100644 --- 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 index 91c4d539e..57f51ba64 100644 --- 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.

This is just the upper limit.

A full backup may be taken before specified number of incremental backups are completed in one of the following conditions

 - The replica has never taken a full backup since it has become primary,

 - Some of the log records since the last backup has been truncated, or

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

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.

This is just the upper limit.

A full backup may be taken before the specified number of incremental backups are completed in one of the following conditions:

  - The replica has never taken a full backup since it became primary,

  - Some of the log records since the last backup have been truncated, or

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

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`. \ No newline at end of file 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 index df82ff68b..16346a8fe 100644 --- 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`. \ No newline at end of file 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 index 8162cde64..a3de85ccd 100644 --- 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.

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.

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`. \ No newline at end of file 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 new file mode 100644 index 000000000..39c27d72d --- /dev/null +++ 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. \ No newline at end of file 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 index 57c667915..2e3160f94 100644 --- 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.

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.

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`. \ No newline at end of file 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 index 0921dbb72..449041507 100644 --- 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. \ No newline at end of file +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. \ No newline at end of file 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 index 18ba55ebe..3963fb08e 100644 --- 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. \ No newline at end of file +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. \ No newline at end of file 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 index 9abde785c..8a0bd30b7 100644 --- 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.

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.

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`. \ No newline at end of file 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 index 7f1228b48..582176ff4 100644 --- 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 @@ -8,9 +8,9 @@ -Remove ``` - | Name | Description | - |------------------------------------------------|-------------| - |`BackupTaskName` | Configure this value with the unique name of the backup task that has set for the scheduled Windows task. | - |`Remove` | Parameter used to indicate that the backup task should be removed.| + | Name | Description | + |------------------|-------------| + | `BackupTaskName` | Configure this value with the unique name of the backup task that was set for the scheduled Windows task. | + | `Remove` | Parameter used to indicate that the backup task should be removed. | 1. Save and close `Cortex.Innovation.Gateway.Backup.ps1`. \ No newline at end of file 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 index afd3a9a44..7f2f5af76 100644 --- 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 @@ -10,11 +10,11 @@ -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.| - |`SiteName` | Configure this value with the name of the site that should be restored.| - |`GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored.| - |`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.

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. | + | `SiteName` | Configure this value with the name of the site that should be restored. | + | `GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored. | + | `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.

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.Recover.ps1`. \ No newline at end of file From 490fb7ff27352511fd4a458ffd02690d2d0f511b Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Thu, 24 Apr 2025 09:18:06 +0100 Subject: [PATCH 17/20] Feature/update disaster recovery documentation to use {{% ctx %}} placeholder for consistency --- .../multiple-server-with-ha/_index.md | 2 +- .../multiple-server-with-ha/backup/_index.md | 2 +- .../backup/add-backup-of-encryption-key.md | 2 +- .../backup/add-backup-to-application.md | 2 +- .../backup/pre-backup.md | 6 ++--- .../add-backup-to-flow-debugger.md | 2 +- .../recovery/_index.md | 2 +- .../recovery/pre-recovery.md | 4 ++-- .../recover-application-from-backup.md | 2 +- .../recover-encryption-key-from-backup.md | 2 +- .../recover-flow-debugger-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../remove-backup-from-flow-debugger.md | 2 +- .../single-server-without-ha/_index.md | 2 +- .../single-server-without-ha/backup/_index.md | 2 +- .../backup/add-backup-of-encryption-key.md | 2 +- .../backup/add-backup-to-application.md | 2 +- .../backup/pre-backup.md | 4 ++-- .../recovery/_index.md | 2 +- .../recovery/pre-recovery.md | 4 ++-- .../recover-application-from-backup.md | 2 +- .../recover-encryption-key-from-backup.md | 2 +- .../remove/remove-backup-from-application.md | 2 +- .../backup/configure-backup-script.md | 12 +++++----- .../backup/run-backup-script.md | 4 ++-- ...i-make-installation-artefacts-available.md | 24 +++++++++++++++++++ ...-make-installation-artefacts-available.md} | 0 27 files changed, 60 insertions(+), 36 deletions(-) create mode 100644 content/en/docs/2025.3/_shared/disaster-recovery/multi-make-installation-artefacts-available.md rename content/en/docs/2025.3/_shared/disaster-recovery/{make-installation-artefacts-available.md => single-make-installation-artefacts-available.md} (100%) 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 index 06cee65d1..c8e5e84eb 100644 --- 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,6 +1,6 @@ --- title: "Multiple Server - With HA" linkTitle: "Multiple Server - With HA" -description: "Instructions for Disaster recovery of CORTEX on multiple on-premise servers with high availability (HA)." +description: "Instructions for disaster recovery of a {{% ctx %}} platform installed on multiple on-premise servers with high availability (HA)." weight: 50 --- \ No newline at end of file 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 index c9687f130..43b9c8445 100644 --- 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: "Instructions to backup CORTEX on multiple on-premise servers with high availability (HA)." +description: "Instructions to backup {{% ctx %}} 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 index d3208285b..f91905f80 100644 --- 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 @@ -23,6 +23,6 @@ weight: 30 ## Next Steps? -[Add Scheduled Backup to Application Server][] +1. [Add Scheduled Backup to Application Server][] [Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToApplicationServer" >}} \ No newline at end of file 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 index 1ed8623fc..71a0bfe58 100644 --- 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 @@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Next Steps? -[Add Scheduled Backups to Web Application Server][] +1. [Add Scheduled Backups to Web Application Server][] [Add Scheduled Backups to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupsToWebApplicationServer" >}} \ No newline at end of file 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 index 7ba655755..9311d6635 100644 --- 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 @@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the backu ## Make Installation Artefacts Available on all Servers -{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} +{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}} ## Next Steps? -[Add Backup of Encryption Key][] +1. [Add Backup of Encryption Key][] -[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}} +[Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupOfEncryptionKey" >}} \ No newline at end of file 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 index 9e8551f77..ec5ffd32a 100644 --- 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 @@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Flow Debugger on ## Next Steps? -[Add Scheduled Backup to Gateway][] +1. [Add Scheduled Backup to Gateway][] [Add Scheduled Backup to Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Backup.AddBackupToGateway" >}} \ No newline at end of file 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 index 83add03cb..b35730b64 100644 --- 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: "Instructions to recover CORTEX on multiple on-premise servers with high availability (HA)." +description: "Instructions to recover {{% ctx %}} 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 index ad76dc879..b7e0730a2 100644 --- 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 @@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the recov ## Make Installation Artefacts Available on all Servers -{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} +{{< section "/disaster-recovery/multi-make-installation-artefacts-available.md">}} ## Next Steps? -[Recover Encryption Key from Backup][] +1. [Recover Encryption Key from Backup][] [Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoveryEncryptionKeyFromBackup" >}} \ No newline at end of file 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 index 17fd0c49d..2bb408a75 100644 --- 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 @@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re ## Next Steps? -[Recover Web Application Server from Scheduled Backups][] +1. [Recover Web Application Server from Scheduled Backups][] [Recover Web Application Server from Scheduled Backups]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverWebApplicationServerFromBackups" >}} \ No newline at end of file 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 index 53a2bd794..a5ac9ef92 100644 --- 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 @@ -42,6 +42,6 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. ## Next Steps? -[Recover Application Server from Scheduled Backup][] +1. [Recover Application Server from Scheduled Backup][] [Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverApplicationServerFromBackup" >}} \ No newline at end of file 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 index a032ac837..3ee052925 100644 --- 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 @@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re ## Next Steps? -[Recover Gateway from Scheduled Backup][] +1. [Recover Gateway from Scheduled Backup][] [Recover Gateway from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Recovery.RecoverGatewayFromBackup" >}} \ No newline at end of file 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 index de757fdec..5423ec0fa 100644 --- 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 @@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Next Steps? -[Remove Scheduled Backups From Web Application Server][] +1. [Remove Scheduled Backups From Web Application Server][] [Remove Scheduled Backups From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}} 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 index 850b1e91c..13a8c83cd 100644 --- 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 @@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th ## Next Steps? -[Remove Scheduled Backup From Gateway][] +1. [Remove Scheduled Backup From Gateway][] [Remove Scheduled Backup From Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}} \ No newline at end of file diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md index dd83ba0ed..547413c7b 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/single-server-without-ha/_index.md @@ -1,6 +1,6 @@ --- title: "Single Server - Without HA" linkTitle: "Single Server - Without HA" -description: "Instructions for Disaster recovery of CORTEX on a single on-premise server without high availability (HA)." +description: "Instructions for disaster recovery of a {{% ctx %}} platform installed on a single on-premise server without high availability (HA)." weight: 50 --- \ No newline at end of file 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 index b0ce3f78c..ec19b72dd 100644 --- 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: "Instructions to backup CORTEX on a single on-premise server without high availability (HA)." +description: "Instructions to backup {{% ctx %}} 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 index f00fea3d0..15dc2fec1 100644 --- 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 @@ -23,6 +23,6 @@ weight: 30 ## Next Steps? -[Add Scheduled Backup to Application Server][] +1. [Add Scheduled Backup to Application Server][] [Add Scheduled Backup to Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToApplicationServer" >}} \ No newline at end of file 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 index 07475ed53..152b258a9 100644 --- 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 @@ -23,6 +23,6 @@ This guide describes how to configure a scheduled backup of the Application Serv ## Next Steps? -[Add Scheduled Backup to Web Application Server][] +1. [Add Scheduled Backup to Web Application Server][] [Add Scheduled Backup to Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" >}} \ No newline at end of file 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 index 2f751778d..1b7d8506b 100644 --- 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 @@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the backu ## Make Installation Artefacts Available on all Servers -{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} +{{< section "/disaster-recovery/single-make-installation-artefacts-available.md">}} ## Next Steps? -[Add Backup of Encryption Key][] +1. [Add Backup of Encryption Key][] [Add Backup of Encryption Key]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupOfEncryptionKey" >}} 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 index 74d055df8..b149284ce 100644 --- 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: "Instructions to recover CORTEX on a single on-premise server without high availability (HA)." +description: "Instructions to recover {{% ctx %}} 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 index b68ad98c5..c5a88ad74 100644 --- 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 @@ -11,10 +11,10 @@ This guide describes how to perform the steps required before starting the recov ## Make Installation Artefacts Available on all Servers -{{< section "/disaster-recovery/make-installation-artefacts-available.md">}} +{{< section "/disaster-recovery/single-make-installation-artefacts-available.md">}} ## Next Steps? -[Recover Encryption Key from Backup][] +1. [Recover Encryption Key from Backup][] [Recover Encryption Key from Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoveryEncryptionKeyFromBackup" >}} \ No newline at end of file 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 index 591bf8d60..2c95a96dd 100644 --- 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 @@ -27,6 +27,6 @@ A backup policy must be configured on the application server before running a re ## Next Steps? -[Recover Web Application Server from Scheduled Backup][] +1. [Recover Web Application Server from Scheduled Backup][] [Recover Web Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoverWebApplicationServerFromBackup" >}} \ No newline at end of file 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 index 727cbfb4a..d12f5ec52 100644 --- 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 @@ -42,6 +42,6 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. ## Next Steps? -[Recover Application Server from Scheduled Backup][] +1. [Recover Application Server from Scheduled Backup][] [Recover Application Server from Scheduled Backup]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Recovery.RecoverApplicationServerFromBackup" >}} \ No newline at end of file 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 index 5a799be1f..9662e2224 100644 --- 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 @@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Next Steps? -[Remove Scheduled Backup From Web Application Server][] +1. [Remove Scheduled Backup From Web Application Server][] [Remove Scheduled Backup From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Remove.RemoveBackupFromWebApplicationServer" >}} \ No newline at end of file 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 index 57f51ba64..379268318 100644 --- 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 @@ -4,8 +4,8 @@ ```powershell .\Cortex.Backup.ps1 ` -ConfigFileName "Cortex.Application.Backup.Config.json" ` - -AutoRestoreOnDataLoss $false ` -BackupPolicyName "Customer1.BackupPolicy1" ` + -AutoRestoreOnDataLoss $false ` -MaxIncrementalBackups 5 ` -BackupSchedule "Weekly" ` -BackupDays @("Monday") ` @@ -19,13 +19,13 @@ | Name | Description | |------------------------------------------------|-------------| | `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.

This is just the upper limit.

A full backup may be taken before the specified number of incremental backups are completed in one of the following conditions:

  - The replica has never taken a full backup since it became primary,

  - Some of the log records since the last backup have been truncated, or

  - The replica passed the `MaxAccumulatedBackupLogSizeInMB` limit. | + | `AutoRestoreOnDataLoss` | This should be left as `$false`. | + | `MaxIncrementalBackups` | Configure this value with the maximum number of incremental backups to be taken between two full backups. | | `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. | + | `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 (e.g. `@("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")`). | + | `BackupTimes` | Configure this value with the times that the backup will run. The format of the value should be in ISO8601 format (e.g. `@("12:00:00", "1:15:00", "2:20:30")`). | | `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. | + | `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 (e.g. `"12:00:00"`). | | `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.

This does not need to be changed; a prompt will appear to enter this information when the script is run. | 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 index bd961e827..1a39c740d 100644 --- 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 @@ -11,7 +11,7 @@ .\Cortex.Innovation.EncryptionKey.Backup.ps1 ``` -1. Run the PowerShell command to backup the application services. +1. Run the PowerShell command to backup the Encryption Key. 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 approximately 1 minute. +1. Wait for the script to finish running. This should take seconds. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/multi-make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/multi-make-installation-artefacts-available.md new file mode 100644 index 000000000..4003c95c3 --- /dev/null +++ b/content/en/docs/2025.3/_shared/disaster-recovery/multi-make-installation-artefacts-available.md @@ -0,0 +1,24 @@ +1. Copy the following artefacts to a folder on the server: + * Cortex Innovation {{< version >}} - App Server Install Scripts.zip + * Cortex Innovation {{< version >}} - Web App Server Install Scripts.zip + + {{< alert title="Important" color="warning" >}}Only the files for the version to be installed should be in the containing folder. There should not be any other versions of the files in this folder or a subfolder.{{% /alert %}} + +1. Extract the `Cortex Innovation {{< version >}} - App Server Install Scripts.zip` file to a folder with the same name. +1. Open a Windows PowerShell (x64) window as administrator. +1. Navigate PowerShell to inside the `Cortex Innovation {{< version >}} - App Server Install Scripts` folder using the following command, modifying the path as necessary: + + ```powershell + cd "C:\Install\Cortex Innovation {{< version >}} - App Server Install Scripts" + ``` + +1. Ensure that the `Cortex.Innovation.Install.PreInstallation.ps1` script has not been blocked by the operating system by running the following command: + + ```powershell + Unblock-File -Path .\Cortex.Innovation.Install.Preinstallation.ps1 + ``` + +1. Run the `Cortex.Innovation.Install.PreInstallation.ps1` script using the following command, modifying the `ApplicationServers` and the `WebApplicationServer` values to contain the NETBIOS name or fully qualified domain name of the Server: + + ```powershell + .\Cortex.Innovation.Install.Preinstallation.ps1 -ApplicationServers @("app-server1", "app-server2", "app-server3") -WebApplicationServer "webapp-server" \ No newline at end of file diff --git a/content/en/docs/2025.3/_shared/disaster-recovery/make-installation-artefacts-available.md b/content/en/docs/2025.3/_shared/disaster-recovery/single-make-installation-artefacts-available.md similarity index 100% rename from content/en/docs/2025.3/_shared/disaster-recovery/make-installation-artefacts-available.md rename to content/en/docs/2025.3/_shared/disaster-recovery/single-make-installation-artefacts-available.md From cb4d1e72caecff1c57b53adc7a7268af19bf8e78 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Thu, 24 Apr 2025 13:49:34 +0100 Subject: [PATCH 18/20] Feature/update disaster recovery documentation for consistency and clarity in backup and recovery instructions --- .../backup/add-backup-to-application.md | 4 ++-- .../add-backup-to-flow-debugger.md | 4 ++-- .../add-backup-to-gateway.md | 4 ++-- .../recovery/recover-application-from-backup.md | 12 ++++++------ .../recover-encryption-key-from-backup.md | 16 ++++++++-------- .../recovery/web-application-server/_index.md | 4 ++-- .../recover-flow-debugger-from-backup.md | 12 ++++++------ .../recover-gateway-from-backup.md | 8 ++++---- .../remove/remove-backup-from-application.md | 8 ++++---- .../remove/web-application-server/_index.md | 4 ++-- .../remove-backup-from-flow-debugger.md | 8 ++++---- .../remove-backup-from-gateway.md | 6 +++--- .../recovery/recover-application-from-backup.md | 4 ++-- .../recover-encryption-key-from-backup.md | 4 ++-- .../recover-web-application-from-backup.md | 4 ++-- .../remove/remove-backup-from-application.md | 4 ++-- .../remove/remove-backup-from-web-application.md | 4 ++-- .../backup/configure-backup-script.md | 4 +++- .../backup/run-remove-backup-script.md | 5 ++--- .../recover/run-recover-script.md | 2 +- .../backup/configure-backup-script.md | 14 ++++++++------ .../backup/configure-remove-backup-script.md | 2 +- .../backup/run-backup-script.md | 4 ++-- .../backup/run-remove-backup-script.md | 5 ++--- .../recover/configure-recover-script.md | 6 +++--- .../recover/run-recover-script.md | 4 ++-- 26 files changed, 79 insertions(+), 77 deletions(-) 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 index 71a0bfe58..96e03ad89 100644 --- 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,6 +1,6 @@ --- -title: "Add Scheduled Backup To Application Server" -linkTitle: "Add Scheduled Backup To Application Server" +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 --- 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 index ec5ffd32a..b3665c6bf 100644 --- 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,6 +1,6 @@ --- -title: "Add Scheduled Backup To Flow Debugger" -linkTitle: "Add Scheduled Backup To Flow Debugger" +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 --- 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 index 71ef66c19..047a41cde 100644 --- 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,6 +1,6 @@ --- -title: "Add Scheduled Backup To Gateway" -linkTitle: "Add Scheduled Backup To Gateway" +title: "Add Scheduled Backup to Gateway" +linkTitle: "Add 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/recover-application-from-backup.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/recover-application-from-backup.md index 2bb408a75..2438d1d10 100644 --- 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,6 +1,6 @@ --- -title: "Recover Application Server From Scheduled Backup" -linkTitle: "Recover Application Server From Scheduled Backup" +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 --- @@ -9,14 +9,14 @@ weight: 40 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 +### Configure the Recovery Script {{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}} -### Run the Recover Script +### Run the Recovery Script -{{% alert title="Note" %}} -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 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">}} 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 index a5ac9ef92..fc0262414 100644 --- 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,25 @@ --- -title: "Recover Encryption Key From Backup" -linkTitle: "Recover Encryption Key From Backup" +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 a built-in load balancer 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 the built-in load balancer is used. {{% alert title="Warning" color="warning" %}} -The Encryption Key must be recovered before any installation of {{% ctx %}}. +If recovering to new hardware, the Encryption Key must be recovered before {{% ctx %}} is installed. {{% /alert %}} -### Configure the Recover Script +### 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") ` + -TargetMachines @("app-server1", "app-server2", "app-server3", "lb-server", "web-server") ` -BackupPath "\\UncPath\BackupLocation" ` -Credential $Credential ``` @@ -27,12 +27,12 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. | 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.| + |`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.

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 Recover Script +### Run the Recovery Script {{< section "/disaster-recovery/encryption-key/recover/run-recover-script.md">}} diff --git a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md index ef924ffd5..993e5e418 100644 --- a/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md +++ b/content/en/docs/2025.3/Guides/disaster-recovery/multiple-server-with-ha/recovery/web-application-server/_index.md @@ -1,6 +1,6 @@ --- -title: "Recover Web Application From Scheduled Backups" -linkTitle: "Recover Web Application From Scheduled Backups" +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 --- 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 index 3ee052925..3df2c727a 100644 --- 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,6 +1,6 @@ --- -title: "Recover Flow Debugger From Scheduled Backup" -linkTitle: "Recover Flow Debugger From Scheduled Backup" +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 --- @@ -9,14 +9,14 @@ weight: 30 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 +### Configure the Recovery Script {{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}} -### Run the Recover Script +### Run the Recovery Script -{{% alert title="Note" %}} -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 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">}} 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 index bc0ed7dc8..74f119a5a 100644 --- 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,6 +1,6 @@ --- -title: "Recover Gateway From Scheduled Backup" -linkTitle: "Recover Gateway From Scheduled Backup" +title: "Recover Gateway from Scheduled Backup" +linkTitle: "Recover Gateway from Scheduled Backup" description: "Instructions to recover Gateway from scheduled backups." weight: 40 --- @@ -9,11 +9,11 @@ weight: 40 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 +### Configure the Recovery Script {{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}} -### Run the Recover Script +### 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. 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 index 5423ec0fa..ee9f77c0a 100644 --- 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,6 +1,6 @@ --- -title: "Remove Scheduled Backup From Application Server" -linkTitle: "Remove Scheduled Backup From Application Server" +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 --- @@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Next Steps? -1. [Remove Scheduled Backups From Web Application Server][] +1. [Remove Scheduled Backups from Web Application Server][] -[Remove Scheduled Backups From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}} +[Remove Scheduled Backups from Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupsFromWebApplicationServer" >}} 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 index 9cb586006..37571e741 100644 --- 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: "Remove Scheduled Backups From Web Application Server" -linkTitle: "Remove Scheduled Backups From Web Application Server" +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 --- 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 index 13a8c83cd..6c2c95fa7 100644 --- 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,6 +1,6 @@ --- -title: "Remove Scheduled Backup From Flow Debugger" -linkTitle: "Remove Scheduled Backup From Flow Debugger" +title: "Remove Scheduled Backup from Flow Debugger" +linkTitle: "Remove Scheduled Backup from Flow Debugger" description: "Instructions to remove scheduled backups from the Flow Debugger." weight: 50 --- @@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Flow Debugger. Th ## Next Steps? -1. [Remove Scheduled Backup From Gateway][] +1. [Remove Scheduled Backup from Gateway][] -[Remove Scheduled Backup From Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}} \ No newline at end of file +[Remove Scheduled Backup from Gateway]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.MultipleServerWithHA.Remove.RemoveBackupFromGateway" >}} \ No newline at end of file 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 index d358fb73a..6d5552430 100644 --- 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,13 +1,13 @@ --- -title: "Remove Scheduled Backup From Gateway" -linkTitle: "Remove Scheduled Backup From Gateway" +title: "Remove Scheduled Backup from Gateway" +linkTitle: "Remove Scheduled Backup from Gateway" description: "Instructions to remove scheduled backups from Gateway." weight: 50 --- # {{% param title %}} -This guide describes how to delete a scheduled backup of Gateway. This will not delete any files created from the backup. +This guide describes how to remove a scheduled backup of Gateway. This will not delete any files created from the backup. ## 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 index 2c95a96dd..206e3a822 100644 --- 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 @@ -9,11 +9,11 @@ weight: 40 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 +### Configure the Recovery Script {{< section "/disaster-recovery/application-server/recover/configure-recover-script.md">}} -### Run the Recover Script +### Run the Recovery Script {{% alert title="Note" %}} 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 Backup To Application Server" >}} for further information. 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 index d12f5ec52..93328fee6 100644 --- 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 @@ -13,7 +13,7 @@ This guide describes how to recover the Encryption Key from a backup. This will The Encryption Key must be recovered before any installation of {{% ctx %}}. {{% /alert %}} -### Configure the Recover Script +### 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: @@ -32,7 +32,7 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. 1. Save and close `Cortex.Innovation.EncryptionKey.Recover.ps1`. -### Run the Recover Script +### Run the Recovery Script {{< section "/disaster-recovery/encryption-key/recover/run-recover-script.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 index cbdf58e25..fe0e63a97 100644 --- 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 @@ -9,11 +9,11 @@ weight: 50 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 +### Configure the Recovery Script {{< section "/disaster-recovery/web-application-server/recover/configure-recover-script.md">}} -### Run the Recover Script +### Run the Recovery Script {{% alert title="Note" %}} A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information. 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 index 9662e2224..2355b556b 100644 --- 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 @@ -1,6 +1,6 @@ --- -title: "Remove Scheduled Backup From Application Server" -linkTitle: "Remove Scheduled Backup From Application Server" +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: 40 --- 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 index 419852ae7..e2851c924 100644 --- 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 @@ -1,6 +1,6 @@ --- -title: "Remove Scheduled Backup From Web Application Server" -linkTitle: "Remove Scheduled Backup From Web Application Server" +title: "Remove Scheduled Backup from Web Application Server" +linkTitle: "Remove Scheduled Backup from Web Application Server" description: "Instructions to remove scheduled backups from the Web Application Server." weight: 50 --- 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 index 379268318..93621d594 100644 --- 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 @@ -24,7 +24,9 @@ | `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 (e.g. `@("Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday", "Sunday")`). | | `BackupTimes` | Configure this value with the times that the backup will run. The format of the value should be in ISO8601 format (e.g. `@("12:00:00", "1:15:00", "2:20:30")`). | - | `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. | + | `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. {{% alert title="Warning" color="warning" %}} +This location must not be the same as any other scheduled Application Server or Flow Debugger backup. +{{% /alert %}} | | `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 (e.g. `"12:00:00"`). | | `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.

This does not need to be changed; a prompt will appear to enter this information when the script is run. | 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 index 2eaab0e0d..ebc680a62 100644 --- 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,5 +1,4 @@ -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 {{< version >}} - App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary: @@ -13,7 +12,7 @@ .\Cortex.Innovation.Backup.ps1 ``` -1. Run the PowerShell command to backup the application services. +1. Run the PowerShell command to remove the scheduled backup for 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 approximately 1 minute. +1. Wait for the script to finish running. This should take seconds. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index 762963b85..871c1bd67 100644 --- 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 @@ -13,5 +13,5 @@ 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 approximately 2 minute. +1. Wait for the script to finish running. This could take some time depending on the size of the reliable collections. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index 8a0bd30b7..08ce5e6cc 100644 --- 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 @@ -3,7 +3,7 @@ ```powershell .\Cortex.Gateway.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -ConfigFileName "Cortex.Gateway.Backup.Config.json" ` -BackupTaskName "Customer1.BackupPolicy1" ` -BackupSchedule "Weekly" ` -BackupDay "Monday" ` @@ -19,12 +19,14 @@ |----------------------------|-------------| | `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. | + | `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 (e.g. `"Monday"`). | + | `BackupTime` | Configure this value with the time that the backup will run. The format of the value should be in ISO8601 format (e.g. `"12:00:00"`). | + | `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. {{% alert title="Warning" color="warning" %}} +This location must not be the same as any other scheduled Gateway backup. +{{% /alert %}} | | `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. | + | `SiteName` | Configure this value with the name of the site in IIS that should be backed up. | + | `GatewayApplicationName` | Configure this value with the name of the application under the specified `SiteName` in IIS 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.

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`. \ No newline at end of file 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 index 582176ff4..983e82b3d 100644 --- 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 @@ -3,7 +3,7 @@ ```powershell .\Cortex.Gateway.Backup.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -ConfigFileName "Cortex.Gateway.Backup.Config.json" ` -BackupTaskName "Customer1.BackupPolicy1" ` -Remove ``` 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 index effdf8095..534f8375e 100644 --- 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 @@ -11,7 +11,7 @@ .\Cortex.Innovation.Gateway.Backup.ps1 ``` -1. Run the PowerShell command to backup the application services. +1. Run the PowerShell command to backup Gateway. 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 2 to 10 minutes. +1. Wait for the script to finish running. This could take some time depending on the size of the repositories. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index 5e9f27f82..43c22fd34 100644 --- 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,4 +1,3 @@ -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 {{< version >}} - Web App Server Install Scripts\Recovery` folder using the following command, modifying the path as necessary: @@ -12,7 +11,7 @@ .\Cortex.Innovation.Gateway.Backup.ps1 ``` -1. Run the PowerShell command to backup the application services. +1. Run the PowerShell command to remove the scheduled backup for Gateway. 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 approximately 1 minute. +1. Wait for the script to finish running. This should take seconds. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file 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 index 7f2f5af76..395161e47 100644 --- 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 @@ -3,7 +3,7 @@ ```powershell .\Cortex.Gateway.Recover.ps1 ` - -ConfigFileName "Cortex.Application.Backup.Config.json" ` + -ConfigFileName "Cortex.Gateway.Backup.Config.json" ` -BackupPath "\\UncPath\BackupLocation" ` -SiteName "Cortex" ` -GatewayApplicationName "gateway" ` @@ -13,8 +13,8 @@ | 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. | - | `SiteName` | Configure this value with the name of the site that should be restored. | - | `GatewayApplicationName` | Configure this value with the name of the application under the specified site that should be restored. | + | `SiteName` | Configure this value with the name of the site in IIS that should be restored. | + | `GatewayApplicationName` | Configure this value with the name of the application under the specified `SiteName` in IIS that should be restored. | | `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.

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.Recover.ps1`. \ No newline at end of file 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 index 310074b5f..c11f6f396 100644 --- 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 @@ -11,7 +11,7 @@ .\Cortex.Innovation.Gateway.Recover.ps1 ``` -1. Run the PowerShell command to recover the web application. +1. Run the PowerShell command to recover Gateway. 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 2 minutes. +1. Wait for the script to finish running. This could take some time depending on the size of the flow repositories. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file From e1ea3010f1579cb15002f119dffacfe490d20ec8 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Thu, 24 Apr 2025 15:05:54 +0100 Subject: [PATCH 19/20] Feature/update disaster recovery documentation for title consistency and clarity in backup and recovery instructions --- .../backup/add-backup-to-application.md | 4 ++-- .../backup/add-backup-to-web-application.md | 4 ++-- .../recovery/recover-application-from-backup.md | 8 ++++---- .../recovery/recover-encryption-key-from-backup.md | 8 ++++---- .../recovery/recover-web-application-from-backup.md | 4 ++-- .../remove/remove-backup-from-application.md | 8 ++++---- 6 files changed, 18 insertions(+), 18 deletions(-) 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 index 152b258a9..9d3751ab6 100644 --- 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,6 +1,6 @@ --- -title: "Add Scheduled Backup To Application Server" -linkTitle: "Add Scheduled Backup To Application Server" +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 --- 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 index c50fa1dc3..14d2a17c9 100644 --- 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,6 +1,6 @@ --- -title: "Add Scheduled Backup To Web Application Server" -linkTitle: "Add Scheduled Backup To Web Application Server" +title: "Add Scheduled Backup to Web Application Server" +linkTitle: "Add Scheduled Backup to 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/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 index 206e3a822..cc4cfc5c0 100644 --- 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,6 +1,6 @@ --- -title: "Recover Application Server From Scheduled Backup" -linkTitle: "Recover Application Server From Scheduled Backup" +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 --- @@ -15,8 +15,8 @@ This guide describes how to recover the Application Server from a backup. This w ### Run the Recovery Script -{{% alert title="Note" %}} -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 Backup To Application Server" >}} for further information. +{{% 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.SingleServerWithoutHA.Backup.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. {{% /alert %}} {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}} 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 index 93328fee6..ed8d24fba 100644 --- 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 @@ -1,6 +1,6 @@ --- -title: "Recover Encryption Key From Backup" -linkTitle: "Recover Encryption Key From Backup" +title: "Recover Encryption Key from Backup" +linkTitle: "Recover Encryption Key from Backup" description: "Instructions to recover the Encryption Key from backups." weight: 30 --- @@ -26,8 +26,8 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. | 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.| + |`TargetMachines` | Configure the value with the name of the web application server.| + |`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.

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/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 index fe0e63a97..6f62d9bc0 100644 --- 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 @@ -1,6 +1,6 @@ --- -title: "Recover Web Application Server From Scheduled Backup" -linkTitle: "Recover Web Application Server From Scheduled Backup" +title: "Recover Web Application Server from Scheduled Backup" +linkTitle: "Recover Web Application Server from Scheduled Backup" description: "Instructions to recover the Web Application Server from scheduled backups." weight: 50 --- 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 index 2355b556b..729922672 100644 --- 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 @@ -11,11 +11,11 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Configure the Backup Script -{{< section "/disaster-recovery/application-server/backup/configure-backup-script.md">}} +{{< section "/disaster-recovery/application-server/backup/configure-remove-backup-script.md">}} ## Run the Backup Script -{{< section "/disaster-recovery/application-server/backup/run-backup-script.md">}} +{{< section "/disaster-recovery/application-server/backup/run-remove-backup-script.md">}} ## Preserve Installation Files @@ -23,6 +23,6 @@ This guide describes how to remove a scheduled backup from the Application Serve ## Next Steps? -1. [Remove Scheduled Backup From Web Application Server][] +1. [Remove Scheduled Backup from Web Application Server][] -[Remove Scheduled Backup From Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Remove.RemoveBackupFromWebApplicationServer" >}} \ No newline at end of file +[Remove Scheduled Backup from Web Application Server]: {{< url path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Remove.RemoveBackupFromWebApplicationServer" >}} \ No newline at end of file From edce0bc615acd97ccbd8e3faa41e149ec8f19879 Mon Sep 17 00:00:00 2001 From: "sam.abley" Date: Tue, 29 Apr 2025 15:53:18 +0100 Subject: [PATCH 20/20] Feature/update disaster recovery documentation for clarity and consistency in recovery instructions --- .../recovery/recover-encryption-key-from-backup.md | 2 +- .../single-server-without-ha/backup/pre-backup.md | 2 +- .../single-server-without-ha/recovery/pre-recovery.md | 2 +- .../recovery/recover-application-from-backup.md | 2 +- .../recovery/recover-encryption-key-from-backup.md | 4 ++-- .../recovery/recover-web-application-from-backup.md | 2 +- .../encryption-key/recover/run-recover-script.md | 2 +- 7 files changed, 8 insertions(+), 8 deletions(-) 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 index fc0262414..b90e635c3 100644 --- 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 @@ -26,7 +26,7 @@ If recovering to new hardware, the Encryption Key must be recovered before {{% c | 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.| + |`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.

This does not need to be changed, a prompt will appear to enter this information when the script is run.| 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 index 1b7d8506b..c2b8ca659 100644 --- 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 @@ -9,7 +9,7 @@ weight: 20 This guide describes how to perform the steps required before starting the backup of {{% ctx %}}. -## Make Installation Artefacts Available on all Servers +## Make Installation Artefacts Available {{< section "/disaster-recovery/single-make-installation-artefacts-available.md">}} 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 index c5a88ad74..b485f3b5a 100644 --- 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 @@ -9,7 +9,7 @@ weight: 20 This guide describes how to perform the steps required before starting the recovery of {{% ctx %}}. -## Make Installation Artefacts Available on all Servers +## Make Installation Artefacts Available {{< section "/disaster-recovery/single-make-installation-artefacts-available.md">}} 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 index cc4cfc5c0..6c172ac1b 100644 --- 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 @@ -16,7 +16,7 @@ This guide describes how to recover the Application Server from a backup. This w ### 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.SingleServerWithoutHA.Backup.AddBackupToApplicationServer" title="Add Backup To Application Server" >}} for further information. +A backup policy must be configured on the Application Server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToApplicationServer" title="Add Backup to Application Server" >}} for further information. {{% /alert %}} {{< section "/disaster-recovery/application-server/recover/run-recover-script.md">}} 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 index ed8d24fba..793ddea7a 100644 --- 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 @@ -10,7 +10,7 @@ weight: 30 This guide describes how to recover the Encryption Key from a backup. This will recover the Encryption key to the web application server. {{% alert title="Warning" color="warning" %}} -The Encryption Key must be recovered before any installation of {{% ctx %}}. +If recovering to new hardware, the Encryption Key must be recovered before {{% ctx %}} is installed. {{% /alert %}} ### Configure the Recovery Script @@ -26,7 +26,7 @@ The Encryption Key must be recovered before any installation of {{% ctx %}}. | Name | Description | |------------------------------------------------|-------------| - |`TargetMachines` | Configure the value with the name of the web application server.| + |`TargetMachines` | Configure the value to contain the NETBIOS name or fully qualified domain name of the web application server.| |`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.

This does not need to be changed, a prompt will appear to enter this information when the script is run.| 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 index 6f62d9bc0..c658d00f7 100644 --- 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 @@ -16,7 +16,7 @@ This guide describes how to recover the Web Application Server from a backup. Th ### Run the Recovery Script {{% alert title="Note" %}} -A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" title="Add Backup To Web Application Server" >}} for further information. +A backup policy should be configured on the web application server before running a recovery, see {{< ahref path="Cortex.Guides.DisasterRecoveryGuides.SingleServerWithoutHA.Backup.AddBackupToWebApplicationServer" title="Add Backup to Web Application Server" >}} for further information. {{% /alert %}} {{< section "/disaster-recovery/web-application-server/recover/run-recover-script.md">}} 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 index a53c5ba8a..10ff8b174 100644 --- 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 @@ -11,7 +11,7 @@ .\Cortex.Innovation.EncryptionKey.Recover.ps1 ``` -1. Run the PowerShell command to recover the application services. +1. Run the PowerShell command to recover the Encryption Key. 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 approximately 1 minute. 1. Check that there have been no errors in the script; these would appear in red in the console. \ No newline at end of file