@42nth/mrepset 中文文档教程
MongoDB Replica Set
Warning
该脚本仅用于开发和开发。 测试环境,因为它没有安全设置。
它应该只用于本地主机或任何安全环境,而不是用于全球互联网。
Description
该脚本将配置 MongoDB 副本集环境并启动所有副本集 mongod 进程。
默认情况下,它将在本地主机上创建一个包含 3 个节点的副本集 rs
,数据库路径为 /srv/mongo
:
- node #1,
rs-0
on port 27017, - node #2,
rs-1
on port 27018, - node #3,
rs-2
on port 27019.
每个进程都会将自己的日志文件流式传输到磁盘:
- access log :
<dbPath>/log/rs-X/access.log
, - error log :
<dbPath>/log/rs-X/error.log
.
关闭主进程将终止这三个进程。
Installation
本地:
- npm :
npm i @42nth/mrepset
- yarn :
yarn add @42nth/mrepset
或全局:
- npm :
npm i -g @42nth/mrepset
- yarn :
yarn global add @42nth/mrepset
Usage
const setup = require('mrepset')
setup(options)
Options
Replica Set options
name (default: 'rs')
副本集的名称。
baseDir (default '/srv/mongodb')
MongoDB 实例的基本目录。 必须对当前用户可写,否则进程将失败。
port (default 27017)
默认 MongoDB 端口。 您可以将其覆盖为您想要的任何值 N,它将对 3 个节点使用值 N、N+1 和 N+2。
oplog (default 128)
默认情况下使用慢速值,因为它应该只用于测试目的。 不是您将在生产中使用的值。
nodes (default 3)
要在复制集中创建的节点数。
ip (default '127.0.0.1')
服务器将监听的 ip。
Generic options
mongodPath
查找 MongoDB 二进制文件的路径。 如果您有多个 MongoDB 版本以指向特定 MongoDB 版本 bin
路径,则很有用。
accessLog (default 'access.log')
节点访问日志文件的名称。
errorLog (default 'error.log')
节点错误日志文件的名称。
Examples
Programmatically
在下面的示例中,一个由 3 个节点组成的副本集从端口 27117、27118 & 开始。 27119 在 /usr/local/opt/mongodb@4.0
文件夹中使用 MongoDB@4.0 安装:
const setup = require('@42nth/mrepset')
setup({
rs: {
port: 27117,
baseDir: '/opt/mongodb'
},
mongo: {
mongodPath: '/usr/local/opt/mongodb@4.0/bin',
}
})
您可以在 examples/setup.js
文件中看到本地版本。
CLI
此模块导出 mrepset
CLI。
$ mrepset --baseDir /opt/mongodb
访问所有选项:
$ mrepset --help
如果你想访问 调试 日志,请在 CLI 上添加 DEBUG
标志和 < code>mongo:rs 标志。
您可以在 examples/setup.sh
文件中看到可以运行的本地版本:
$ ./examples/setup.sh
MongoDB Replica Set
Warning
This script is meant to be used only for dev & testing environment as it comes with no security setup.
It should only be used for localhost or on any secured environment, not into the global internet.
Description
This script will configure a MongoDB replica set environment and start all the replica set mongod processes.
By default it will create a replica set rs
of 3 nodes on localhost with a db path of /srv/mongo
:
- node #1,
rs-0
on port 27017, - node #2,
rs-1
on port 27018, - node #3,
rs-2
on port 27019.
Each process will have its own log files streamed to disk :
- access log :
<dbPath>/log/rs-X/access.log
, - error log :
<dbPath>/log/rs-X/error.log
.
Closing the main process will terminate the three processes.
Installation
Locally :
- npm :
npm i @42nth/mrepset
- yarn :
yarn add @42nth/mrepset
Or globally :
- npm :
npm i -g @42nth/mrepset
- yarn :
yarn global add @42nth/mrepset
Usage
const setup = require('mrepset')
setup(options)
Options
Replica Set options
name (default: 'rs')
The name of the replica set.
baseDir (default '/srv/mongodb')
The base directory of the MongoDB instance. Must be writable by the current user or the process will failed.
port (default 27017)
Default MongoDB port. You can override it to any value N you want and it will use the value N, N+1 and N+2 for the 3 nodes.
oplog (default 128)
Use a slow value by default as it should only be used for testing purposes. Not the values you would use in production.
nodes (default 3)
The number of nodes to create in the replicat set.
ip (default '127.0.0.1')
The ip the server will listen to.
Generic options
mongodPath
The path to find the MongoDB binaries. Useful if you have multiple MongoDB versions to point a specific MongoDB version bin
path.
accessLog (default 'access.log')
The name of a node access log file.
errorLog (default 'error.log')
The name of a node error log file.
Examples
Programmatically
In the example below a replica set of 3 nodes starting on port 27117, 27118 & 27119 using a MongoDB@4.0 installation in /usr/local/opt/mongodb@4.0
folder :
const setup = require('@42nth/mrepset')
setup({
rs: {
port: 27117,
baseDir: '/opt/mongodb'
},
mongo: {
mongodPath: '/usr/local/opt/mongodb@4.0/bin',
}
})
You can see a local version in the examples/setup.js
file.
CLI
This module export the mrepset
CLI.
$ mrepset --baseDir /opt/mongodb
Access all options :
$ mrepset --help
If you want to access debug logs add the DEBUG
flag on the CLI with the mongo:rs
flag.
You can see a local version in the examples/setup.sh
file which can be run :
$ ./examples/setup.sh