mongo-orchestration


Namemongo-orchestration JSON
Version 0.9.0 PyPI version JSON
download
home_pageNone
SummaryRestful service for managing MongoDB servers
upload_time2024-09-04 19:41:39
maintainerNone
docs_urlNone
authorThe MongoDB Python Team
requires_python>=3.8
license Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
keywords mongo mongo-orchestration mongodb rest testing
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            -------------------
Mongo Orchestration
-------------------

See the `wiki <https://github.com/10gen/mongo-orchestration/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.**

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 <http://www.python.org/download/>`__
-  `bottle>=0.12.7 <https://pypi.python.org/pypi/bottle>`__
-  `pymongo>=3.0.2,<4 <https://pypi.python.org/pypi/pymongo>`__
-  `cheroot>=5.11 <https://pypi.python.org/pypi/cheroot/>`__

Installation
------------

The easiest way to install Mongo Orchestration is with `pip <https://pypi.python.org/pypi/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 <https://github.com/10gen/mongo-orchestration>`__ 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
``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.

Examples
~~~~~~~~

``mongo-orchestration start``

Starts Mongo Orchestration as service on port 8889.

``mongo-orchestration stop``

Stop the server.

``mongo-orchestration -f mongo-orchestration.config -e 30-release -p 8888 --no-fork start``

Starts Mongo Orchestration on port 8888 using ``30-release`` defined in
``mongo-orchestration.config``. Stops with *Ctrl+C*.

If you have installed mongo-orchestration but you're still getting
``command not found: mongo-orchestration`` this means that the script was
installed to a directory that is not on your ``PATH``. As an alternative use:

``python -m mongo_orchestration.server start``

Configuration File
~~~~~~~~~~~~~~~~~~

Mongo Orchestration may be given a JSON configuration file with the
``--config`` option specifying where to find MongoDB binaries. See
`mongo-orchestration.config <https://github.com/10gen/mongo-orchestration/blob/master/mongo-orchestration.config>`__
for an example. When no configuration file is provided, Mongo
Orchestration uses whatever binaries are on the user's PATH.

Predefined Configurations
-------------------------

Mongo Orchestration has a set of predefined
`configurations <https://github.com/10gen/mongo-orchestration/tree/master/mongo_orchestration/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 <https://github.com/10gen/mongo-orchestration>`__ 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 <https://github.com/10gen/mongo-orchestration>`__.

Run all tests
~~~~~~~~~~~~~

``python -m unittest``

Run a test module
~~~~~~~~~~~~~~~~~

``python -m unittest tests.test_servers``

Run a single test case
~~~~~~~~~~~~~~~~~~~~~~

``python -m unittest tests.test_servers.ServerSSLTestCase``

Run a single test method
~~~~~~~~~~~~~~~~~~~~~~~~

``python -m unittest tests.test_servers.ServerSSLTestCase.test_ssl_auth``

Run a single test example for debugging with verbose and immediate stdout output
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

``python -m unittest -v tests.test_servers.ServerSSLTestCase``

Changelog
---------

Changes in Version 0.8.0 (2023-05-16)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Add ``mongo-launch`` CLI tool.
- Upgrade to PyMongo 4.x and set up GitHub Actions testing.
- Remove support for managing MongoDB 3.4 or earlier servers.
- Remove support for Python 3.5 or earlier.
- Replaced dependency on CherryPy with cheroot. `-s auto` is the new default
  and `-s cherrypy` is no longer supported.
- Remove transactionLifetimeLimitSeconds default.

