Skip to content
Switch branches/tags
Go to file


Failed to load latest commit information.
Latest commit message
Commit time
Sep 10, 2014


Build Status


crmsh is a command-line interface for High-Availability cluster management on GNU/Linux systems, and part of the Clusterlabs project. It simplifies the configuration, management and troubleshooting of Pacemaker-based clusters, by providing a powerful and intuitive set of features.

crmsh can function both as an interactive shell with tab completion and inline documentation, and as a command-line tool. It can also be used in batch mode to execute commands from files.



Crmsh is implemented in Python, and requires Python version 3.4 or newer. Versions of crmsh older than the 4 series ran on Python 2, so if you don't have access to a Python 3 interpreter, you will need to use one of the older releases.

The GNU Autotools suite is used to configure the OCF root directory, the Asciidoc tool which is used to generate documentation and the default daemon user (usually hacluster).

It then calls the python setuptools to actually process the Python module sources and install into the Python system site-packages directory.

make install

Test suites

There are two sets of tests: Unit tests and regression tests.

To run the unit tests, call test/run. This uses nosetests to run a set of test cases that don't need a full Pacemaker environment.

To run the regression tests in a docker container, use the test/ script. This relies on having access to docker to pull down the base image and run the regression test suite. The docker base image used is defined in the Dockerfile included in the repository.


./doc: man page, source for the website and other documentation
./crmsh: the code
./templates: configuration templates
./test: unit tests and regression tests
./contrib: vim highlighting scripts and other semi-related
./hb_report: log file collection and analysis tool


The source code for crmsh is kept in a git source repository. To check out the latest development version, install git and run this command:

git clone

There is a git pre-commit hook used to update the data-manifest which lists all the data files to be installed. To install this, run

cp contrib/git-hook-pre-commit .git/hooks/pre-commit
chmod +x .git/hooks/pre-commit


You can contribute following the standard fork -> clone -> change -> pull request Github process for code changes. The pull request process is integrated with the openSUSE Build Service, and as soon as it gets merged, a new RPM package is built on network:ha-clustering:Unstable and a submit request is created to the crmsh package maintainers at network:ha-clustering:Factory.

The commit messages are used to create the changelog, so, please, include relevant and comprehensive messages on your commits.