Convert a Self-Managed Replica Set to a Sharded Cluster将自管理副本集转换为分片群集

Get the Existing Users and Roles from the Replica Set从副本集中获取现有用户和角色

To get existing users and roles, run mongodump:要获取现有用户和角色，请运行mongodump：

mongodump -d=admin --out=adminDump -u <adminUser> -p <password> --host <replicaSetURI> --dumpDbUsersAndRoles

Deploy the Config Server Replica Set部署配置服务器副本集

Deploy a three-member replica set for the config servers. In this example, the config servers use the following hosts:为配置服务器部署一个由三个成员组成的副本集。在此示例中，配置服务器使用以下主机：

• mongodb7.example.net
• mongodb8.example.net
• mongodb9.example.net

1. Configure the Config Servers配置配置服务器

   Configure a mongod instance on each config server host. Specify these options in the configuration file for each mongod instance:在每个配置服务器主机上配置一个mongod实例。在配置文件中为每个mongod实例指定这些选项：

   Option选项	Value值
   replication.replSetName	configReplSet
   sharding.clusterRole	configsvr
   net.bindIp	localhost, followed by any other hostnames on which the mongod should listen for client connections.，后面是mongod应该监听客户端连接的任何其他主机名。

   replication:
     replSetName: configReplSet
   sharding:
     clusterRole: configsvr
   net:
     bindIp: localhost,<ipaddress>

   Include additional options as appropriate for your deployment.根据部署情况，包括其他选项。

2. Start the Config Servers启动配置服务器

   Deploy the mongod with your specified configuration:使用您指定的配置部署mongod：

   mongod --config <PATH_TO_CONFIG_FILE>

   The config servers use the default data directory /data/configdb and the default port 27019.配置服务器使用默认数据目录/data/configdb和默认端口27019。

3. Connect to one of the config servers.连接到其中一个配置服务器。

   Use mongosh to connect to one of the config servers. For example:使用mongosh连接到其中一个配置服务器。例如：

   mongosh "mongodb://mongodb7.example.net:27019"

4. Initiate the config server replica set.启动配置服务器副本集。

   To initiate the replica set, run rs.initiate():要启动副本集，请运行rs.initiate()：

   rs.initiate( {
      _id: "configReplSet",
      configsvr: true,
      members: [
         { _id: 0, host: "mongodb7.example.net:27019" },
         { _id: 1, host: "mongodb8.example.net:27019" },
         { _id: 2, host: "mongodb9.example.net:27019" }
      ]
   } )

   The preceding command uses the localhost exception to perform administrative actions without authentication.前面的命令使用localhost异常执行管理操作，而无需身份验证。

   Important

   Run rs.initiate() on only one mongod instance for the replica set.仅对副本集的一个mongod实例运行rs.initiate()。

Restore Existing Users and Roles to the New Config将现有用户和角色还原到新配置

Restore the existing users and roles you got when you ran mongodump.恢复运行mongodump时获得的现有用户和角色。

mongorestore ./adminDump --nsInclude "admin.*" --host <configPrimaryURI>

The preceding command uses the localhost exception to perform administrative actions without authentication.前面的命令使用localhost异常执行管理操作，而无需身份验证。

The output from running this command may be similar to:运行此命令的输出可能类似于：

0 document(s) restored successfully

This message does not indicate a problem. This output means that 0 documents other than the users and roles were restored.此消息并不表示有问题。此输出表示已还原除用户和角色之外的0个文档。

Secure Config Server Replica Set安全配置服务器副本集

Reconfigure and restart the config server replica set.重新配置并重新启动配置服务器副本集。

