Exclusive for MongoDB Sharded Cluster. See Add Shard.
Remove Shard
Exclusive for MongoDB Sharded Cluster. See Remove Shard.
Change RPC API Token
Serves as the authentication string by ClusterControl UI to connect to CMON RPC interface. Each cluster has its own unique token.
Disable/Enable Cluster Recovery
Disable or enable cluster recovery.
This feature works similarly with the automatic recovery (cluster) toggle button in the summary bar. However, it applies the modification permanently into the CMON configuration file for persistency.
Disable/Enable Node Recovery
Disable or enable node recovery. This feature works similarly with the automatic recovery toggle buttons in the summary bar.
This feature works similarly with the automatic recovery (node) toggle button in the summary bar. However, it applies the modification permanently into the CMON configuration file for persistency.
Schedule Maintenance Mode
Schedules a cluster-wide maintenance mode, where ClusterControl will skip raising up alarms and notifications while the mode is active.
All nodes in the cluster (regardless of the role) will be marked under maintenance. A global banner will appear if there is upcoming maintenance for the corresponding cluster.
Delete Cluster
Unregister a database cluster from the ClusterControl UI. This action will remove the selected CMONAPI URL and token for the corresponding cluster and will NOT uninstall the actual database cluster.
You can still re-register your cluster to ClusterControl at a later stage.
Deregister Cluster from UI
Unregister a database cluster from the ClusterControl UI.
You can still re-register your cluster to ClusterControl at a later stage by using Cluster Registrations.
Note
You can retrieve the RPC API Token value directly from respective <span class="pre">/etc/cmon.d/cmon_{clusterID}.cnf</span>.
Convert to Shard
Converts an existing MongoDB replica set to a sharded cluster by adding Mongos and config servers into the setup.
Configuration Servers and Routers
Configuration Server
Field
Description
Server Port
MongoDB config server port. Default is 27019.
Add Configuration Servers
Specify the IP address or hostname of the MongoDB config servers. A minimum of one node is required, recommended to use three nodes.
Routers/Mongos
Field
Description
Server Port
MongoDB Mongos server port. The default is 27017.
Add More Routers
Specify the IP address or hostname of the MongoDB Mongos.
Database Settings
Field
Description
Server Data Directory
Location of MongoDB data directory. Default is <span class="pre">/var/lib/mongodb</span>.
mongodb.conf Template
MongoDB configuration template file under <span class="pre">/usr/share/cmon/templates</span>. Default is <span class="pre">mongodb.conf.org</span>. Keep it default is recommended.
mongos.conf Template
MongoDB configuration template file under <span class="pre">/usr/share/cmon/templates</span>. Default is <span class="pre">mongos.conf.org</span>. Keep it default is recommended.
Install Software
Check the box if you use clean and minimal VMs. Existing MySQL dependencies will be removed. New packages will be installed and existing packages will be uninstalled when provisioning the node with the required software.
If unchecked, existing packages will not be uninstalled, and nothing will be installed. This requires that the instances have already provisioned the necessary software.
Disable Firewall
Check the box to disable the firewall (recommended).
Disable AppArmor/SELinux
Check the box to let ClusterControl disable AppArmor (Ubuntu) or SELinux (Redhat/CentOS) if enabled (recommended).
Deploy
Starts the MongoDB Sharded Cluster deployment.
Add Shard
Adds a new shard. Once the new shard has been added to the cluster, the MongoDB shard router will start to assign new chunks to it, and the balancer will automatically balance all chunks over all the shards.
Define Shards
Field
Description
Replica Set Name
Specify a name for this replica set shard.
Server Port
MongoDB shard server port. The default is 27018.
Hostname
Specify the IP address or hostname of the MongoDB shard servers. A minimum of one node is required, recommended to use three nodes
Advanced Options
Click on this to open a set of advanced options for this particular node in this shard:
Add slave delay – Specify the amount of delayed slave in milliseconds format.
Act as an arbiter – Toggle to ‘Yes’ if the node is an arbiter node. Otherwise, choose ‘No’.
Database Settings
Field
Description
Server Data Directory
Location of MongoDB data directory. Default is <span class="pre">/var/lib/mongodb</span>.
mongodb.conf Template
MongoDB configuration template file under <span class="pre">/usr/share/cmon/templates</span>. Default is <span class="pre">mongodb.conf.org</span>. Keep it default is recommended.
mongos.conf Template
MongoDB configuration template file under <span class="pre">/usr/share/cmon/templates</span>. Default is <span class="pre">mongos.conf.org</span>. Keep it default is recommended.
Install Software
Check the box if you use clean and minimal VMs. Existing MySQL dependencies will be removed. New packages will be installed and existing packages will be uninstalled when provisioning the node with the required software.
If unchecked, existing packages will not be uninstalled, and nothing will be installed. This requires that the instances have already provisioned the necessary software.
Disable Firewall
Check the box to disable the firewall (recommended).
Disable AppArmor/SELinux
Check the box to let ClusterControl disable AppArmor (Ubuntu) or SELinux (Redhat/CentOS) if enabled (recommended).
Deploy
Starts the MongoDB Sharded Cluster deployment.
Add Node
Scales the current MongoDB Replica Set or Sharded Cluster deployment by adding a single shard, Mongos, or config server.
Add Node to Replica Set
Adds a replica member or arbiter node.
Field
Description
Node Type
DB server – MongoDB node to be part of the same replica set.
Arbiter
MongoDB arbiter node to be part of the same replica set.
You can add an arbiter to an existing MongoDB node or a new node. If you are doing this, choose “No” under Install Software.
Hostname
IP address or hostname of the target host.
Port
MongoDB port. Default is 27017 for MongoDB replica set and 3000 for MongoDB arbiter node.
Configuration
Configuration template must exist under ClusterControl → Manage → Configurations → Templates. Use the Mongod (shard) configuration file for this deployment.
Replica set
Choose the replica set.
Install Software
Install the required software to run the database. This includes a MongoDB server/client together with dependencies.
Disable Firewall
Yes – To disable firewall during deployment (recommended).
No – Firewall settings will be untouched.
Disable AppArmor/SELinux
Check the box to let ClusterControl disable AppArmor (Ubuntu) or SELinux (Redhat/CentOS) if enabled.
Add Routers/Mongos
Field
Description
Hostname
IP address or hostname of the mongo host.
Port
MongoDB port. The default is 27018.
Configuration
Configuration template must exist under ClusterControl → Manage → Configurations → Templates. Use the mongos configuration file for this deployment.
Install Software
Installs the required software to run the database. This includes a MongoDB server/client together with dependencies.
Disable Firewall
Yes – To disable firewall during deployment (recommended).
No – Firewall settings will be untouched.
Disable AppArmor/SELinux
Check the box to let ClusterControl disable AppArmor (Ubuntu) or SELinux (Redhat/CentOS) if enabled.
Remove Shard
Removes or moves a replica set in a sharded cluster setup. Removing shards is a bit harder than to add a shard, as this involves moving the data to the other shards before removing the shard itself. For all data that has been shared overall shards, this will be a job performed by the MongoDB balancer.
Field
Description
Remove Replica Set
Choose the shard you want to remove.
Move to Replica Set
Moves the selected shards to another shard/replica set. Any non-sharded database/collection, that was assigned this shard as its primary shard, needs to be moved to another shard and made its new primary shard. For this process, MongoDB needs to know where to move these non-sharded databases/collections too.
Remove Shard
Click the button to proceed.
Shard Servers, Config Servers & Mongos Servers
The ops counter graph provides an overview of the aggregated operation on the MongoDB shard servers. For the sharded cluster, there will be another two sections for Config and Mongos Servers
Field
Description
Dash Settings
Customize the Cluster Load dashboard. See Custom Dashboard section.
Query
The number of aggregated queries across all nodes.
Insert
The number of aggregated insert commands across all nodes.
Update
The number of aggregated update commands across all nodes.
Delete
The number of aggregated delete commands across all nodes.
Getmore
The number of aggregated gets more command across all nodes.
Command
The total of all commands running across all nodes.
Custom Dashboard
Customize your dashboard on the Overview page by selecting which metrics and graphs to display. The created custom dashboards will appear as tabs beside Dash Settings
Field
Description
Dashboard Name
Give a name to the dashboard.
Metric
Select an available metric from the list.
Scale
Choose between linear or logarithmic graph scale.
Selected as Default Graph
Choose Yes if you want to set the graph as default when viewing the Overview page.
Note
You can rearrange dashboard order by drag and drop above.
Nodes Statistics
This provides a summary of host and replication-related stats for all nodes. Each database cluster has its own set of statistics as explained below:
Field
Description
Node
MongoDB instance consists of the node’s IP address or hostname and MongoDB service port.
Role
Instance role:
Primary – The primary node receives all write operations.
Secondary – Secondaries replicate operations from the primary to maintain an identical data set.
ConfigSvr – Stores the metadata for a sharded cluster.
Arbiter – Mongod instances that are part of a replica set but do not hold data. Arbiters participate in elections in order to break ties.
Message
Latest MongoDB status on the instance.
Uptime
MongoDB service uptime.
Global Lock
Ratio – The value of the ratio displays the relationship between lock time and total time. See serverStatus.globalLock.ratio.
Shows collected system statistics in a grid as below:
Field
Description
Ping
Ping round trip from ClusterControl host to each host in microseconds.
CPU Util(%)
Total CPU utilization in percentage.
Loadavg 1/5/15
Load value captured for 1, 5, and 15 minutes average.
Net tx/s / rx/s
Amount of data transmitted and received by the host.
Disk Read/sec
Disk read of <span class="pre">monitored_mountpoint</span>.
Disk Writes/sec
Disk write of <span class="pre">monitored_mountpoints</span>.
Uptime
Host uptime.
Last Updated
The last time ClusterControl fetch for host’s status.
Attention
Starting from ClusterControl 1.9.7 (September 2023), ClusterControl GUI v2 is the default frontend graphical user interface (GUI) for ClusterControl. Note that the GUI v1 is considered a feature-freeze product with no future development. All new developments will be happening on ClusterControl GUI v2. See User Guide (GUI v2).