Migrate the Gateway Configuration

This topic explains how to migrate your existing configuration to a new Gateway release. Before you migrate your Gateway configuration. review the procedures in Upgrade Kaazing WebSocket Gateway.

# Step Topic or Reference
1 Stop the Gateway or Gateway cluster if currently running. Setting Up Kaazing WebSocket Gateway for instructions on how to stop the Gateway.
2 Back up any existing user-modified files (such as the Gateway configuration file, the log4j-config.xml, the keystore file, license file, and so on). See the Glossary for a brief reference to the various Gateway directories and locations.
3 Copy your current (old) Gateway configuration file to the new Gateway installation.

Copy the Gateway configuration file from your old configuration (for example. gateway-config.xml) to the GATEWAY_HOME/conf directory in the new Gateway installation.

Note: If this is a Gateway cluster, then perform this step on all cluster members before proceeding to the next step. See Clustering and Load Balancing Migration.

4

If you modified any files (other than the Gateway configuration file) in the old Gateway configuration, then edit those same files in the new Gateway installation to apply your modifications.

Note: Do not edit the Gateway configuration file now because it will be updated automatically when you start the Gateway in the next step.

Except for the Gateway configuration file, you must manually edit files in the new configuration to make the same customizations you made in the old configuration. For example, modified files might include the log4j-config.xml, jaas-config.xml, the keystore file, the license file, and so on.

Note: If this is a Gateway cluster, then perform this step on all cluster members before proceeding to the next step.

5 Start the new Gateway.

When the Gateway starts it uses the old configuration file that you copied to the new GATEWAY_HOME installation. If the Gateway configuration file contains out-of-date configuration elements or namespace declaration, then the Gateway automatically updates the configuration information in memory and writes a modified configuration file to disk and appends a .new extension (for example, gateway-config.xml.new).

See Understanding Kaazing WebSocket Gateway Configuration to learn more about the .new configuration file.

6 Stop the new Gateway and replace the Gateway configuration file, if necessary.

If a .new configuration file was generated when you started the Gateway, then delete the current (old) configuration file and rename the .new configuration file to gateway-config.xml) so that the Gateway uses the up-to-date configuration the next time it starts. This is also a good time to make other modifications, if any, to the configuration file. For example, if you are running a Gateway cluster you should update the cluster configuration with the changes suggested in Clustering and Load Balancing Migration. Also, see:

  • Understanding Kaazing WebSocket Gateway Configuration to learn how to ensure the elements used in your configuration match what is supported by the namespace.
  • "Deprecated Elements" in the Release Notes for a list of features that have been deprecated or have been made permanently obsolete. This reference also provides information on what configuration elements to use instead.
7 Start the Gateway or Gateway cluster and check the version number on the start log or use Command Center to check that you are using the new version.

See:

Note: Upgrade all members of the Gateway cluster before you migrate any clients. See Clustering and Load Balancing Migration.

8 Complete the upgrade instructions in Upgrade Kaazing WebSocket Gateway. Return to Upgrade Kaazing WebSocket Gateway and follow the steps to to verify the configuration, migrate clients, and any other remaining migration work.

See Also

  • Kaazing WebSocket Gateway documentation that is available online at tech.kaazing.com
TOP