1. Reconfigure the Config Servers重新配置配置服务器

   Select the tab for your authentication mechanism:选择身份验证机制的选项卡：

   Keyfile Authentication

   Restart a mongod instance on each of these hosts:在以下每台主机上重新启动一个mongod实例：

   • mongodb7.example.net
   • mongodb8.example.net
   • mongodb9.example.net

   Specify these options in the configuration file for each mongod instance:

   Option选项	Value
   security.keyFile	The path to the key file used for your initial replica set.

   security:
      keyFile: <PATH_TO_KEYFILE>
   replication:
      replSetName: configReplSet
   sharding:
      clusterRole: configsvr
   net:
      bindIp: localhost,<ipaddress>

   Include additional options as appropriate for your deployment.根据部署情况，包括其他选项。

   X.509 Authentication

   Restart a mongod instance on each of these hosts:

   • mongodb7.example.net
   • mongodb8.example.net
   • mongodb9.example.net

   Specify these options in the configuration file for each mongod instance in addition to the options you already configured:

   Option选项	Value
   security.clusterAuthMode	x509
   net.tls.mode	requireTLS
   net.tls.certificateKeyFile	The absolute path to the .pem file that contains both the TLS certificate and key.
   net.tls.CAFile	The absolute path to the .pem file that contains the root certificate chain from the Certificate Authority.
   net.bindIp	localhost, followed by any other hostnames on which the mongod should listen for client connections. WARNING: Before you bind your instance to a publicly-accessible IP address, you must secure your cluster from unauthorized access. For a complete list of security recommendations, see Security Checklist for Self-Managed Deployments. At minimum, consider enabling authentication and hardening network infrastructure.

   sharding:
      clusterRole: configsvr
   replication:
      replSetName: configReplSet
   security:
      clusterAuthMode: x509
   net:
      tls:
         mode: requireTLS
         certificateKeyFile: <FILE_WITH_COMBINED_CERT_AND_KEY>
         CAFile: <CA_FILE>
      bindIp: localhost,<ipaddress>

   Include additional options as appropriate for your deployment, such as net.tls.certificateKeyFilePassword if your TLS certificate-key file is encrypted with a password.

2. Restart MongoDB

   Restart the mongod with your specified configuration:使用指定的配置重新启动mongod：

   mongod --config <PATH_TO_CONFIG_FILE> --shutdown
   mongod --config <PATH_TO_CONFIG_FILE>

Deploy the mongos

The mongos provides the interface between the client applications and the sharded cluster.mongos提供了客户端应用程序和分片集群之间的接口。

1. Create a configuration file for the mongos.为mongos创建一个配置文件。

   Keyfile Authentication

   Specify these options in your mongos configuration file:在mongos配置文件中指定这些选项：

   Option选项	Value
   sharding.configDB	configReplSet, followed by a slash / and at least one of the config server hostnames and ports.
   security.keyFile	The path to the key file used for your initial replica set.
   net.bindIp	localhost, followed by any other hostnames on which the mongos should listen for client connections.

   sharding:
      configDB: configReplSet/mongodb7.example.net:27019,mongodb8.example.net:27019,mongodb9.example.net:27019
   security:
      keyFile: <PATH_TO_KEYFILE>
   net:
      bindIp: localhost,<ipaddress>

   Include additional options as appropriate for your deployment.根据部署情况，包括其他选项。

   X.509 Authentication

   Specify these options in your mongos configuration file:在mongos配置文件中指定这些选项：

   Option选项	Value
   sharding.configDB	configReplSet, followed by a slash / and at least one of the config server hostnames and ports.
   security.clusterAuthMode	x509
   net.tls.mode	requireTLS
   net.tls.certificateKeyFile	The absolute path to the .pem file that contains both the TLS certificate and key.
   net.tls.CAFile	The absolute path to the .pem file that contains the root certificate chain from the Certificate Authority.包含来自证书颁发机构的根证书链的pem文件的绝对路径。
   net.bindIp	localhost, followed by any other hostnames on which the mongos should listen for client connections.

   sharding:
      configDB: configReplSet/mongodb7.example.net:27019,mongodb8.example.net:27019,mongodb9.example.net:27019
   security:
      clusterAuthMode: x509
   net:
      tls:
         mode: requireTLS
         certificateKeyFile: <FILE_WITH_COMBINED_CERT_AND_KEY>
         CAFile: <CA_FILE>
      bindIp: localhost,<ipaddress>

   Include any additional options appropriate for your deployment.

2. Deploy the mongos.

   Deploy the mongos with your specified configuration:

   mongos --config <PATH_TO_CONFIG_FILE>

Restart the Initial Replica Set as a Shard将初始副本集作为分片重新启动

In this example, your initial replica set is a three-member replica set. This step updates the initial replica set so that it can be added as a shard to your sharded cluster.在这个例子中，初始副本集是一个由三个成员组成的副本集。此步骤更新初始副本集，以便将其作为分片添加到分片集群中。

