Feature/19215 amend upgrade guide to include upgrade configs (#148)

Added steps to confirm how to use previously configured values on upgrade --------- Co-authored-by: Donna-Marie Smith <[email protected]>
CortexIntelligentAutomation · Aug 1, 2024 · e944d1b · e944d1b
1 parent 7e5d7ef
commit e944d1b
Show file tree

Hide file tree

Showing 5 changed files with 83 additions and 30 deletions.
diff --git a/...-2024.7/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers.md b/...-2024.7/multiple-server-with-ha/upgrade-application-and-loadbalancer-servers.md
@@ -21,18 +21,32 @@ This guide describes how to upgrade the Application Servers and Load Balancer Se
 ## Configure Upgrade Script
 
 1. In the `Cortex Innovation 2024.7 - App Server Install Scripts\Upgrade Application Server` folder, locate the `Cortex.Innovation.Upgrade.ps1` script and open it with a text editor.
-1. Configure the script, changing the parameters according to the details given below:
-
-    ```powershell
-    .\Cortex.Upgrade.ps1 `
-        -AppServicesPath "C:\Install\Cortex Innovation 2024.7 - App Services.zip" `
-        -BlockPackagesPath "C:\Install\Cortex Innovation 2024.7 - Block Packages.zip" `
-        -ApplicationServerIPv4Addresses @("192.168.1.1, 192.168.1.2, 192.168.1.3") `
-        -LoadBalancerServerIPv4Address "192.168.1.4" `
-        -Credential $Credential `
-        -AcceptEULA:$AcceptEULA `
-        *>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
-    ```
+1. Choose the tab below that matches the configuration for this upgrade, then update the script to match, changing the parameters according to the details given below:
+
+    {{% alert title="Note" %}}
+To check the previous configuration values open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. If the file does not exist or the values should be changed then use the `Use New Configuration Values` tab.
+    {{% /alert %}}
+
+    {{< tabpane lang="powershell" >}}
+        {{< tab header="Use Previous Configuration Values" >}}
+.\Cortex.Upgrade.ps1 `
+    -AppServicesPath "C:\Install\Cortex Innovation 2024.7 - App Services.zip" `
+    -BlockPackagesPath "C:\Install\Cortex Innovation 2024.7 - Block Packages.zip" `
+    -Credential $Credential `
+    -AcceptEULA:$AcceptEULA `
+    *>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
+        {{< /tab >}}
+        {{< tab header="Use New Configuration Values">}}
+.\Cortex.Upgrade.ps1 `
+    -AppServicesPath "C:\Install\Cortex Innovation 2024.7 - App Services.zip" `
+    -BlockPackagesPath "C:\Install\Cortex Innovation 2024.7 - Block Packages.zip" `
+    -ApplicationServerIPv4Addresses @("192.168.1.1, 192.168.1.2, 192.168.1.3") `
+    -LoadBalancerServerIPv4Address "192.168.1.4" `
+    -Credential $Credential `
+    -AcceptEULA:$AcceptEULA `
+    *>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
+        {{< /tab >}}
+    {{< /tabpane >}}
 
     | Name                                         | Description |
     |----------------------------------------------|-------------|

diff --git a/...ade/2024.7/upgrade-application-server/single-server/configure-upgrade-script.md b/...ade/2024.7/upgrade-application-server/single-server/configure-upgrade-script.md
@@ -1,15 +1,29 @@
 1. In the `Cortex Innovation 2024.7 - App Server Install Scripts\Upgrade Application Server` folder, locate the `Cortex.Innovation.Upgrade.ps1` script and open it with a text editor.
-1. Configure the script, changing the parameters according to the details given below:
+1. Choose the tab below that matches the configuration for this upgrade, then update the script to match, changing the parameters according to the details given below:
 
-    ```powershell
-    .\Cortex.Upgrade.ps1 `
-        -AppServicesPath "C:\Install\Cortex Innovation 2024.7 - App Services.zip" `
-        -BlockPackagesPath "C:\Install\Cortex Innovation 2024.7 - Block Packages.zip" `
-        -ApplicationServerIPv4Addresses @("192.168.1.1") `
-        -Credential $Credential `
-        -AcceptEULA:$AcceptEULA `
-        *>&1 | Tee-Object -FilePath "cortex-app-upgrade-log.txt"
-    ```
+    {{% alert title="Note" %}}
+To check the previous configuration values open the `Cortex.Upgrade.ApplicationConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. If the file does not exist or the values should be changed then use the `Use New Configuration Values` tab.
+    {{% /alert %}}
+
+    {{< tabpane lang="powershell" >}}
+        {{< tab header="Use Previous Configuration Values" >}}
+.\Cortex.Upgrade.ps1 `
+    -AppServicesPath "C:\Install\Cortex Innovation 2024.7 - App Services.zip" `
+    -BlockPackagesPath "C:\Install\Cortex Innovation 2024.7 - Block Packages.zip" `
+    -Credential $Credential `
+    -AcceptEULA:$AcceptEULA `
+    *>&1 | Tee-Object -FilePath "cortex-ha-upgrade-log.txt"
+        {{< /tab >}}
+        {{< tab header="Use New Configuration Values">}}
+.\Cortex.Upgrade.ps1 `
+    -AppServicesPath "C:\Install\Cortex Innovation 2024.7 - App Services.zip" `
+    -BlockPackagesPath "C:\Install\Cortex Innovation 2024.7 - Block Packages.zip" `
+    -ApplicationServerIPv4Addresses @("192.168.1.1") `
+    -Credential $Credential `
+    -AcceptEULA:$AcceptEULA `
+    *>&1 | Tee-Object -FilePath "cortex-app-upgrade-log.txt"
+        {{< /tab >}}
+    {{< /tabpane >}}
 
     | Name                                         | Description |
     |----------------------------------------------|-------------|

diff --git a/...hared/upgrade/2024.7/upgrade-web-application-server/configure-gateway-script.md b/...hared/upgrade/2024.7/upgrade-web-application-server/configure-gateway-script.md
@@ -1,8 +1,20 @@
 1. In the `Cortex Innovation 2024.7 - Web App Server Install Scripts` folder, locate the `Cortex.Innovation.Install.Gateway.ps1` script and open it with a text editor.
-1. Configure the script according to the details given below:
+1. Choose the tab below that matches the configuration for this upgrade, then update the script to match, changing the parameters according to the details given below:
 
-    ```powershell
-    .\Cortex.Install.Gateway.ps1 `
+    {{% alert title="Note" %}}
+To check the previous configuration values open the `Cortex.Upgrade.GatewayConfig.json` file located in `%ProgramData%\Cortex\Upgrade`. If the file does not exist or any of the values should be changed then use the `Use New Configuration Values` tab removing any of the parameters that do need need to change leaving the minimum required parameters as can be seen in the `Use Previous Configuration Values` tab.
+    {{% /alert %}}
+
+    {{< tabpane lang="powershell" >}}
+        {{< tab header="Use Previous Configuration Values" >}}
+.\Cortex.Install.Gateway.ps1 `
+    -GatewayPackagePath "C:\Install\Cortex Innovation 2024.7 - Gateway.zip" `
+    -ApplySecurityMeasures $true `
+    -AcceptEULA:$AcceptEula `
+    *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt"
+        {{< /tab >}}
+        {{< tab header="Use New Configuration Values">}}
+.\Cortex.Install.Gateway.ps1 `
     -GatewayPackagePath "C:\Install\Cortex Innovation 2024.7 - Gateway.zip" `
     -GatewayApplicationPoolUsername "Domain\Username" `
     -WebRootFolder "C:\inetpub\wwwroot" `
@@ -14,7 +26,8 @@
     -UsingWindowsDefender $false `
     -AcceptEULA:$AcceptEula `
     *>&1 | Tee-Object -FilePath "cortex-gateway-install-log.txt"
-    ```
+        {{< /tab >}}
+    {{< /tabpane >}}
 
     | Name                                           | Description |
     |------------------------------------------------|-------------|

diff --git a/...d/upgrade/upgrade-application-server/multi-server/check-application-services.md b/...d/upgrade/upgrade-application-server/multi-server/check-application-services.md
@@ -1,7 +1,13 @@
 1. Log on to one of the Application Servers.
-1. Import the client certificate used for the original installation of the application. Its location is specified in the `ClientCertificatePath` parameter of the `Cortex.Innovation.Install.ps1` file of the original installation. If the .PFX file is available on the server, this can be achieved by double-clicking on the client certificate .PFX file and following the wizard.
+1. Import the client certificate used for the original installation of the application. Its location is specified in the `ClientCertificatePath` parameter of the `Cortex.Innovation.Install.ps1` file of the original installation.
 
-    If the .PFX file is not available, the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the certificate that is used from the `Personal` store as a pfx file and then importing it to the `Current User` store by double-clicking on it and following the wizard.
+    If the .PFX file is available on the server:
+    * Double-click on the client certificate .PFX file and follow the wizard.
+
+    If the .PFX file is not available:
+    * Identify the certificate to export by opening the `Cortex.Upgrade.ApplicationConfig.json` configuration file located in `C:\ProgramData\Cortex\Upgrade` and locate the value of the `applicationServerCertificateSubject` and `applicationServerCertificateThumbprint`.
+    * Find the certificate by using the `Manage Computer Certificates` tool in Windows.  In the `Personal` store, the certificate will have an `Issued To` similar to `applicationServerCertificateSubject` and to confirm it is the right certificate double-click the certificate, select the `Details` tab and locate the `Thumbprint` property to compare the value to that in `applicationServerCertificateThumbprint`.
+    * Export the certificate as a pfx file and then import it to the `Current User` store by double-clicking on it and following the wizard.
 1. Open a web browser.
 1. Navigate to `https://app-server.domain.com:9080/Explorer`, where `app-server.domain.com` is the fully qualified domain name of any Application Server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation.
 

diff --git a/.../upgrade/upgrade-application-server/single-server/check-application-services.md b/.../upgrade/upgrade-application-server/single-server/check-application-services.md
@@ -1,7 +1,13 @@
 1. Log on to the server.
-1. Import the client certificate used for the original installation of the application. Its location is specified in the `ClientCertificatePath` parameter of the `Cortex.Innovation.Install.ps1` file of the original installation. If the .PFX file is available on the server, this can be achieved by double-clicking on the client certificate .PFX file and following the wizard.
+1. Import the client certificate used for the original installation of the application. Its location is specified in the `ClientCertificatePath` parameter of the `Cortex.Innovation.Install.ps1` file of the original installation.
 
-    If the .PFX file is not available, the certificate can be retrieved by using the `Manage Computer Certificates` tool in Windows to export the certificate that is used from the `Personal` store as a pfx file and then importing it to the `Current User` store by double-clicking on it and following the wizard.
+    If the .PFX file is available on the server:
+    * Double-click on the client certificate .PFX file and follow the wizard.
+
+    If the .PFX file is not available:
+    * Identify the certificate to export by opening the `Cortex.Upgrade.ApplicationConfig.json` configuration file located in `C:\ProgramData\Cortex\Upgrade` and locate the value of the `applicationServerCertificateSubject` and `applicationServerCertificateThumbprint`.
+    * Find the certificate by using the `Manage Computer Certificates` tool in Windows.  In the `Personal` store, the certificate will have an `Issued To` similar to `applicationServerCertificateSubject` and to confirm it is the right certificate double-click the certificate, select the `Details` tab and locate the `Thumbprint` property to compare the value to that in `applicationServerCertificateThumbprint`.
+    * Export the certificate as a pfx file and then import it to the `Current User` store by double-clicking on it and following the wizard.
 1. Open a web browser.
 1. Navigate to `https://server.domain.com:9080/Explorer`, where `server.domain.com` is the fully qualified domain name of the server. Replace `9080` with new `httpGatewayEndpointPort` value if it was changed during configuration of the original installation.