Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/24000 add load balancer to encryption details #179

Merged
merged 3 commits into from
Nov 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
---
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 %}}

### 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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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" >}}
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions data/urls.toml
Original file line number Diff line number Diff line change
Expand Up @@ -569,7 +569,9 @@
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"
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"
Expand Down