The replica set runs on these hosts:副本集在以下主机上运行：

• mongodb0.example.net:27017
• mongodb1.example.net:27017
• mongodb2.example.net:27017

For sharded clusters, you must set the role for each mongod instance in the shard to shardsvr. 对于分片集群，您必须将分片中每个mongod实例的角色设置为shardsvr。To specify the server role, set the sharding.clusterRole setting in the mongod configuration file.要指定服务器角色，请在mongod配置文件中设置sharding.clusterRole设置。

1. Connect to a member of your initial replica set.连接到初始副本集的成员。

   Use mongosh to connect to one of the members of your initial replica set.

   Keyfile Authentication

   mongosh "mongodb://<username>@mongodb0.example.net:27017"

   X.509 Authentication

   If your deployment uses X.509 authentication, specify these mongosh options:

   • --tls
   • --tlsCAFile
   • --tlsCertificateKeyFile

   For example:例如：

   mongosh "mongodb://<username>@mongodb0.example.net:27017" --tls --tlsCAFile <CA_FILE> --tlsCertificateKeyFile <filename>

2. Determine the replica set's primary and secondaries.确定副本集的主副本和次副本。

   Run rs.status() to determine the primary and secondaries:运行rs.status()以确定主要和次要对象：

   rs.status()

   In the command output, the replSetGetStatus.members[n].stateStr field indicates which member is the primary and which members are secondaries.在命令输出中，replSetGetStatus.members[n].stateStr字段指示哪个成员是主要成员，哪些成员是次要成员。

3. Restart the secondaries with the --shardsvr option.

   Warning

   This step requires some downtime for applications connected to the replica set secondaries.此步骤要求连接到副本集二级的应用程序需要一些停机时间。

   Keyfile Authentication

   1. Connect to a secondary.连接到辅助设备。

      Use mongosh to connect to one of the secondaries.使用mongosh连接到其中一个次级服务器。

      mongosh "mongodb://<username>@<host>:<port>"

   2. Shut down the secondary.关闭辅助设备。

      Run the following commands:运行以下命令：

      use admin
      db.shutdownServer()

   3. Edit the secondary's configuration file.编辑辅助设备的配置文件。

      In the secondary's configuration file, set sharding.clusterRole to shardsvr:

      security:
         keyFile: <PATH_TO_KEYFILE>
      replication:
        replSetName: rs0
      sharding:
         clusterRole: shardsvr
      net:
         port: 27017
         bindIp: localhost,<ipaddress>

      Include additional options as appropriate for your deployment.根据部署情况，包括其他选项。

   4. Restart the secondary as a shard server.将辅助服务器作为分片服务器重新启动。

      Run the following command on the host containing the secondary:在包含辅助服务器的主机上运行以下命令：

      mongod --config <PATH_TO_CONFIG_FILE>

   5. Repeat the shut down and restart steps for the other secondary.对另一个辅助设备重复关闭和重新启动步骤。
   X.509 Authentication

   1. Connect to a secondary.

      Use mongosh to connect to one of the secondaries.

      If your deployment uses X.509 authentication, specify these mongosh options:

      • --tls
      • --tlsCAFile
      • --tlsCertificateKeyFile

      mongosh "mongodb://<username>@<host>:<port>" --tls --tlsCAFile <CA_FILE> --tlsCertificateKeyFile <filename>

   2. Shut down the secondary.

      Run the following commands:运行以下命令：

      use admin
      db.shutdownServer()

   3. Edit the secondary's configuration file.编辑辅助设备的配置文件。

      In the secondary's configuration file, set sharding.clusterRole to shardsvr:

      replication:
         replSetName: rs0
      sharding:
         clusterRole: shardsvr
      security:
         clusterAuthMode: x509
      net:
         port: 27017
         tls:
            mode: requireTLS
            certificateKeyFile: <FILE_WITH_COMBINED_CERT_AND_KEY>
            CAFile: <CA_FILE>
         bindIp: localhost,<ipaddress>

      Include additional options as appropriate for your deployment, such as net.tls.certificateKeyFilePassword if your TLS certificate-key file is encrypted with a password.

   4. Restart the secondary as a shard server.

      Run the following command on the host containing the secondary:在包含辅助服务器的主机上运行以下命令：

      mongod --config <PATH_TO_CONFIG_FILE>

   5. Repeat the shut down and restart steps for the other secondary.对另一个辅助设备重复关闭和重新启动步骤。

