Cluster Configuration Files

In a cluster, you can deploy an appliance as a server or a client by modifying the cluster configuration files. For deploying an appliance on a cluster, the following configuration files are available for an appliance.

agent.json

The agent.json file specifies the role of an appliance in the cluster. The file is available in the /opt/cluster-consul-integration/configure directory.

The following table describes the attributes that can be configured in the agent.json file.

AttributeDescriptionValues
typeThe role of the appliance in the cluster.
  • auto (default) – Role of the appliance is determined based on state of the TAC and the parameters of the agent_auto.json file.
  • client – Appliance is added to cluster as a client
  • server– Appliance is added to cluster as a server
For more information about the deployment scenarios, refer to section Deploying Appliances in a cluster.

agent_auto.json

This file is considered only if the type attribute in the agent.json file is set to auto. The agent_auto.json file specifies the maximum number of servers allowed in a cluster. Additionally, you can also specify which appliances can be added to the cluster as servers.

The agent_auto.json file is available in the /opt/cluster-consul-integration/configure directory.

The following table describes the attributes that can be configured in the agent_auto.json file.

AttributeDescriptionValues
maximum_serversThe maximum number of servers that can be deployed in a cluster.5 (default)
Note
  • It is recommended to set the attribute value as 3 or 5.
  • If the attribute value is 0, then all the appliances are added to the cluster as servers.
PAP_eligible_serversThe list of appliances that can be deployed as servers.
  • ESA (default) - ESA appliance
  • CG – DSG appliance

config.json

This file contains the cluster-related information for an appliance, such as, data center, ports, Consul certificates, bind address, and so on. The config.json file is available in the /opt/consul/configure directory.

Last modified February 7, 2025