Installation

ClusterShell is distributed in several packages. On RedHat-like OS, we recommend to use the RPM package (.rpm) distribution.

As a system software for cluster, ClusterShell is primarily made for system-wide installation to be used by system administrators. However, changes have been made so that it’s now easy to install it without root access (see Installing ClusterShell as user using PIP).

Requirements

ClusterShell should work with any Unix [1] operating systems which provides Python 2.6, 2.7 or 3.x and OpenSSH or any compatible Secure Shell clients.

Furthermore, ClusterShell’s engine has been optimized when the poll() syscall is available or even better, when the epoll_wait() syscall is available (Linux only).

For instance, ClusterShell is known to work on the following operating systems:

  • GNU/Linux RHEL or CentOS 6 (Python 2.6)
  • GNU/Linux RHEL or CentOS 7 (Python 2.7)
  • GNU/Linux Fedora 22 to 26 (Python 2.6 or 2.7)
  • GNU/Linux Debian wheezy and above (Python 2.7)
  • Mac OS X 10.8+ (Python 2.6 or 2.7)

Distribution

ClusterShell is an open-source project distributed under the GNU Lesser General Public License version or later (LGPL v2.1+), which means that many possibilities are offered to the end user. Also, as a software library, ClusterShell should remain easily available to everyone. Hopefully, packages are currently available for Fedora Linux, RHEL (through EPEL repositories), Debian and Arch Linux.

Fedora

At the time of writing, ClusterShell 1.7.81 is available on Fedora 26 (releases being maintained by the Fedora Project).

Install ClusterShell from Fedora Updates

ClusterShell is part of Fedora, so it is really easy to install it with dnf or yum, although you have to keep the Fedora updates default repository. The following command checks whether the packages are available on a Fedora machine:

$ dnf list \*clustershell
Available Packages
clustershell.noarch                     1.7.3-2.fc26                fedora
vim-clustershell.noarch                 1.7.3-2.fc26                fedora

Then, install ClusterShell (library and tools) with the following command:

$ dnf install clustershell vim-clustershell

Please note that optional (but recommended) vim-clustershell package will install VIM syntax files for ClusterShell configuration files like clush.conf and groups.conf.

Install ClusterShell from Fedora Updates Testing

Recent releases of ClusterShell are first available through the Test Updates repository of Fedora, then it is later pushed to the stable updates repository. The following dnf command will also checks for packages availability in the updates-testing repository:

$ dnf list \*clustershell --enablerepo=updates-testing

To install, also add the --enablerepo=updates-testing option, for instance:

$ dnf install clustershell vim-clustershell --enablerepo=updates-testing

Red Hat Enterprise Linux (and CentOS)

ClusterShell packages are maintained on Extra Packages for Enterprise Linux EPEL for Red Hat Enterprise Linux (RHEL) and its compatible spinoffs such as CentOS. At the time of writing, ClusterShell 1.7.81 is available on EPEL 6 and 7.

Install ClusterShell from EPEL

First you have to enable the yum EPEL repository. We recommend to download and install the EPEL repository RPM package. On CentOS, this can be easily done using the following command:

$ yum --enablerepo=extras install epel-release

Then, the ClusterShell installation procedure is quite the same of the Fedora Updates one, for instance:

$ yum install clustershell vim-clustershell

Debian

ClusterShell is available in Debian main repository (since 2011).

To install it on Debian, simply use:

$ apt-get install clustershell

You can get the latest version on:

* http://packages.debian.org/sid/clustershell

Ubuntu

Like Debian, it is easy to get and install ClusterShell on Ubuntu (also with apt-get). To do so, please first enable the universe repository. ClusterShell is available since “Natty” release (11.04):

Installing ClusterShell using PIP

Installing ClusterShell as root using PIP

To install ClusterShell as a standard Python package using PIP [2] as root:

$ pip install clustershell

Or alternatively, using the source tarball:

$ pip install clustershell-1.x.tar.gz

Installing ClusterShell as user using PIP

To install ClusterShell as a standard Python package using PIP as an user:

$ pip install --user clustershell

Or alternatively, using the source tarball:

$ pip install --user clustershell-1.x.tar.gz

Then, you just need to update your PYTHONPATH environment variable to be able to import the library and PATH to easily use the Tools:

$ export PYTHONPATH=$PYTHONPATH:~/.local/lib
$ export PATH=$PATH:~/.local/bin

Configuration files are installed in ~/.local/etc/clustershell and are automatically loaded before system-wide ones (for more info about supported user config files, please see the clush or Node groups config sections).

Source

Current source is available through Git, use the following command to retrieve the latest development version from the repository:

$ git clone git@github.com:cea-hpc/clustershell.git
[1]Unix in the same sense of the Availability: Unix notes in the Python documentation
[2]pip is a tool for installing and managing Python packages, such as those found in the Python Package Index