cumin icon indicating copy to clipboard operation
cumin copied to clipboard

An automation and orchestration framework — Mirror of https://gerrit.wikimedia.org/g/operations/software/cumin. To contribute see: https://wikitech.wikimedia.org/wiki/Cumin#How_to_contribute_to_Cumin

Cumin - An automation and orchestration framework

|GitHub Release| |PyPI Release| |License|

Cumin provides a flexible and scalable automation framework to execute multiple commands on multiple hosts in parallel.

It allows to easily perform complex selections of hosts through a user-friendly query language which can interface with different backend modules and combine their results for a fine grained selection. The transport layer can also be selected, and can provide multiple execution strategies. The executed commands outputs are automatically grouped for an easy-to-read result.

It can be used both via its command line interface (CLI) cumin and as a Python 3 only library. Cumin was Python 2 only before the 3.0.0 release, due to ClusterShell not yet being Python 3 compatible.

|Cumin GIF|

The documentation is available on Wikimedia Documentation_ and Read the Docs. The details on how Cumin it's used at the Wikimedia Foundation are available on Wikitech.

.. |GitHub Release| image:: https://img.shields.io/github/release/wikimedia/cumin.svg :target: https://github.com/wikimedia/cumin/releases .. |PyPI Release| image:: https://img.shields.io/pypi/v/cumin.svg :target: https://pypi.org/project/cumin/ .. |License| image:: https://img.shields.io/badge/license-GPLv3%2B-blue.svg :target: https://github.com/wikimedia/cumin/blob/master/LICENSE .. |Cumin GIF| image:: https://people.wikimedia.org/~volans/cumin.gif

.. _Read the Docs: https://cumin.readthedocs.io .. _Wikimedia Documentation: https://doc.wikimedia.org/cumin .. _Wikitech: https://wikitech.wikimedia.org/wiki/Cumin