将自管理分片集群更新为使用密钥文件进行身份验证(无停机时间)
在此页面上
Overview
重要
The following procedure applies to sharded clusters using MongoDB 3.4 or later.
Earlier versions of MongoDB do not support no-downtime upgrade. For sharded clusters using earlier versions of MongoDB, see 将自管理分片集群更新为使用密钥文件进行身份验证.
A MongoDB sharded cluster can enforce user authentication as well as internal authentication of its components to secure against unauthorized access.
The following tutorial describes a procedure using
security.transitionToAuth
to transition an existing sharded
cluster to enforce authentication without incurring downtime.
Before you attempt this tutorial, please familiarize yourself with the contents of this document.
Considerations
Cloud Manager 或 Ops Manager
If you are using Cloud Manager or Ops Manager to manage your deployment, refer to Configure Access Control for MongoDB Deployments in the Cloud Manager manual or Ops Manager manual to enforce authentication.
IP 绑定
Internal and Client Authentication Mechanisms
This tutorial configures authentication using SCRAM for client authentication and a keyfile for internal authentication.
Refer to the 自主管理部署的身份验证 documentation for a complete list of available client and internal authentication mechanisms.
架构
This tutorial assumes that each shard replica set, as well as the config server replica set, can elect a new primary after stepping down its existing primary.
A replica set can elect a primary only if both of the following conditions are true:
A majority of voting replica set members are available after stepping down the primary.
There is at least one available secondary member that is not delayed, hidden, or Priority 0.
Minimum number of mongos
instances
Ensure your sharded cluster has at least two mongos instances
available. This tutorial requires restarting each mongos
in
the cluster. If your sharded cluster has only one mongos
instance, this results in downtime during the period that the
mongos
is offline.
Enforce Keyfile Access Control on an Existing Sharded Cluster
Create and Distribute the Keyfile
在使用密钥文件身份验证时,分片集群中的每个 mongod
或 mongos
实例将密钥文件内容作为共享密码,以对部署中的其他节点进行身份验证。仅具有正确密钥文件的 mongod
或 mongos
实例可以加入分片集群。
注意
用于内部成员身份验证的密钥文件使用 YAML 格式,允许在密钥文件中包含多个密钥。YAML 格式接受以下任一形式:
单个密钥字符串(与早期版本相同)
键字符串序列
YAML 格式与使用文本文件格式的现有单密钥文件兼容。
密钥长度必须在 6 到 1,024 个字符之间,并且只能包含 base64 集合中的字符。分片集群的所有节点必须共享至少一个通用的密钥。
注意
在 UNIX 系统上,密钥文件不得具有群组或全局权限。在 Windows 系统中,不检查密钥文件权限。
您可以选择任何方法生成密钥文件。例如,以下操作使用 openssl
生成复杂的伪随机 1024 字符串以用作共享密码。然后,它使用 chmod
更改文件权限,仅为文件所有者提供读取权限:
openssl rand -base64 755 > <path-to-keyfile> chmod 400 <path-to-keyfile>
将密钥文件复制到每台托管分片集群成员的服务器上。确保运行 mongod
或 mongos
实例的用户是文件的所有者并且可以访问密钥文件。
避免将密钥文件存储在可以轻松与托管 mongod
或 mongos
实例的硬件断开连接的存储介质上,例如 USB 驱动器或联网存储设备。
For more information on using keyfiles for internal authentication, refer to Keyfiles.
Configure Sharded Cluster Admin User and Client Users
You must connect to a mongos
to complete the steps in this
section. The users created in these steps are cluster-level users and
cannot be used for accessing individual shard replica sets.
Create the adminstrator user.
Use the db.createUser()
method to create an administrator
user and assign it the following roles:
clusterAdmin
on theadmin
databaseuserAdmin
roles on theadmin
database
Clients performing maintenance operations or user administrative operations on the sharded cluster must authenticate as this user at the completion of this tutorial. Create this user now to ensure that you have access to the cluster after enforcing authentication.
admin = db.getSiblingDB("admin"); admin.createUser( { user: "admin", pwd: "<password>", roles: [ { role: "clusterAdmin", db: "admin" }, { role: "userAdmin", db: "admin" } ] } );
重要
Passwords should be random, long, and complex to prevent or hinder malicious access.
Optional: Create additional users for client applications.
In addition to the administrator user, you can create additional users before enforcing authentication.. This ensures access to the sharded cluster once you fully enforce authentication.
例子
The following operation creates the user joe
on the
marketing
database, assigning to this user the
readWrite
role on the marketing
database`.
db.getSiblingDB("marketing").createUser( { "user": "joe", "pwd": "<password>", "roles": [ { "role" : "readWrite", "db" : "marketing" } ] } )
Clients authenticating as "joe"
can perform read and write
operations on the marketing
database.
See Database User Roles for roles provided by MongoDB.
Optional: Update client applications to specify authentication credentials.
While the sharded cluster does not currently enforce authentication, you can still update client applications to specify authentication credentials when connecting to the sharded cluster. This may prevent loss of connectivity at the completion of this tutorial.
例子
The following operation connects to the sharded cluster using
mongosh
, authenticating as the user joe
on the
marketing
database.
mongosh --username "joe" --password "<password>" \ --authenticationDatabase "marketing" --host mongos1.example.net:27017
If your application uses a MongoDB driver, see the associated driver documentation for instructions on creating an authenticated connection.
Transition Each mongos
Instance to Enforce Authentication
Create a new mongos
configuration file.
For each mongos
:
Copy the existing
mongos
configuration file, giving it a distinct name such as<filename>-secure.conf
(or.cfg
if using Windows). You will use this new configuration file to transition themongos
to enforce authentication in the sharded cluster. Retain the original configuration file for backup purposes.To the new configuration file, add the following settings:
security.transitionToAuth
set totrue
security.keyFile
set to the keyfile path.If using a different internal authentication mechanism, specify settings appropriate for the mechanism.
security: transitionToAuth: true keyFile: <path-to-keyfile> The new configuration file should contain all of the configuration settings previously used by the
mongos
as well as the new security settings.
One at a time, restart the mongos
with the new configuration file.
Follow the procedure to restart the mongos
instance, one
mongos
at a time:
Connect to the
mongos
to shutdown.Use the
db.shutdownServer()
method against theadmin
database to safely shut down themongos
.db.getSiblingDB("admin").shutdownServer() 重新启动
mongos
with the new configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongos-secure.conf
:mongos --config <path>/mongos-secure.conf where
<path>
represents the system path to the folder containing the new configuration file.
Repeat the restart process for the next mongos
instance
until all mongos
instances in the sharded cluster have
been restarted.
At the end of this section, all mongos
instances in the
sharded cluster are running with security.transitionToAuth
and security.keyFile
internal authentication.
Transition Config Server Replica Set Members to Enforce Authentication
Create a new mongod
configuration file.
For each mongod
in the config server replica set,
Copy the existing
mongod
configuration file, giving it a distinct name such as<filename>-secure.conf
(or.cfg
if using Windows). You will use this new configuration file to transition themongod
to enforce authentication in the sharded cluster. Retain the original configuration file for backup purposes.To the new configuration file, add the following settings:
security.transitionToAuth
set totrue
security.keyFile
set to the keyfile path.If using a different internal authentication mechanism, specify settings appropriate for the mechanism.
security: transitionToAuth: true keyFile: <path-to-keyfile>
One at a time, restart the mongod
with the new configuration file.
Restart the replica set, one member at a time, starting with the secondary members.
To restart the secondary members one at a time,
Connect to the
mongod
and use thedb.shutdownServer()
method against theadmin
database to safely shut down themongod
.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the new configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the new configuration file.
Once this member is up, repeat for the next secondary member.
Once all the secondary members have restarted and are up, restart the primary:
Connect to the
mongod
.Use the
rs.stepDown()
method to step down the primary and trigger an election.rs.stepDown() You can use the
rs.status()
method to ensure the replica set has elected a new primary.Once you step down the primary and a new primary has been elected, shut down the old primary using the
db.shutdownServer()
method against theadmin
database.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the new configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the new configuration file.
At the end of this section, all mongod
instances in the config
server replica set is running with security.transitionToAuth
and
security.keyFile
internal authentication.
Transition Each Shard Replica Set Members to Enforce Authentication
Create the shard-local administrator
In a sharded cluster that enforces authentication, each shard replica set should have its own shard-local administrator. You cannot use a shard-local administrator for one shard to access another shard or the sharded cluster.
Connect to the primary member of each shard replica set and create a
user with the db.createUser()
method, assigning it the following
roles:
clusterAdmin
on theadmin
databaseuserAdmin
roles on theadmin
database
提示
您可以将 passwordPrompt()
方法与各种用户身份验证/管理方法/命令结合使用,以提示输入密码,而不是直接在方法/命令调用中指定密码。不过,您仍然可以像使用早期版本的 mongo
shell 一样直接指定密码。
admin = db.getSiblingDB("admin") admin.createUser( { user: "admin", pwd: passwordPrompt(), // or cleartext password roles: [ { role: "clusterAdmin", db: "admin" }, { role: "userAdmin", db: "admin" } ] } )
At the completion of this tutorial, if you want to connect to the shard to perform maintenance operation that require direct connection to a shard, you must authenticate as the shard-local administrator.
注意
Direct connections to a shard should only be for shard-specific
maintenance and configuration. In general, clients should connect to
the sharded cluster through the mongos
.
步骤
Transitioning one shard replica set at a time, repeat these steps for each shard replica set in the sharded cluster.
Create a new mongod
configuration file.
For each mongod
in the shard replica set,
Copy the existing
mongod
configuration file, giving it a distinct name such as<filename>-secure.conf
(or.cfg
if using Windows). You will use this new configuration file to transition themongod
to enforce authentication in the sharded cluster. Retain the original configuration file for backup purposes.To the new configuration file, add the following settings:
security.transitionToAuth
set totrue
security.keyFile
set to the keyfile path.If using a different internal authentication mechanism, specify settings appropriate for the mechanism.
security: transitionToAuth: true keyFile: <path-to-keyfile>
One at a time, restart the mongod
with the new configuration file.
Restart the replica set, one member at a time, starting with the secondary members.
To restart the secondary members one at a time,
Connect to the
mongod
and use thedb.shutdownServer()
method against theadmin
database to safely shut down themongod
.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the new configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the new configuration file.
Once this member is up, repeat for the next secondary member of the replica set until all secondaries have been updated.
Once all the secondary members have restarted and are up, restart the primary:
Connect to the
mongod
.Use the
rs.stepDown()
method to step down the primary and trigger an election.rs.stepDown() You can use the
rs.status()
method to ensure the replica set has elected a new primary.Once you step down the primary and a new primary has been elected, shut down the old primary using the
db.shutdownServer()
method against theadmin
database.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the new configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the new configuration file.
At this point in the tutorial, every component of the sharded cluster is
running with --transitionToAuth
and security.keyFile
internal authentication. The sharded cluster has at least one administrative
user, and each shard replica set has a shard-local administrative user.
The remaining sections involve taking the sharded cluster out of the transition state to fully enforce authentication.
Restart Each mongos
Instance without transitionToAuth
重要
At the end of this section, clients must specify authentication credentials to connect to the sharded cluster. Update clients to specify authentication credentials before completing this section to avoid loss of connectivity.
To complete the transition to fully enforcing authentication in the
sharded cluster, you must restart each mongos
instance without
the security.transitionToAuth
setting.
删除 transitionToAuth
from the mongos
configuration files.
Remove the security.transitionToAuth
key and its value
from the mongos
configuration files created during this
tutorial. Leave the security.keyFile
setting added in the
tutorial.
security: keyFile: <path-to-keyfile>
Restart the mongos
with the updated configuration file.
Follow the procedure to restart mongos
instance, one
mongos
at a time:
Connect to the
mongos
to shutdown.Use the
db.shutdownServer()
method against theadmin
database to safely shut down themongos
.db.getSiblingDB("admin").shutdownServer() 重新启动
mongos
with the updated configuration file, specifying the path to the config file using--config
. For example, if the updated configuration file were namedmongos-secure.conf
:mongos --config <path>/mongos-secure.conf
At the end of this section, all mongos
instances enforce client
authentication and security.keyFile
internal authentication.
Restart Each Config Server Replica Set Member without transitionToAuth
重要
At the end of this step, clients must specify authentication credentials to connect to the config server replica set. Update clients to specify authentication credentials before completing this section to avoid loss of connectivity.
To complete the transition to fully enforcing authentication in the
sharded cluster, you must restart each mongod
instance without
the security.transitionToAuth
setting.
删除 transitionToAuth
from the mongod
configuration files.
Remove the security.transitionToAuth
key and its value
from the config server configuration files created during this
tutorial. Leave the security.keyFile
setting added in the
tutorial.
security: keyFile: <path-to-keyfile>
One at a time, restart the mongod
with the updated configuration file.
Restart the replica set, one member at a time, starting with the secondary members.
To restart the secondary members one at a time,
Connect to the
mongod
and use thedb.shutdownServer()
method against theadmin
database to safely shut down themongod
.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the updated configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the updated configuration file.
Once this member is up, repeat for the next secondary member.
Once all the secondary members have restarted and are up, restart the primary:
Connect to the
mongod
.Use the
rs.stepDown()
method to step down the primary and trigger an election.rs.stepDown() You can use the
rs.status()
method to ensure the replica set has elected a new primary.Once you step down the primary and a new primary has been elected, shut down the old primary using the
db.shutdownServer()
method against theadmin
database.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the updated configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the updated configuration file.
At the end of this section, all mongod
instances in the config
server replica set enforce client authentication and
security.keyFile
internal authentication.
Restart Each Member in Each Shard Replica Set without transitionToAuth
重要
At the end of this step, clients must specify authentication credentials to connect to the shard replica set. Update clients to specify authentication credentials before completing this section to avoid loss of connectivity.
To complete the transition to fully enforcing authentication in the sharded
cluster, you must restart every member of every shard replica set in the
sharded cluster without the security.transitionToAuth
setting.
Transitioning one shard replica set at a time, repeat these steps for each shard replica set in the sharded cluster.
删除 transitionToAuth
from the mongod
configuration files.
Remove the security.transitionToAuth
key and its value
from the config server configuration files created during this
tutorial. Leave the security.keyFile
setting added in the
tutorial.
security: keyFile: <path-to-keyfile>
One at a time, restart the mongod
with the updated configuration file.
Restart the replica set, one member at a time, starting with the secondary members.
To restart the secondary members one at a time,
Connect to the
mongod
and use thedb.shutdownServer()
method against theadmin
database to safely shut down themongod
.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the updated configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the updated configuration file.
Once this member is up, repeat for the next secondary member.
Once all the secondary members have restarted and are up, restart the primary:
Connect to the
mongod
.Use the
rs.stepDown()
method to step down the primary and trigger an election.rs.stepDown() You can use the
rs.status()
method to ensure the replica set has elected a new primary.Once you step down the primary and a new primary has been elected, shut down the old primary using the
db.shutdownServer()
method against theadmin
database.db.getSiblingDB("admin").shutdownServer() Restart the
mongod
with the updated configuration file, specifying the path to the config file using--config
. For example, if the new configuration file were namedmongod-secure.conf
:mongod --config <path>/mongod-secure.conf where
<path>
represents the system path to the folder containing the updated configuration file.
At the end of this section, all mongos
and mongod
instances in the sharded cluster enforce client authentication and
security.keyFile
internal authentication. Clients can only connect
to the sharded cluster by using the configured client authentication mechanism.
Additional components can only join the cluster by specifying the correct
keyfile.
X.509 Certificate Internal Authentication
MongoDB supports X.509 certificate authentication for use with a secure TLS/SSL connection. Sharded cluster members and replica set members can use X.509 certificates to verify their membership to the cluster or the replica set instead of using Keyfiles.
For details on using X.509 certificates for internal authentication, see 使用 X.509 证书对自管理MongoDB进行成员身份验证.
Upgrade Self-Managed MongoDB from Keyfile Authentication to X.509 Authentication describes how to upgrade a deployment's internal auth mechanism from keyfile-based authentication to X.509 certificate-based auth.