< Table of Contents

Upgrade the Gateway

The upgrade procedure migrates a Kaazing WebSocket Gateway 4.x Edition (including any associated applications) into Kaazing WebSocket Gateway release 5.0. The following checklist provides the steps necessary to upgrade Kaazing Gateway to the next release.

Note: If you are using Kaazing Gateway 3.x, please first upgrade to 4.x by following these instructions.

Step Topic or Reference
Understand Gateway release number strategy and the upgrade process. About Kaazing Gateway Releases and Upgrades
Upgrade to the new Gateway release by unpacking the .zip for Windows or .tar.gz for Linux, UNIX, or Mac) into any directory location. Setting Up the Gateway See Upgrade Options for help choosing an upgrade methodology.
Migrate your existing Gateway configuration file and other files to the new Gateway installation. Migrate the Gateway Configuration
If you are using a Gateway in a cluster, then you need to perform additional steps to migrate the cluster members. Clustering and Load Balancing Migration Note: Upgrade all members of the Gateway cluster before you migrate any clients.
Verify the Gateway is upgraded. View the release number via Command Center, the Gateway start-up output, or the log file.
If you are using 4.x SPIs, update the SPI package names. Change com.kaazing.gateway.server.spi.security to org.kaazing.gateway.server.spi.security.
If you are using JMX MBeans to monitor the Gateway, update the MBean paths. In 4.x and 5.x, the MBeans path is org.kaazing.gateway.server.management > gateways > process_id@hostname > services. Note that some service names may have changed or been deprecated.
If you used AMQP identify promotion in your LoginModule, update the package names for 5.x Promote User Identity into the AMQP Protocol
Learn how clients built using Kaazing Gateway can take advantage of the Kaazing Gateway client libraries. General Client Information
(Recommended) Migrate Kaazing JavaScript and Java clients that use the ByteSocket API on releases 3.3 (and later releases) to the WebSocket API in release 4.x. Migrate JavaScript Applications to Kaazing Gateway 4.x.; Migrate WebSocket and ByteSocket Applications to Kaazing Gateway 5.0

See Also