Docs Menu

Docs HomeAtlas Open Service Broker

Deploy a Replica Set

On this page

  • Prerequisites
  • Considerations
  • Procedure


Atlas Open Service Broker is deprecated. Use the MongoDB Atlas Operator instead.

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.

You can use the Atlas Open Service Broker to deploy a new replica set managed by Atlas. After deployment, use Atlas to manage monitoring, backups, and project configuration such as VPC peering or billing.

You create Atlas replica sets by defining an object. To deploy a replica set using an Kubernetes object, you must first install the Atlas Open Service Broker.

Atlas Open Service Broker uses the Create a Cluster endpoint of the Atlas Public API to deploy replica sets. Any requirements or limitations of the API also apply to the Atlas Open Service Broker.

  1. Copy one of the following resource definition examples based on the scope of your service broker instance.

    If you registered the Atlas Open Service Broker instance as a cluster-scoped ClusterServiceBroker, select Cluster-scoped Instance. If you registered the Atlas Open Service Broker instance as a namespace-scoped ServiceBroker, select Namespace-scoped Instance.

  2. Open your preferred text editor and paste the resource definition into a new text file.


The highlighted settings are required to deploy a replica set:


You can specify additional cluster settings under the spec.parameters.cluster key. These settings correspond to the request body parameters of the Create a Cluster Public API method.


The following API parameters are overwritten by the required Atlas Open Service Broker settings from the previous step and should not be specified:

  • providerSettings.instanceSizeName

  • providerSettings.providerName

  • name


Invoke the following Kubernetes command to create your replica set:

kubectl apply -f replica-set.yaml

To view the status of your deployment, pass the from replica-set.yaml into the following command:

svcat describe instance <METADATA.NAME> -n <NAMESPACE>

As the replica set is being deployed, the command returns the following status:

Provisioning - The instance is being provisioned asynchronously

Once the replica set deploys successfully, the command returns the following status:

Ready - The instance was provisioned successfully
←  Deploy ResourcesDeploy a Sharded Cluster →
Share Feedback
© 2023 MongoDB, Inc.


  • Careers
  • Investor Relations
  • Legal Notices
  • Privacy Notices
  • Security Information
  • Trust Center
© 2023 MongoDB, Inc.