Creating a Gateway Server

Gateway servers are used to separate the APIs in internal servers with the outside world.

Step 1: Creating a Gateway Server

  • To define a gateway server, you must select the “Gateway Server” option while creating a server in the new server screen

    Gateway Server Creation Form

  • The Server Name and Host Name/ IP Address fields should be filled with the right info for your environment.

All the fields and their explanations are given in the below table:

General Settings
Operating System The server’s operating system
Server Name Unique server name
Host Name/ IP Address Server’s host name or IP address
Port Port number the server will service from
Log Level Level of logging detail
Connection Settings for Install
Server Connection Type How should we connect to the server
Installation Directory Directory where the server should be installed in
Performance Settings
Initial Memory JVM minumum stack size in megabytes
Maximum Memory JVM maximum stack size in megabytes
Worker Threads The number of blocking threads in the thread pool. Should be at least 10 per CPU
Max Worker Threads The maximum number of blocking threads in the thread pool. Usually same with Worker Threads count
Buffer Size Cache buffer size
I/0 Threads Number of IO threads. IO threads do non-blocking jobs and are responsible for multiple connections. It’s recomended to create 1 IO thread per CPU
Backlog Backlog
Other Settings Properties that are wanted in the start parameters of the gateway server can be added here. The parameter should be saved as key and value. The key’s name should start with -D. After the key and value of the property is added the Save button can be used to apply it. Likewise, it can be deleted with the Delete button.
  • Key value must start with “-D” if instance type is load balancer or gateway and with “-E” if instance type is log.Otherwise leave it blank for custom values.For example to set “-Xverboselog:myFile.txt” parameter to instance start script, put it only in “value” field and leave “key” field empty.Another example: To set “-Dlog4j.configuration=file:myFile.txt” parameter to instance start script, put “-Dlog4j.configuration” value to “key” field and put “file:myFile.txt” value to “value” field.

  • tuneMaxQueueSize and tuneMaxConcurrentRequest parameters can use as tune parameters for gateway and load balancer instances.tuneMaxConcurrentRequest parameter is used to increase handling max request size of gateway or load balancer instance. tuneMaxQueueSize is used to to add requests to the queue after the maximum request.For example ; the tuneMaxQueueSize can add to the servers with writing “-DtuneMaxQueueSize” to key field and writing “100” to value field.

  • After the necessary values are entered the “Save and Verify” button should be clicked to save the changes.

When defining a gateway server, the below requirements must be met:
  • The server name must be unique.
  • Hostname/ IP Address should match the “Cache Interface Block” value in system settings.
  • The hostname/ IP Address should be available.
  • The port should be available.
  • The directory shouldn’t be occupied by another server.

Step 2: Setting up the Gateway Server

  • Once the Save and Verify button is clicked, info about verification will appear on the right side of the page.
    • The checks that are complete will be marked with green check marks.
    • When all conditions are met, the Start Automatic Install buttons will become available