Pre-Upgrade Steps - Windows

Warning

• Before commencing the Workbench upgrade - please ensure the Workbench Host(s) have 'free' at least 3 times the size of the "<WORKBENCH_INSTALL>/ElasticSearch/data" directory - else the Workbench upgrade process will fail and Workbench data integrity and operation will likely be compromised.

Important

• Before proceeding with a Workbench upgrade:
  • Ensure ALL of the current/old Workbench version Services are Started/Running for a successful upgrade - on ALL Workbench Nodes (i.e. Primary and Additional)
  • At the end of a successful upgrade, ALL the old Workbench version Services will be Stopped set to Manual
• The Workbench Agent Service in the Primary Workbench Node should be up and running without any interruptions until all the associated Additional Nodes are upgraded from 9.2 to 9.3.000.00

Important

• For Workbench 9.2 to 9.3 upgrades:
  • During the upgrade to 9.3, Workbench component statuses may be inaccurate until all Workbench Cluster Nodes are fully upgraded/completed
  • The Workbench Primary Services should be up/running before commencing any Workbench 9.3 Node2, Node3, NodeN upgrades
  • Existing Dashboards/Visualizations will be migrated with a "_9.2" suffix
  • The migrated "_9.2" Dashboards/Visualizations will not be functional given the changes from Kibana 7.1 to 7.17
  • As such, when opening the migrated "_9.2" Dashboards/Visualizations, a Warning icon/message will be displayed
  • Even though the migrated "_9.2" Dashboards/Visualizations are not functional and display a Warning, the logic for migrating is to provide context for previously created Dashboards/Visualizations
  • When upgrading from Workbench 9.2 to 9.3, the migrated Visualizations cannot be deleted; this will be addressed in a future Workbench 9.x release

Workbench N-1 Upgrade

Important

• Workbench only supports an N-1 upgrade path
• Please ensure your on the immediate previous Workbench release before upgrading
• i.e. Do not upgrade directly from 9.0.000.00 to 9.1.100.00 - instead from 9.0.000.00 upgrade to 9.1.000.00, then upgrade to 9.1.100.00
  • Follow this approach for each and every Workbench release upgrade

Workbench 9.1.100.00 to 9.2.xxx.xx upgrade - DataSync Utility

Important

• If/when your Workbench deployment has multi Data-Center's that are synchronized, please follow these steps below to avoid Workbench multi Data-Center data discrepancies

1. On the Workbench Primary Node/Host (i.e. APAC)
2. Extract the new downloaded "Workbench_9.2.xxx.xx_WINDOWS.zip" file to a working {WORK_DIR} directory (i.e. C:\tmp)
3. Navigate into the "{WORK_DIR}\Workbench_9.2.xxx.xx_WINDOWS\ip\windows" directory
4. Extract the "{WORK_DIR}\Workbench_9.2.xxx.xx_Installer_Windows.zip" file
5. Navigate into the "{WORK_DIR}\Workbench_9.2.xxx.xx_Installer_Windows" directory
6. Open a Command/Powershell Console As Administrator in the {WORK_DIR}\Workbench_9.2.000.00_Installer_Windows\ip\windows directory
7. Run "wb_patch.bat"
8. Enter the Workbench Primary ZooKeeper IP_ADDRESS:PORT of the Workbench Primary Node/Host (i.e. 10.20.30.40:2181)
   *If the Workbench Zookeeper has authentication enabled, provide the respective Primary Zookeeper username and password
9. The DataSync Utility will execute and provide progress information in the console.
10. It is a one time process and we don't require the steps while upgrading other Data centers.

Warning

• Only now commence the 9.1.100.00 to 9.2.xxx.xx Workbench upgrade