See the wiki for documentation.
Mongo Orchestration is an HTTP server that provides a REST API for creating and managing MongoDB configurations on a single host.
THIS PROJECT IS FOR TESTING OF MONGODB DRIVERS.
- Start and stop mongod servers, replica sets, and sharded clusters on the host running mongo-orchestration.
- Add and remove replica set members.
- Add and remove shards and mongos routers.
- Reset replica sets and clusters to restart all members that were stopped.
- Freeze secondary members of replica sets.
- Retrieve information about MongoDB resources.
- Interaction all through REST interface.
- Python 2.6, 2.7, or >= 3.2
- PyMongo >= 2.8
- CherryPy >= 3.5.0
- argparse >= 1.2.1 (Python 2.6 only)
The easiest way to install Mongo Orchestration is with pip:
pip install mongo-orchestration
You can also install the development version of Mongo Orchestration manually:
git clone https://github.com/10gen/mongo-orchestration.git
cd mongo-orchestration
python setup.py install
Cloning the repository this way will also give you access to the tests for Mongo Orchestration as well as the mo
script. Note that you may have to run the above commands with sudo
, depending on where you're installing Mongo Orchestration and what privileges you have. Installation will place a mongo-orchestration
script on your path.
mongo-orchestration [-h] [-f CONFIG] [-e ENV] [--no-fork] [-b BIND IP="localhost"] [-p PORT] {start,stop,restart}
Arguments:
- -h - show help
- -f, --config - path to config file
- -e, --env - default release to use, as specified in the config file
- --no-fork - run server in foreground
- -b, --bind - host on which Mongo Orchestration and subordinate mongo processes should listen for requests. Defaults to "localhost".
- -p - port number (8889 by default)
- start/stop/restart: start, stop, or restart the server, respectively
In addition, Mongo Orchestration can be influenced by the MONGO_ORCHESTRATION_HOME
environment variable, which informs the server where to find the "configurations" directory for presets as well as where to put the log and pid files.
mongo-orchestration start
Starts Mongo Orchestration as service on port 8889.
mongo-orchestration stop
Stop the server.
mongo-orchestration -f mongo-orchestration.config -e 26-release -p 8888 --no-fork start
Starts Mongo Orchestration on port 8888 using 26-release
defined in mongo-orchestration.config
. Stops with Ctrl+C.
Mongo Orchestration may be given a JSON configuration file with the --config
option specifying where to find MongoDB binaries. See mongo-orchestration.config for an example. When no configuration file is provided, Mongo Orchestration uses whatever binaries are on the user's PATH.
Mongo Orchestration has a set of predefined configurations that can be used to start, restart, or stop MongoDB processes. You can use a tool like curl
to send these files directly to the Mongo Orchestration server, or use the mo
script in the scripts
directory (in the repository only). Some examples:
Start a single node without SSL or auth:
mo configurations/servers/clean.json start
Get the status of a single node without SSL or auth:
mo configurations/servers/clean.json status
Stop a single node without SSL or auth:
mo configurations/servers/clean.json stop
Start a replica set with ssl and auth:
mo configurations/replica_sets/ssl_auth.json start
Use
curl
to create a basic sharded cluster with the id "myCluster":curl -XPUT http://localhost:8889/v1/sharded_clusters/myCluster \ -d@configurations/sharded_clusters/basic.json
Note that in order to run the mo
script, you need to be in the same directory as "configurations".
Helpful hint: You can prettify JSON responses from the server by piping the response into python -m json.tool
, e.g.:
$ curl http://localhost:8889/v1/servers/myServer | python -m json.tool
{
"id": "myServer",
"mongodb_uri": "mongodb://localhost:1025",
"orchestration": "servers",
"procInfo": {
"alive": true,
"name": "mongod",
"optfile": "/var/folders/v9/spc2j6cx3db71l/T/mongo-KHUACD",
"params": {
"dbpath": "/var/folders/v9/spc2j6cx3db71l/T/mongo-vAgYaQ",
"ipv6": true,
"journal": true,
"logappend": true,
"noprealloc": true,
"oplogSize": 100,
"port": 1025,
"smallfiles": true
},
"pid": 51320
},
// etc.
}
In order to run the tests, you should first clone the repository. Running the tests has the following additional dependency:
- unittest2 >= 0.6 (Python 2.6 only)
python setup.py test
python -m unittest tests.test_servers
python -m unittest tests.test_servers.ServerSSLTestCase
python -m unittest tests.test_servers.ServerSSLTestCase.test_ssl_auth
python -m unittest -v tests.test_servers.ServerSSLTestCase