mongo-orchestration 0.11.2

Features

• 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.

• Launch simple local servers using mongo-launch CLI tool.

Requires

• Python >=3.8

• bottle>=0.12.7

• pymongo>=3.0.2,<4

• cheroot>=5.11

Installation

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
pip 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.

Usage

mongo-orchestration [-h] [-f CONFIG] [-e ENV] [--no-fork] [-b BIND IP="localhost"] [-p PORT]
                    [-s {auto,cheroot,wsgiref}] [--socket-timeout-ms MILLIS]
                    [--pidfile PIDFILE] [--enable-majority-read-concern] {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”.

• -s, –server - HTTP backend to use: one of auto, cheroot, or wsgiref. auto configures bottle to automatically choose an available backend.

• -p - port number (8889 by default)

• –socket-timeout-ms - socket timeout when connecting to MongoDB servers

• –pidfile - location where mongo-orchestration should place its pid file

• –enable-majority-read-concern - enable “majority” read concern on server versions that support it.

• start/stop/restart: start, stop, or restart the server, respectively

In addition, Mongo Orchestration can be influenced by the following environment variables:

• MONGO_ORCHESTRATION_HOME - informs the server where to find the “configurations” directory for presets as well as where to put the log and pid files.

• MONGO_ORCHESTRATION_TMP - the temporary folder root location.

• MO_HOST - the server host (localhost by default)

• MO_PORT - the server port (8889 by default)

• MONGO_ORCHESTRATION_CLIENT_CERT - set the client certificate file to be used by mongo-orchestration.

Predefined Configurations

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,
            "oplogSize": 100,
            "port": 1025
        },
        "pid": 51320
    },
    // etc.
}

Mongo Launch

The mongo-launch CLI tool allows you to spin up servers locally with minimal configuration.

mongo-launch –help Usage: launch.py [single|replica|shard] [ssl] [auth]

mongo-orchestration start mongo-launch replica ssl auth

Tests

In order to run the tests, you should first clone the repository.

Changelog