Restart the primary with the --shardsvr option.使用--shardsvr选项重新启动主服务器。

Add the Initial Replica Set as a Shard将初始副本集添加为分片

After you convert the initial replica set (rs0) to a shard, add it to the sharded cluster.将初始副本集（rs0）转换为分片后，将其添加到分片集群中。

1. Connect to the mongos as your cluster's administrative user.

   The mongos instance is running on host mongodb6.example.net.

   Keyfile Authentication

   To connect mongosh to the mongos, run the following command:

   mongosh "mongodb://admin01@mongodb6.example.net:27017"

   X.509 Authentication

   If your deployment uses X.509 authentication, specify these mongosh options:

   If your deployment uses X.509 authentication, specify these mongosh options:

   • --tls
   • --tlsCAFile
   • --tlsCertificateKeyFile

   mongosh "mongodb://admin01@mongodb6.example.net:27017" --tls --tlsCAFile <CA_FILE> --tlsCertificateKeyFile <filename>

   This command authenticates you as the admin01 user you created on the sharded cluster. After you enter the command, enter your user's password.

2. Add the shard.

   To add a shard to the cluster, run the sh.addShard() method:

   sh.addShard( "rs0/mongodb0.example.net:27017,mongodb1.example.net:27017,mongodb2.example.net:27017" )

Update Your Application Connection String更新应用程序连接字符串

After you add the first shard to your cluster, update the connection string used by your applications to the connection string for your sharded cluster. Then, restart your applications.

Deploy a Second Replica Set

Deploy a new replica set called rs1. The members of replica set rs1 are on the following hosts:部署一个名为rs1的新副本集。副本集rs1的成员位于以下主机上：

• mongodb3.example.net
• mongodb4.example.net
• mongodb5.example.net

1. Start each member of the replica set.启动副本集的每个成员。

   Keyfile Authentication

   For each mongod instance in the replica set, create a configuration file with these options:

   Option选项	Value
   security.keyFile	The path to the key file used for your initial replica set.
   replication.replSetName	rs1
   sharding.clusterRole	shardsvr
   net.bindIp	localhost, followed by any other hostnames on which the mongod should listen for client connections.

   security:
      keyFile: <PATH_TO_KEYFILE>
   replication:
      replSetName: rs1
   sharding:
      clusterRole: shardsvr
   net:
      bindIp: localhost,<ipaddress>

   Include additional options as appropriate for your deployment.根据部署情况，包括其他选项。

   X.509 Authentication

   For each member, start a mongod with the following options:

   Option选项	Value
   replication.replSetName	rs1
   sharding.clusterRole	shardsvr
   security.clusterAuthMode	x509
   net.tls.mode	requireTLS
   net.tls.certificateKeyFile	The absolute path to the .pem file that contains both the TLS certificate and key.
   net.tls.CAFile	The absolute path to the .pem file that contains the root certificate chain from the Certificate Authority.
   net.bindIp	localhost, followed by any other hostnames on which the mongod should listen for client connections.

   replication:
      replSetName: rs1
   sharding:
      clusterRole: shardsvr
   security:
      clusterAuthMode: x509
   net:
      tls:
         mode: requireTLS
         certificateKeyFile: <FILE_WITH_COMBINED_CERT_AND_KEY>
         CAFile: <CA_FILE>
      bindIp: localhost,<ipaddress>

   Deploy the mongod with your specified configuration:

   mongod --config <PATH_TO_CONFIG_FILE>

   Note

   When you specify the --shardsvr option for a mongod instance, the instance runs on port 27018 by default.当您为mongod实例指定--shardsvr选项时，该实例默认在端口27018上运行。

2. Start each member of the replica set.启动副本集的每个成员。

3. Connect to a replica set member.连接到副本集成员。

   Use mongosh to connect to one of the replica set members. For example:使用mongosh连接到副本集成员之一。例如：

   Keyfile Authentication

   mongosh "mongodb://mongodb3.example.net:27018"

   X.509 Authentication

   mongosh "mongodb://mongodb3.example.net:27018" --tls --tlsCAFile <CA_FILE> --tlsCertificateKeyFile <filename>

