Deploy a Replica Set
On this page
A replica set is a group of MongoDB deployments that maintain the same data set. Replica sets provide redundancy and high availability and are the basis for all production deployments.
To learn more about replica sets, see the Replication Introduction in the MongoDB manual.
Use this procedure to deploy a new replica set managed by Ops Manager. After deployment, use Ops Manager to manage the replica set, including such operations as adding, removing, and reconfiguring members.
Note
Added in Ops Manager 4.0
You can use Kubernetes to deploy MongoDB instances with Ops Manager version 4.0 or later.
To learn how to deploy a replica set using a Kubernetes object, see Deploy a Replica Set in the MongoDB Enterprise Kubernetes Operator documentation.
Prerequisites
To deploy MongoDB clusters, you must provision hosts to serve those clusters. Ops Manager requires access to these hosts.
Important
If you run MongoDB Enterprise and provision your own Linux hosts, then you must manually install a set of dependencies to each server before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies.
To learn more about the specifics for an operating system, see the following:
Considerations
Unique Names for Replica Set
Use a unique name for the replica set.
Important
Replica set, sharded cluster, and shard names within the same project must be unique. Failure to have unique names for the deployments will result in broken backup snapshots.
Procedure
Navigate to the Deployment page for your project.
If it is not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.
If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
If it is not already displayed, click Deployment in the sidebar.
Configure Cluster-Wide Settings.
The Replica Set Configuration section contains the following cluster-wide configuration settings. Settings marked with an * asterisk in the Ops Manager UI are required.
Setting | Description |
---|---|
Replica Set Id | Enter the name of your replica set deployment. You cannot change
this once set. This setting corresponds to the
|
Replica Set Settings | Displays an table of each process associated with the replica set. You can configure the MongoDB server version, data directory, and log path of each process. |
Process Name | Hostname and port of a Ops Manager applies any settings configured for the replica set to all of its associated processes. |
Version | Select the MongoDB server version of the Ops Manager lists only the MongoDB versions that are available for your deployment. To disable this filtering, see
|
Data Directory | Specify the directory where the Each |
Log File | Specify the full path to the For example, specifying The |
Configure each Replica Set Member.
Ops Manager lists each replica set member under the MongoD Settings heading of the Member Configuration section. Each replica set member has the following options:
Setting | Description |
---|---|
Member | Select one of the following replica set member roles from the menu:
|
Hostname | Select from the menu the host to which Ops Manager Automation deploys the replica set member. The menu only lists hosts under Ops Manager Automation. For complete documentation on adding servers to Ops Manager Automation, see Provision Servers for Automation. This hostname can be a hostname, an FQDN, an IPv4 address, or an IPv6 address. |
Port | Specify the IANA port
number for the The |
Votes | |
Priority | |
Delay | Specify the number of seconds "behind" the primary member this
member should "lag". This setting corresponds to the
|
Build Indexes | Specify |
Tags | Specify the tag or tags associated to the replica set.
This setting corresponds to the
For complete documentation on replica set tags, see Replica Set Tags |
Add a Mongod |
Configure your Replication Settings.
The Replication Settings section contains the following configuration options for the replica set:
Setting | Description |
---|---|
Protocol Version | Select the replication protocol version used by the replica set.
This setting corresponds to the
For more information, see Replica Set Protocol Versions. |
Chaining Allowed | Specify |
Write Concern Majority Journal Default | Determines the behavior of
|
Heartbeat Timeout (secs) | Specify the number of seconds that the replica set members wait for
a successful heartbeat from each other. This setting corresponds to
the |
Election Timeout (ms) | Specify the time limit in milliseconds for detecting when a replica
set's primary is unreachable. This setting corresponds to
the |
CatchUp Timeout (ms) | Specify the time limit in milliseconds for a newly elected
primary to sync, or catch up, with the other replica
set members that may have more recent writes. This setting
corresponds to the
|
CatchUp Takeover Delay (ms) | Specify the time in milliseconds a node waits to initiate a
catchup takeover after determining it is ahead of the
current primary. This setting corresponds to the
|
Last Error Defaults | Specify the default write concern for the replica set. The replica set uses this write concern only when write operations or getLastError specify no other write concern. If this option is not set, the default write concern for the replica set only requires confirmation from the primary. Specify this option in the form of a document, i.e., |
Force Reconfigure | Specify that you want to force a reconfiguration of the replica
set. When set to WARNING: Forcing a replica set reconfiguration might lead to a rollback of majority-committed writes. Proceed with caution. Contact MongoDB Support if you have questions about the potential impacts of this operation. To learn more, see Reconfigure a Replica Set with Unavailable Members in the MongoDB Server Manual. |
Set the default read and write concerns for your MongoDB replica set.
In the Default Read Concerns/Write Concerns card, you configure the default level of acknowledgement requested from MongoDB for read and write operations for this cluster. Setting the default read and write concern can help with MongoDB 5.0 and later deployments using arbiters.
From the Default Read Concerns section, you can set consistency and isolation properties for the data read from the cluster.
Select the default read concern from the Level dropdown menu. You can choose from the following values:
From the Default Write Concerns section, you configure the default level of acknowledgment requested from MongoDB for write operations from the cluster. You can set three parameters:
Parameter | Value |
---|---|
w Option | Desired number of
|
j Option | Flag that indicates whether the write acknowledgement must be written to the on-disk journal. |
w Timeout | Desired time limit for the write concern expressed in
milliseconds. Set this value when you set w to a value
greater than |
Set any advanced configuration options for your MongoDB replica set.
The Advanced Configuration Options section allows you to set MongoDB runtime options for each MongoDB process in your deployment.
To add an option:
Click Add Advanced Options.
Click Select a Startup Option and select the configuration option.
Ops Manager displays a context-sensitive input for configuring an acceptable value for the selected option.
Click Add to add the selected option and its corresponding value to every process of the selected process type in the cluster.
Ops Manager lists each process in the cluster grouped logically. Click the grey arrow to the left of the logical grouping to display its sub-groupings and processes. You can modify the advanced options for each process individually as necessary.
For descriptions of the available Advanced Configuration Options, see Advanced Options for MongoDB Deployments.