Repository files navigation

crmsh is a command-line interface for High-Availability clustermanagement on GNU/Linux systems, and part of the Clusterlabsproject. It simplifies the configuration, management andtroubleshooting of Pacemaker-based clusters, by providing a powerfuland intuitive set of features.

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

• The website for crmsh is here:crmsh @ Github.io.
• Documentation for the latest stable release is found at theGithub.io documentation page.

Crmsh is implemented in Python, and requires Python version 3.4 ornewer. Versions of crmsh older than the 4 series ran on Python 2, soif you don't have access to a Python 3 interpreter, you will need touse 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 thedefault daemon user (usually hacluster).

It then calls the python setuptools setup.py to actually process thePython module sources and install into the Python system site-packagesdirectory.

./autogen.sh./configuremakemake install

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

To run the unit tests, calltest/run. This usesnosetests to run aset of test cases that don't need a full Pacemaker environment.

To run the regression tests in a docker container, use thetest/containerized-regression-tests.sh script. This relies on havingaccess todocker to pull down the base image and run the regressiontest suite. The docker base image used is defined in theDockerfileincluded in the repository.

./doc: man page,sourcefor 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           contributions./hb_report: log file collection and analysis tool

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

git clone https://github.com/ClusterLabs/crmsh

There is a gitpre-commit hook used to update the data-manifestwhich lists all the data files to be installed. To install this, run

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

• Bugs and issues can be reported at thecrmsh issues @ Github.com page.
• Any other questions or comments can be made on theClusterlabs users mailing list.