Requirements to run the Client

System Requirements

Secure Gateway does not support a platform version if a vendor has expired support for it. In other words, Secure Gateway does not support running on End-of-Life (EoL) platforms. This is true regardless of entries in the table below.

Note: Only 64-bit environments are currently supported for native client installation.

Network Requirements

The Secure Gateway Client uses outbound port 443 and port 9000 to connect to npm registry and the IBM Cloud® environment:

• Port 443 for npm installation

  • During the installation, the installer will connect to npm registry and run npm install to install the dependencies required by Secure Gateway Client. Before the installation, please make sure the machine which the client will be installed on can connect to a npm registry website. npm is configured to use npm, Inc.'s public registry at https://registry.npmjs.org by default.
    
    If there's npm Enterprise server in your environment, please whitelist all of the dependencies of Secure Gateway Client on the npm Enterprise server. For the list of dependencies, please refer to <Installation_directory>\ibm\securegateway\client\package.json file.

• Port 9000 for WSS connection between Secure Gateway Client and Secure Gateway Server

  • The node of the SG gateway, which can be found in the configuration of the gateway. Since each gateway will not be on the same node, please confirm the hostname of the node every time you create the gateway

• Port 443 for gateway authentication when Secure Gateway Client start up

  • US South: sgmanager.us-south.securegateway.cloud.ibm.com
  • US East: sgmanager.us-east.securegateway.cloud.ibm.com
  • United Kingdom: sgmanager.eu-gb.securegateway.cloud.ibm.com
  • Germany: sgmanager.eu-de.securegateway.cloud.ibm.com
  • Sydney: sgmanager.au-syd.securegateway.cloud.ibm.com

Ensure you check or modify additional firewall and IP Table rules that might apply. However, we do not recommend setting rules by IP, rules should be set specific to host name and port as the IPs for gateway authentication and SG gateway are controlled by IBM Cloud and are subject to change.

Determining Hardware Requirements

The specifications of the machine running the Secure Gateway Client is largely dependent on the traffic that will be passing through each connection. Each client instance is an individual process that provides up to 250 concurrent connections. To estimate an average maximum that the machine would need to support, determine the average size of a transaction across the client (both request and response) and then scale that to 250 concurrent transactions. Given that this number has combined both request and response sizes, the client should not exceed this memory footprint. For more precise estimates, a mixture of request sizes and response sizes should be used to better simulate a real-world transaction scenario.

For running a single instance of the Secure Gateway Client, we suggest a minimum of 2 cores and 4 GB of memory.

For HA scenarios that will be running multiple instances of the client on the same machine, we suggest a minimum of 4 cores and 8 GB of memory.