4. Initiate the replica set.

   In mongosh, run the rs.initiate() method to initiate a replica set that contains the current member:

   rs.initiate( {
      _id : "rs1",
      members: [
          { _id: 0, host: "mongodb3.example.net:27018" },
          { _id: 1, host: "mongodb4.example.net:27018" },
          { _id: 2, host: "mongodb5.example.net:27018" }
      ]
   } )

   The preceding command requires the localhost exception to perform administrative actions without authentication.

   Important

   Run rs.initiate() on only one mongod instance for the replica set.

5. Add an administrative user for the replica set.为副本集添加管理用户。

   After you deploy the replica set, use the localhost exception to create the replica set's first user.

   1. Determine the replica set primary.确定主副本集。

      To determine the primary, run rs.status():

      rs.status()

      In the command output, the replSetGetStatus.members[n].stateStr field indicates which member is the primary.

   2. Connect to the replica set primary.连接到主副本集。

      Connect to the replica set primary with mongosh. For example, if the primary is mongodb4.example.net, run this command:使用mongosh连接到主副本集。例如，如果主服务器是mongodb4.example.net，请运行以下命令：

      Keyfile Authentication

      mongosh "mongodb://mongodb4.example.net:27018"

   3. Create an administrative user.

      Run the following db.createUser() method to create a user named rs1Admin with the userAdmin role:

      use admin
      
      db.createUser(
         {
            user: "rs1Admin",
            pwd: passwordPrompt(),
            roles: [
               { role: "userAdmin", db: "admin" }
            ]
         }
      )

      After you run the command, the database prompts you to enter a password for the rs1Admin user.

Add the Second Replica Set to the Cluster as a Shard将第二个副本集作为分片添加到集群中

Add the new replica set, rs1, to the sharded cluster.将新的副本集rs1添加到分片集群中。

1. Connect mongosh to the mongos.把mongosh和mongos联系起来。

   Run the following command from the command line to connect to the mongos instance running on host mongodb6.example.net:

   Keyfile Authentication

   mongosh "mongodb://admin01@mongodb6.example.net:27017/admin"

   X.509 Authentication

   mongosh "mongodb://admin01@mongodb6.example.net:27017/admin" --tls --tlsCAFile <CA_FILE> --tlsCertificateKeyFile <filename>

   This command authenticates you as the admin01 user you created on the sharded cluster. After you enter the command, enter your user's password.

2. Add the second shard.

   After you connect to the mongos, add the replica set rs1 as a shard to the cluster with the sh.addShard() method:

   sh.addShard( "rs1/mongodb3.example.net:27018,mongodb4.example.net:27018,mongodb5.example.net:27018" )

Shard a Collection分片集合

The final step of the procedure is to shard a collection in the sharded cluster.该过程的最后一步是在分片集群中对集合进行分片。

1. Determine the shard key.确定分片键。

   Determine the shard key for the collection. The shard key indicates how MongoDB distributes the documents between shards. Good shard keys:

   • Have values that are evenly distributed among all documents.
   • Group documents that are often accessed at the same time into contiguous chunks.
   • Allow for effective distribution of activity among shards.

   For more information, see Choose a Shard Key.

   This procedure uses the number field as the shard key for the test_collection collection.

2. Create an index on the shard key.

   Before you shard a non-empty collection, create an index on the shard key:

   use test
   db.test_collection.createIndex( { "number" : 1 } )

3. Shard the collection.

   In the test database, shard the test_collection. Specify number as the shard key.

   sh.shardCollection( "test.test_collection", { "number" : 1 } )

   The next time that the balancer runs, it redistributes chunks of documents between shards. As clients insert additional documents into this collection, the mongos routes the documents to the appropriate shard.

   When the balancer redistributes chunks, it may negatively impact your application's performance. To minimize performance impact, you can specify when the balancer runs so it does not run during peak hours. 当平衡器重新分配块时，可能会对应用程序的性能产生负面影响。为了尽量减少对性能的影响，您可以指定平衡器何时运行，这样它就不会在高峰时段运行。To learn more, see Schedule the Balancing Window.要了解更多信息，请参阅计划平衡窗口。