From 9cac31bace663c9f2b396632f7533c6b15d7c6eb Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Tue, 26 Nov 2024 09:48:41 +0000 Subject: [PATCH 1/3] Added LB to encryption details --- .../multi-server/encryption-requirements.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/content/en/docs/2024.11/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md b/content/en/docs/2024.11/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md index 9c368b9b8..a64feafdb 100644 --- a/content/en/docs/2024.11/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md +++ b/content/en/docs/2024.11/_shared/prerequisites/install-innovation-only/multi-server/encryption-requirements.md @@ -12,10 +12,10 @@ Choose one of the Application Servers or the Web Application Server, and copy th cd "C:\Install\Cortex Innovation {{< version >}} - Encryption Key Generator" ``` -1. Run the `Cortex.Encryption.KeyGeneration.exe` application using the following command, modifying the argument value to contain the NETBIOS names or fully qualified domain names of the Application Servers and Web Application Server: +1. Run the `Cortex.Encryption.KeyGeneration.exe` application using the following command, modifying the argument value to contain the NETBIOS names or fully qualified domain names of the Application Servers, Load Balancer Server (if using the included load balancer) and Web Application Server: ```powershell - .\Cortex.Encryption.KeyGeneration.exe "app-server1, app-server2, app-server3, webapp-server" + .\Cortex.Encryption.KeyGeneration.exe "app-server1, app-server2, app-server3, lb-server, webapp-server" ``` 1. A message similar to the following will indicate that the application has completed successfully: @@ -27,6 +27,8 @@ Choose one of the Application Servers or the Web Application Server, and copy th Encryption key set on app-server2 app-server3: Overwritten Encryption key: EE19EB67F6C2D9E9A5AF6F0CE7822A44 Encryption key set on app-server3 + lb-server: Overwritten Encryption key: EE19EB67F6C2D9E9A5AF6F0CE7822A44 + Encryption key set on lb-server webapp-server: Overwritten Encryption key: EE19EB67F6C2D9E9A5AF6F0CE7822A44 Encryption key set on webapp-server Encryption Key: 284BADF55BDDC93A47D7DE8FC2C4DC9B From 6cbfde79ff53d2d488ca56f83b40fa0be188d464 Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 27 Nov 2024 10:53:15 +0000 Subject: [PATCH 2/3] Added prerequisite to upgrade to copy encrption key to LB --- .../multiple-server-with-ha/prerequisites.md | 43 +++++++++++++++++++ ...de-application-and-loadbalancer-servers.md | 3 +- data/urls.toml | 1 + 3 files changed, 46 insertions(+), 1 deletion(-) create mode 100644 content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md diff --git a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md new file mode 100644 index 000000000..38581a76d --- /dev/null +++ b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md @@ -0,0 +1,43 @@ +--- +title: "Prerequisites" +linkTitle: "Prerequisites" +description: "Information about the prerequisites required before starting the upgrade." +weight: 10 +--- + +# {{< param title >}} + +The prerequisites required to be considered before starting the upgrade. + +## Encryption Requirements + +{{% alert title="Note" %}}This step is only required if the load balancer installed is the load balancer that is included with the {{% ctx %}} software.{{% /alert %}} + +1. On one of the Application Servers: + 1. On the Start menu, choose `Run`. + 1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. + 1. In the Registry Editor, locate the registry value `Key` which can be found at the following location `HKEY_LOCAL_MACHINE\SOFTWARE\Innovise\Cerberus`. + 1. Copy the value of `Key` and save it to a known location. +1. On the Load Balancer Server: + 1. On the Start menu, choose `Run`. + 1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. + 1. In the Registry Editor, navigate through the subkeys to `HKEY_LOCAL_MACHINE\SOFTWARE\Innovise\Cerberus`. If any of the subkeys do not exist create them repeating for each subsequent folder: + * Right click on the parent folder. + * Select `New`. + * Select `Key`. + * Set the name to be the subkey that you are creating e.g. `Cerberus`. + 1. Under the `Cerberus` folder locate the registry value `Key`. If the registry value does not exist create it: + * Right click in the right window. + * Select `New`. + * Select `String`. + * Set the name to be `Key`. + 1. Set the value of `Key` to be the value copied from the Application Server in Step 1.4: + * Double click on the registry value `Key` to open the Edit dialog. + * Set the value. + * Click `OK`. + +## Next Steps? + +1. [Upgrade Application Servers and Load Balancer][] + +[Upgrade Application Servers and Load Balancer]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}} diff --git a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers.md b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers.md index deac8d9e4..e87322dd3 100644 --- a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers.md +++ b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers.md @@ -7,7 +7,7 @@ weight: 30 # {{< param title >}} -This guide describes how to upgrade the Application Servers and Load Balancer Server from 2024.9 to 2024.11. +This guide describes how to upgrade the Application Servers and Load Balancer Server from 2024.9 to 2024.11. Please ensure that the [Prerequisites][] have been completed before starting this upgrade. ## Make Installation Artefacts Available @@ -76,4 +76,5 @@ To check the previous configuration values open the `Cortex.Upgrade.ApplicationC 1. [Upgrade Web Application Server][] +[Prerequisites]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.Prerequisites" >}} [Upgrade Web Application Server]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeWebApplicationServer" >}} diff --git a/data/urls.toml b/data/urls.toml index 33f944535..4e85f0b00 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -569,6 +569,7 @@ UpgradeFlows = "/docs/guides/upgrade-cortex/advanced/upgrade-flows" [Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA] MainDoc = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/" + Prerequisites = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites" TryItOut = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/try-it-out" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers" UpgradeDebugger = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-debugger" From 46c329be02887c76376721c2baffd5f452976d3e Mon Sep 17 00:00:00 2001 From: Donna-Marie Smith Date: Wed, 27 Nov 2024 11:51:25 +0000 Subject: [PATCH 3/3] Modified Formatting following PR Review --- .../multiple-server-with-ha/prerequisites.md | 61 ++++++++++++------- data/urls.toml | 1 + 2 files changed, 40 insertions(+), 22 deletions(-) diff --git a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md index 38581a76d..e47de36dc 100644 --- a/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md +++ b/content/en/docs/2024.11/Guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites.md @@ -13,31 +13,48 @@ The prerequisites required to be considered before starting the upgrade. {{% alert title="Note" %}}This step is only required if the load balancer installed is the load balancer that is included with the {{% ctx %}} software.{{% /alert %}} -1. On one of the Application Servers: - 1. On the Start menu, choose `Run`. - 1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. - 1. In the Registry Editor, locate the registry value `Key` which can be found at the following location `HKEY_LOCAL_MACHINE\SOFTWARE\Innovise\Cerberus`. - 1. Copy the value of `Key` and save it to a known location. -1. On the Load Balancer Server: - 1. On the Start menu, choose `Run`. - 1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. - 1. In the Registry Editor, navigate through the subkeys to `HKEY_LOCAL_MACHINE\SOFTWARE\Innovise\Cerberus`. If any of the subkeys do not exist create them repeating for each subsequent folder: - * Right click on the parent folder. - * Select `New`. - * Select `Key`. - * Set the name to be the subkey that you are creating e.g. `Cerberus`. - 1. Under the `Cerberus` folder locate the registry value `Key`. If the registry value does not exist create it: - * Right click in the right window. - * Select `New`. - * Select `String`. - * Set the name to be `Key`. - 1. Set the value of `Key` to be the value copied from the Application Server in Step 1.4: - * Double click on the registry value `Key` to open the Edit dialog. - * Set the value. - * Click `OK`. +### Retrieve Existing Encryption Key + +On one of the Application Servers: + +1. On the Start menu, choose `Run`. +1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. +1. In the Registry Editor, locate the registry value `Key` which can be found at the following location `HKEY_LOCAL_MACHINE\SOFTWARE\Innovise\Cerberus`. +1. Copy the value of `Key` and save it to a known location. + +### Add Encryption Key to Load Balancer Server + +On the Load Balancer Server: + +1. On the Start menu, choose `Run`. +1. In the open box, enter `regedit.exe`. You must have administrative credentials to run regedit.exe. +1. In the Registry Editor, navigate through the subkeys to `HKEY_LOCAL_MACHINE\SOFTWARE\Innovise\Cerberus`. + + If any of the subkeys do not exist create them, repeating for each subsequent subkey: + + 1. Right click on the parent subkey. + 1. Select `New`. + 1. Select `Key`. + 1. Set the name to be the subkey that you are creating e.g. `Innovise`. + +1. Under the `Cerberus` subkey locate the registry value `Key`. + + If the registry value does not exist create it: + + * Right click in the right window. + * Select `New`. + * Select `String`. + * Set the name to be `Key`. + +1. Set the value of `Key` to be the value copied from the Application Server in Step 4 of [Retrieve Existing Encryption Key][]: + + 1. Double click on the registry value `Key` to open the Edit dialog. + 1. Set the value. + 1. Click `OK`. ## Next Steps? 1. [Upgrade Application Servers and Load Balancer][] +[Retrieve Existing Encryption Key]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.RetrieveAppServerEncryptionKey" >}} [Upgrade Application Servers and Load Balancer]: {{< url path="Cortex.Guides.UpgradeCortex.2024.9to2024.11.MultipleServerWithHA.UpgradeApplicationAndLoadBalancerServers" >}} diff --git a/data/urls.toml b/data/urls.toml index 4e85f0b00..c8784c391 100644 --- a/data/urls.toml +++ b/data/urls.toml @@ -571,6 +571,7 @@ MainDoc = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/" Prerequisites = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites" TryItOut = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/try-it-out" + RetrieveAppServerEncryptionKey = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/prerequisites/#retrieve-existing-encryption-key" UpgradeApplicationAndLoadBalancerServers = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers" UpgradeDebugger = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-debugger" UpgradeGateway = "/docs/guides/upgrade-cortex/2024.9-to-2024.11/multiple-server-with-ha/upgrade-web-application-server/upgrade-gateway"