Release notesBreaking changes

Server name property replaced

The serverName property used to identify a server in properties.json is deprecated and replaced with a unique serverId identifier that you specify. If serverId is not provided, Itential Platform defaults to hashing the MAC address of the server. The serverId for each Platform instance cannot be duplicated. A log message displays at startup alerting you that the serverName property is deprecated.

What should I do?

Discontinue use of the serverName property and replace it with serverId.

The serverId property allows admins to define a uniquely identifying name for each Itential Platform server in their environment. The value is set in the properties.json file and provides a consistent way to set a server name. By using serverId values, admins no longer need to rely on generated IP addresses. serverId values can also be used in a Blue-Green deployment.

Example: single server configuration

1"serverId": "iap-1"

Example: multi-server configuration

This advanced configuration shows three unique server names in a primary data center and three in a secondary data center.

1"serverId": "IAP1.primary"
2"serverId": "IAP2.primary"
3"serverId": "IAP3.primary"
1"serverId": "IAP1.secondary"
2"serverId": "IAP2.secondary"
3"serverId": "IAP3.secondary"

Implement serverId

When changing or adding the serverId value during a restart of Itential Platform, any tasks in the “running” state that are not in the following task types list will be orphaned:

  • childJob
  • manual
  • forEach
  • eventListener

This will only be an issue when the serverId value is first set or changed. Each subsequent restart will not produce orphaned jobs as long as serverId has not been changed. Itential recommends that admins pause the task worker and ensure no jobs are running when setting serverId.

If an Itential Platform stack has a Disaster Recovery (DR) implementation, ensure the DR cluster does not contain duplicate serverId values from the primary cluster. Itential Platform only checks for duplicate serverId values at the cluster level, not the global level. If duplicates exist, tasks may be orphaned when the load balancer switches from the DR to the primary cluster.

If you need assistance setting serverId in properties.json, contact the Product Support Team.