KB484387: Configure Community Connectors in a cluster environment

Configure a cluster environment for Community Connectors prior to Strategy 2021

Description 

In a single node environment, when following the product documentation for configuring and deploying Community Connectors, the configurations are correctly set and the connectors are ready to use. However, when repeating the steps in a cluster environment, only one node of the Community Connectors Server is configured and it is unsure which one. Hence, you may still encounter errors telling you that the configuration is not set.

Why is this happening? 

The configurations of all Community Connectors are stored as a

JSON

Solution 

Manually copy the target

config.json

CommunityConnectors/[connector name]/config.json

• Find the correctly configured

  config.json

  . A correctly configured connector should have the field filled for the

  value

   key under a parameter node like

  redirect_uri

   or

  client_id 

  and

  client_secret

  , etc.
  

• Copy the file to each node of the cluster and replace the un-configured file with this one.

Configure a cluster environment for Community Connectors starting in Strategy 2021

Description 

Starting in Strategy 2021, when following the product documentation for configuring and deploying Community Connectors, the OAuth Application information is stored into MD of I-Server, instead of the Configuration files in Community Connectors. Since the information is no longer stored in Community Connectors, there is no need to modify the JSON configuration file for each connector (starting in Strategy 2021). 

Solution 

A separate file,

cluster.properties

• Choose any Community Connector node and find the configuration file from

  CommunityConnectors/WEB-INF/classes/cluster.properties

  . 
• Edit the configuration file to enable cluster mode and provide a synchronizedID for the cluster. All Community Connectors in the same cluster should share the same synchronizedID. It is recommended to use a random string containing more than 10 characters for the value.
  Note: For m2021GA, you will see “cluster.password“ instead of “cluster.synchronizedID“ in the configuration file. To avoid misleading users to put their passwords in the configuration file. We change it to synchronizedID in a later release.

• Copy and replace the configuration file

  cluster.properties

  to other nodes.
• Restart all Community Connectors in the cluster.
• Each time after the re-deployment or upgrade of Community Connectors, users should re-configure the above file.

Related Documentation 

Configure Connectors on the Setup Page ​​​​​
Deploy Connectors to MicroStrategy Web