BuycPanel Blog

BuycPanel Blog

Latest news and updates

What is the Configuration Cluster Interface?

Posted by Allura on 01 02 2018.

A Brief Overview

The Configuration Cluster interface would allow one to link a master server to one or more additional servers in the configuration cluster. The user can then choose to copy server configuration settings from Web Host Manager Update Preferences Interface:

Home >> Server Configuration >> Update Preferences to the configuration cluster’s servers.

An important fact is that after this feature is enabled, the user must also select the Send my settings to all configuration cluster servers checkbox in Web Host Manager’ Update Preferences interface (Home >> Server Configuration >> Update Preferences) on the master server. The interface would only display the checkbox after servers have been added to the configuration cluster.


What is a Configuration Cluster?

  • If the user logs in to the non-master configuration cluster server, the interface will not indicate that the server resides in the configuration cluster. You can only view this information on the master server.
  • If you make changes to the configuration cluster’s settings on a non-master server, the master server’s settings may overwrite those changes.


Before the configuration cluster is set up in the Configuration Cluster interface, the user needs to log in as a root-level user on the server that one wishes to use as the master server.

The user must also log in to the master server as a root-level user to make the configuration changes that you want to copy to the configuration cluster’s servers.

The Configuration Cluster interface would display a list of all of the servers that were linked to the currently-authenticated server.


ServerThe server’s IP address, or the name that you assigned to the server (for example,


You can use any other domain name that resolves to the server’s IP address for this value. However, to prevent problems if you migrate domains to another server, we recommend that you use the server’s hostname.

UserThe username of the server’s root-level account. This value defaults to the root user.
Remote Access KeyThe signature version of the server’s remote access key or API token.


Add a server.

To add a server to the configuration cluster, the following steps need to be performed:

  1. The operator has to Click Create at the top right or bottom right corner of the interface.
  2. The server name needs to be entered in the Server text box.

Special Notes:

  • The server’s root-level account username is to be entered  in the User text box.
  • The server’s remote access key is to be pasted or API token is to be pasted in the Remote Access Key text box.
  • The user can generate a remote access key in Web Host Manager’s Remote Access Key  interface (Home >> Clusters >> Remote Access Key).
  • The user can generate an API token In Web Host Manager’s Manage API Tokens interface (Home >> Development >> Manage API Tokens).
  • Click Save. The server will appear in the configuration cluster servers table.

Edit a server’s remote access key or API token

To modify the remote access key or API token for a server in the configuration cluster, the following steps need to be performed:

The arrow icon needs to be clicked that corresponds to the server for which the remote access key or API Token is to be modified.

  1. Make the desired changes in the User text box.
  2. Make the desired changes in the Remote Access Key text box.



The Remote Access Key text box displays either the current access key’s signature or API token. However, the user must enter the entire remote access key or API token to make changes. Click Save.


How to Delete a server from the configuration cluster:

To remove a server from the list of the configuration cluster’s servers, perform the following steps:

  1. Click the trash icon () that corresponds to the server that the user wishes to delete.
  2. A confirmation window will appear and the user has to click continue.


Configuration Cluster is an integral part of CPANEL. Using this feature the access key can be copied. A new access key can be generated thereafter. The access key includes the first 32 characters of the remote access key.