Docs Menu

Docs HomeAtlas Open Service Broker

Deploy a Sharded Cluster

On this page

  • Prerequisites
  • Considerations
  • Procedure


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

Sharded clusters provide horizontal scaling for large data sets and enable high-throughput operations by distributing the data set across a group of servers.

To learn more about sharding, see the Sharding Introduction in the MongoDB manual.

To deploy a new sharded cluster that Atlas can manage, use the Atlas Open Service Broker and Kubernetes. After deployment, use Atlas to add shards and perform other maintenance operations on the cluster.

You create Atlas sharded clusters by defining an object. To deploy a sharded cluster 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 API to deploy sharded clusters. Any requirements or limitations of that API also apply to the Atlas Open Service Broker.

  1. Copy one of the following resource definition examples based on the scope of your Atlas Open Service Broker instance.

    If you registered the Atlas Open Service Broker instance as:

    • A ClusterServiceBroker, select the Cluster-scoped Instance tab.

    • A ServiceBroker, select the Namespace-scoped Instance tab.

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


To deploy a sharded cluster, you must specify the following settings:


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 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 sharded cluster:

kubectl apply -f sharded-cluster.yaml

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

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

As the sharded cluster is being deployed, the command returns the following status:

Provisioning - The instance is being provisioned asynchronously

Once the sharded cluster deploys successfully, the command returns the following status:

Ready - The instance was provisioned successfully
←  Deploy a Replica SetEdit an Atlas Cluster →
Share Feedback
© 2023 MongoDB, Inc.


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