Changes in Version 0.7.0 (2021-04-06)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Remove support for managing MongoDB 2.4 servers.
- Add support for Python 3.8 and 3.9.
- Add support for MongoDB 4.2 and 4.4.
- Upgrade from pymongo 3.5.1 to 3.X latest. (#284).
- Ensure createUser succeeds on all replica set members. (#282)
- Create admin user with both SCRAM-SHA-256 and SCRAM-SHA-1. (#281)
- Wait for mongo-orchestration server to fully terminate in "stop". (#276)
- Allow starting clusters with enableTestCommands=0. (#269)
- Decrease transactionLifetimeLimitSeconds on 4.2+ by default. (#267)
- Increase maxTransactionLockRequestTimeoutMillis by default. (#270)
- Reduce periodicNoopIntervalSecs for faster driver change stream testing. (#283)
- Enable ztsd compression by default on 4.2+ (#263)

Changes in Version 0.6.12 (2018-12-14)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- Allow running the mongo-orchestration server over IPv6 localhost. (#237)
- Increase default mongodb server logging verbosity. (#255)
- Fixed a bug when shutting down clusters where mongo-orchestration would
  hang forever if the server had already exited. (#253)

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mongo-orchestration",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "mongo, mongo-orchestration, mongodb, rest, testing",
    "author": "The MongoDB Python Team",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/f1/c6/3ccc6baa1693168052dff0a96450ac64ea738249c96d890c12c48e4b76a6/mongo_orchestration-0.9.0.tar.gz",
    "platform": null,
    "description": "-------------------\nMongo Orchestration\n-------------------\n\nSee the `wiki <https://github.com/10gen/mongo-orchestration/wiki>`__\nfor documentation.\n\nMongo Orchestration is an HTTP server that provides a REST API for\ncreating and managing MongoDB configurations on a single host.\n\n**THIS PROJECT IS FOR TESTING OF MONGODB DRIVERS.**\n\nFeatures\n--------\n\n-  Start and stop mongod servers, replica sets, and sharded clusters on the host running mongo-orchestration.\n-  Add and remove replica set members.\n-  Add and remove shards and mongos routers.\n-  Reset replica sets and clusters to restart all members that were\n   stopped.\n-  Freeze secondary members of replica sets.\n-  Retrieve information about MongoDB resources.\n-  Interaction all through REST interface.\n-  Launch simple local servers using ``mongo-launch`` CLI tool.\n\nRequires\n--------\n\n-  `Python >=3.8 <http://www.python.org/download/>`__\n-  `bottle>=0.12.7 <https://pypi.python.org/pypi/bottle>`__\n-  `pymongo>=3.0.2,<4 <https://pypi.python.org/pypi/pymongo>`__\n-  `cheroot>=5.11 <https://pypi.python.org/pypi/cheroot/>`__\n\nInstallation\n------------\n\nThe easiest way to install Mongo Orchestration is with `pip <https://pypi.python.org/pypi/pip>`__:\n\n::\n\n    pip install mongo-orchestration\n\nYou can also install the development version of Mongo Orchestration\nmanually:\n\n::\n\n    git clone https://github.com/10gen/mongo-orchestration.git\n    cd mongo-orchestration\n    pip install .\n\nCloning the `repository <https://github.com/10gen/mongo-orchestration>`__ this way will also give you access to the tests for Mongo Orchestration as well as the ``mo`` script. Note that you may\nhave to run the above commands with ``sudo``, depending on where you're\ninstalling Mongo Orchestration and what privileges you have.\nInstallation will place a ``mongo-orchestration`` script on your path.\n\nUsage\n-----\n\n::\n\n    mongo-orchestration [-h] [-f CONFIG] [-e ENV] [--no-fork] [-b BIND IP=\"localhost\"] [-p PORT]\n                        [-s {auto,cheroot,wsgiref}] [--socket-timeout-ms MILLIS]\n                        [--pidfile PIDFILE] [--enable-majority-read-concern] {start,stop,restart}\n\n\nArguments:\n\n-  **-h** - show help\n-  **-f, --config** - path to config file\n-  **-e, --env** - default release to use, as specified in the config\n   file\n-  **--no-fork** - run server in foreground\n-  **-b, --bind** - host on which Mongo Orchestration and subordinate mongo processes should listen for requests. Defaults to \"localhost\".\n-  **-s, --server** - HTTP backend to use: one of `auto`, `cheroot`, or `wsgiref`. `auto`\n   configures bottle to automatically choose an available backend.\n-  **-p** - port number (8889 by default)\n-  **--socket-timeout-ms** - socket timeout when connecting to MongoDB servers\n-  **--pidfile** - location where mongo-orchestration should place its pid file\n-  **--enable-majority-read-concern** - enable \"majority\" read concern on server versions that support it.\n-  **start/stop/restart**: start, stop, or restart the server,\n   respectively\n\nIn addition, Mongo Orchestration can be influenced by the\n``MONGO_ORCHESTRATION_HOME`` environment variable, which informs the\nserver where to find the \"configurations\" directory for presets as well\nas where to put the log and pid files.\n\nExamples\n~~~~~~~~\n\n``mongo-orchestration start``\n\nStarts Mongo Orchestration as service on port 8889.\n\n``mongo-orchestration stop``\n\nStop the server.\n\n``mongo-orchestration -f mongo-orchestration.config -e 30-release -p 8888 --no-fork start``\n\nStarts Mongo Orchestration on port 8888 using ``30-release`` defined in\n``mongo-orchestration.config``. Stops with *Ctrl+C*.\n\nIf you have installed mongo-orchestration but you're still getting\n``command not found: mongo-orchestration`` this means that the script was\ninstalled to a directory that is not on your ``PATH``. As an alternative use:\n\n``python -m mongo_orchestration.server start``\n\nConfiguration File\n~~~~~~~~~~~~~~~~~~\n\nMongo Orchestration may be given a JSON configuration file with the\n``--config`` option specifying where to find MongoDB binaries. See\n`mongo-orchestration.config <https://github.com/10gen/mongo-orchestration/blob/master/mongo-orchestration.config>`__\nfor an example. When no configuration file is provided, Mongo\nOrchestration uses whatever binaries are on the user's PATH.\n\nPredefined Configurations\n-------------------------\n\nMongo Orchestration has a set of predefined\n`configurations <https://github.com/10gen/mongo-orchestration/tree/master/mongo_orchestration/configurations>`__\nthat can be used to start, restart, or stop MongoDB processes. You can\nuse a tool like ``curl`` to send these files directly to the Mongo\nOrchestration server, or use the ``mo`` script in the ``scripts``\ndirectory (in the `repository <https://github.com/10gen/mongo-orchestration>`__ only). Some examples:\n\n-  Start a single node without SSL or auth:\n\n   ::\n\n       mo configurations/servers/clean.json start\n\n-  Get the status of a single node without SSL or auth:\n\n   ::\n\n       mo configurations/servers/clean.json status\n\n-  Stop a single node without SSL or auth:\n\n   ::\n\n       mo configurations/servers/clean.json stop\n\n-  Start a replica set with ssl and auth:\n\n   ::\n\n       mo configurations/replica_sets/ssl_auth.json start\n\n-  Use ``curl`` to create a basic sharded cluster with the id\n   \"myCluster\":\n\n   ::\n\n       curl -XPUT http://localhost:8889/v1/sharded_clusters/myCluster \\\n                  -d@configurations/sharded_clusters/basic.json\n\nNote that in order to run the ``mo`` script, you need to be in the same\ndirectory as \"configurations\".\n\n**Helpful hint**: You can prettify JSON responses from the server by\npiping the response into ``python -m json.tool``, e.g.:\n\n::\n\n    $ curl http://localhost:8889/v1/servers/myServer | python -m json.tool\n\n    {\n        \"id\": \"myServer\",\n        \"mongodb_uri\": \"mongodb://localhost:1025\",\n        \"orchestration\": \"servers\",\n        \"procInfo\": {\n            \"alive\": true,\n            \"name\": \"mongod\",\n            \"optfile\": \"/var/folders/v9/spc2j6cx3db71l/T/mongo-KHUACD\",\n            \"params\": {\n                \"dbpath\": \"/var/folders/v9/spc2j6cx3db71l/T/mongo-vAgYaQ\",\n                \"ipv6\": true,\n                \"journal\": true,\n                \"logappend\": true,\n                \"oplogSize\": 100,\n                \"port\": 1025\n            },\n            \"pid\": 51320\n        },\n        // etc.\n    }\n\nMongo Launch\n------------\n\nThe ``mongo-launch`` CLI tool allows you to spin up servers locally\nwith minimal configuration.\n\n..\n\n    mongo-launch --help\n    Usage: launch.py [single|replica|shard] [ssl] [auth]\n\n..\n\n    mongo-orchestration start\n    mongo-launch replica ssl auth\n\nTests\n-----\n\nIn order to run the tests, you should first clone the `repository <https://github.com/10gen/mongo-orchestration>`__.\n\nRun all tests\n~~~~~~~~~~~~~\n\n``python -m unittest``\n\nRun a test module\n~~~~~~~~~~~~~~~~~\n\n``python -m unittest tests.test_servers``\n\nRun a single test case\n~~~~~~~~~~~~~~~~~~~~~~\n\n``python -m unittest tests.test_servers.ServerSSLTestCase``\n\nRun a single test method\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n``python -m unittest tests.test_servers.ServerSSLTestCase.test_ssl_auth``\n\nRun a single test example for debugging with verbose and immediate stdout output\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n``python -m unittest -v tests.test_servers.ServerSSLTestCase``\n\nChangelog\n---------\n\nChanges in Version 0.8.0 (2023-05-16)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Add ``mongo-launch`` CLI tool.\n- Upgrade to PyMongo 4.x and set up GitHub Actions testing.\n- Remove support for managing MongoDB 3.4 or earlier servers.\n- Remove support for Python 3.5 or earlier.\n- Replaced dependency on CherryPy with cheroot. `-s auto` is the new default\n  and `-s cherrypy` is no longer supported.\n- Remove transactionLifetimeLimitSeconds default.\n\nChanges in Version 0.7.0 (2021-04-06)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Remove support for managing MongoDB 2.4 servers.\n- Add support for Python 3.8 and 3.9.\n- Add support for MongoDB 4.2 and 4.4.\n- Upgrade from pymongo 3.5.1 to 3.X latest. (#284).\n- Ensure createUser succeeds on all replica set members. (#282)\n- Create admin user with both SCRAM-SHA-256 and SCRAM-SHA-1. (#281)\n- Wait for mongo-orchestration server to fully terminate in \"stop\". (#276)\n- Allow starting clusters with enableTestCommands=0. (#269)\n- Decrease transactionLifetimeLimitSeconds on 4.2+ by default. (#267)\n- Increase maxTransactionLockRequestTimeoutMillis by default. (#270)\n- Reduce periodicNoopIntervalSecs for faster driver change stream testing. (#283)\n- Enable ztsd compression by default on 4.2+ (#263)\n\nChanges in Version 0.6.12 (2018-12-14)\n~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Allow running the mongo-orchestration server over IPv6 localhost. (#237)\n- Increase default mongodb server logging verbosity. (#255)\n- Fixed a bug when shutting down clusters where mongo-orchestration would\n  hang forever if the server had already exited. (#253)\n",
    "bugtrack_url": null,
    "license": " Apache License Version 2.0, January 2004 http://www.apache.org/licenses/  TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION  1. Definitions.  \"License\" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document.  \"Licensor\" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License.  \"Legal Entity\" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, \"control\" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.  \"You\" (or \"Your\") shall mean an individual or Legal Entity exercising permissions granted by this License.  \"Source\" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files.  \"Object\" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types.  \"Work\" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below).  \"Derivative Works\" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof.  \"Contribution\" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, \"submitted\" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as \"Not a Contribution.\"  \"Contributor\" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work.  2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form.  3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed.  4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions:  (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and  (b) You must cause any modified files to carry prominent notices stating that You changed the files; and  (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and  (d) If the Work includes a \"NOTICE\" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License.  You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License.  5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions.  6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file.  7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License.  8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages.  9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability.  END OF TERMS AND CONDITIONS  APPENDIX: How to apply the Apache License to your work.  To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets \"[]\" replaced with your own identifying information. (Don't include the brackets!)  The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same \"printed page\" as the copyright notice for easier identification within third-party archives.  Copyright [yyyy] [name of copyright owner]  Licensed under the Apache License, Version 2.0 (the \"License\"); you may not use this file except in compliance with the License. You may obtain a copy of the License at  http://www.apache.org/licenses/LICENSE-2.0  Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an \"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.",
    "summary": "Restful service for managing MongoDB servers",
    "version": "0.9.0",
    "project_urls": {
        "Homepage": "https://github.com/10gen/mongo-orchestration"
    },
    "split_keywords": [
        "mongo",
        " mongo-orchestration",
        " mongodb",
        " rest",
        " testing"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "19b366ee4db30f1b2251d8fb68730027974f9173f2ed9c4d447b0fcdf0de94d6",
                "md5": "2aa8326bb23659be1774eb6d4f8e3201",
                "sha256": "a697ff0f1ea8ee97d96a5643ea7dc43a3e023034f8e3e81378dd64781c9102d9"
            },
            "downloads": -1,
            "filename": "mongo_orchestration-0.9.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "2aa8326bb23659be1774eb6d4f8e3201",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 78447,
            "upload_time": "2024-09-04T19:41:37",
            "upload_time_iso_8601": "2024-09-04T19:41:37.152515Z",
            "url": "https://files.pythonhosted.org/packages/19/b3/66ee4db30f1b2251d8fb68730027974f9173f2ed9c4d447b0fcdf0de94d6/mongo_orchestration-0.9.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "f1c63ccc6baa1693168052dff0a96450ac64ea738249c96d890c12c48e4b76a6",
                "md5": "21e5e1454053896f0a3a58c5c51d97f6",
                "sha256": "fcf3b644d946794218672f94ea63cea4de1d7a3c29c60bacae507bb64c147134"
            },
            "downloads": -1,
            "filename": "mongo_orchestration-0.9.0.tar.gz",
            "has_sig": false,
            "md5_digest": "21e5e1454053896f0a3a58c5c51d97f6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 51290,
            "upload_time": "2024-09-04T19:41:39",
            "upload_time_iso_8601": "2024-09-04T19:41:39.383088Z",
            "url": "https://files.pythonhosted.org/packages/f1/c6/3ccc6baa1693168052dff0a96450ac64ea738249c96d890c12c48e4b76a6/mongo_orchestration-0.9.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-04 19:41:39",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "10gen",
    "github_project": "mongo-orchestration",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mongo-orchestration"
}
        
Elapsed time: 0.35191s