When using the Web Console, you might want the servers to have the ability to register automatically, and even update that registration when their IP address changes. In an elastic environment, new server instances would not be recognized by a Web Console. New server instances would be added manually to a Web Console's Server Group. But servers might assigned a new IP address. When each server can connect to its Web Console and provide its revised IP address, the Web Console will be able to automatically report this server's metrics.

The following properties are settings you can apply on Corticon Server installations that will be managed by the Web Console by adding all the properties and appropriate values as lines in each server's brms.properties file, and then restarting each Server to apply the properties. The effect of these settings will be to register the server in the Web Console if it is not already registered. The Web Console Server must be running and accessible at its URL.

Web console values are defaulted to the out-of-the-box Tomcat configuration of the Web Console installation.

If a server is not already registered, the server will register itself with the specified Web Console based on the dynamic strategy . If a server is already registered and its server IP has changed, the auto-register will update the previous registration with the new IP and not register it again.

Enable the feature—When this is false the feature will not use any of its other properties.

com.corticon.ccserver.autoregistration.enabled

Indicates whether this Server will try to auto-register with a Web Console. Server instances that are already registered will not be updated. To update an existing registration (say, to change password), stop the server and delete it from the Web Console, and start again with this property set to true.

Default: false

------------------------------------------------------------------------

Connection to the Web Console—The properties for managing connection to the Web Console server, shown here as localhost on port 8850. Note that if you use localhost for a co-located installation, the Web Console is self-registered for such an installation and will create another server registration using the IP address

com.corticon.ccserver.autoregistration.webconsoleserver.url

The URL of the running Web Console server.

Default: http://localhost:8850/corticon

Note: Host and Port—Substitute the configured values of your Web Console server location and its port when configuring server registration.

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.webconsoleserver.username

Username to use to authenticate with the Web Console. To encrypt the username, use the utility corticonManagement --encryptstring -i usernname.

Default (encrypted): 047043014032058

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.webconsoleserver.password

Password to use to authenticate with Web Console. To encrypt the password, use the utility corticonManagement --encryptstring -i password .

Default: 047043014032058

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.webconsoleserver.retries

The number of retries the Server will attempt to login and register itself to the Web Console.

Default: 20

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.webconsoleserver.sleep

The amount of time to wait in between retry attempts as the Web Console could be initializing as its Server starts up.

Default: 10000 (10 seconds)

------------------------------------------------------------------------

Registered type of the server

com.corticon.ccserver.autoregistration.webconsoleserver.servergroup

The name of the server group that this Server will create or be registered in.

Default: Auto Registered

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.webconsoleserver.singleserver

When value is true, the Server is be added as a single server and not added to a Server Group, although it might the sole member of a group.

Default: true

------------------------------------------------------------------------

Registered identity of the server

com.corticon.ccserver.autoregistration.local.protocol

The protocol that the Web Console will use to call into this Server (or https).

Default: http

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.local.ip.static

The static IP Address that the Web Console will use to call into this Server. If this value is null, then the machine's IP Address or DNS Name will be used, which depending on the value of the com.corticon.ccserver.autoregistration.local.ip.dynamic.strategy property.

Default:

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.local.ip.dynamic.strategy

If the com.corticon.ccserver.autoregistration.local.ip.static is null, then the Server will register itself based on the machine's IP or its DNS Name. This property allows you to determine which approach to use. Possible values are IP or DNS.

Default: IP

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.local.port

The port that the Web Console will use to call into this Server

Default: 8850

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.local.context

The name of the context that the Web Console will use to call into this Server

Default: axis

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.local.username

Username to be used by Web Console to authenticate with this running Server. To encrypt the password, use the utility corticonManagement --encryptstring -i password.

Default: 047043014032058

------------------------------------------------------------------------

com.corticon.ccserver.autoregistration.local.password

Password to be used by Web Console to authenticate with this running Server. To encrypt the password, use the utility corticonManagement --encryptstring -i password.

Default: 047043014032058

In summary

The properties to add to your Server's brms.properties file with your preferred values are the following, shown with default values or examples:

com.corticon.ccserver.autoregistration.enabled=false
			
com.corticon.ccserver.autoregistration.webconsoleserver.url=http://localhost:8850/corticon
com.corticon.ccserver.autoregistration.webconsoleserver.username=047043014032058
com.corticon.ccserver.autoregistration.webconsoleserver.password=047043014032058
com.corticon.ccserver.autoregistration.webconsoleserver.retries=20
com.corticon.ccserver.autoregistration.webconsoleserver.sleep=10000
				
com.corticon.ccserver.autoregistration.webconsoleserver.servergroup=Auto Registered
com.corticon.ccserver.autoregistration.webconsoleserver.singleserver=true

com.corticon.ccserver.autoregistration.local.protocol=http
com.corticon.ccserver.autoregistration.local.ip.static=
com.corticon.ccserver.autoregistration.local.ip.dynamic.strategy=IP
com.corticon.ccserver.autoregistration.local.port=8850
com.corticon.ccserver.autoregistration.local.context=axis
com.corticon.ccserver.autoregistration.local.username=047043014032058
com.corticon.ccserver.autoregistration.local.password=047043014032058