CCM (Cassandra Cluster Manager)

A script/library to create, launch and remove an Apache Cassandra cluster on localhost.

The goal of ccm and ccmlib is to make it easy to create, manage and destroy a small Cassandra cluster on a local box. It is meant for testing a Cassandra cluster.

Requirements

• A working python installation (tested to work with python 2.7).

• pyYAML (http://pyyaml.org/ -- sudo easy_install pyYaml)

• six (https://pypi.org/project/six/ -- sudo easy_install six)

• ant (http://ant.apache.org/, on Mac OS X, brew install ant)

• psutil (https://pypi.org/project/psutil/)

• Java (which version depends on the version of Cassandra you plan to use. If unsure, use Java 7 as it is known to work with current versions of Cassandra).

• If you want to create multiple node clusters, the simplest way is to use multiple loopback aliases. On modern linux distributions you probably don't need to do anything, but on Mac OS X, you will need to create the aliases with

  sudo ifconfig lo0 alias 127.0.0.2 up
  sudo ifconfig lo0 alias 127.0.0.3 up
  ...
  

  Note that the usage section assumes that at least 127.0.0.1, 127.0.0.2 and 127.0.0.3 are available.

Optional Requirements

• Paramiko (http://www.paramiko.org/): Paramiko adds the ability to execute CCM remotely; pip install paramiko

Note: The remote machine must be configured with an SSH server and a working CCM. When working with multiple nodes each exposed IP address must be in sequential order. For example, the last number in the 4th octet of a IPv4 address must start with 1 (e.g. 192.168.33.11). See Vagrantfile for help with configuration of remote CCM machine.

Known issues

Windows only:

• node start pops up a window, stealing focus.
• cqlsh started from ccm show incorrect prompts on command-prompt
• non nodetool-based command-line options fail (sstablesplit, scrub, etc)
• To install psutil, you must use the .msi from pypi. pip install psutil will not work
• You will need ant.bat in your PATH in order to build C* from source
• You must run with an Unrestricted Powershell Execution-Policy if using Cassandra 2.1.0+
• Ant installed via chocolatey will not be found by ccm, so you must create a symbolic link in order to fix the issue (as administrator):
  • cmd /c mklink C:\ProgramData\chocolatey\bin\ant.bat C:\ProgramData\chocolatey\bin\ant.exe

Remote Execution only:

• Using --config-dir and --install-dir with create may not work as expected; since the configuration directory and the installation directory contain lots of files they will not be copied over to the remote machine like most other options for cluster and node operations
• cqlsh started from ccm using remote execution will not start properly (e.g.ccm --ssh-host 192.168.33.11 node1 cqlsh); however -x or --exec=CMDS can still be used to execute a CQLSH command on a remote node.

Installation

ccm uses python distutils so from the source directory run:

sudo ./setup.py install

ccm is available on the Python Package Index:

pip install ccm

There is also a Homebrew package available:

brew install ccm

Usage

Let's say you wanted to fire up a 3 node Cassandra cluster.

Short version

ccm create test -v 2.0.5 -n 3 -s

You will of course want to replace 2.0.5 by whichever version of Cassandra you want to test.

Longer version

ccm works from a Cassandra source tree (not the jars). There are two ways to tell ccm how to find the sources:

1. If you have downloaded and compiled Cassandra sources, you can ask ccm to use those by initiating a new cluster with:

   ccm create test --install-dir=