Preflight check tool

The preflight check tool is a collection of tests that detects and optionally fixes configuration settings on DataStax Enterprise nodes.

The preflight check tool is a collection of tests that can be run on a DataStax Enterprise node to detect and fix node configurations. The tool can detect and optionally fix many invalid or suboptimal configuration settings, such as user resource limits, swap, and disk settings.

The preflight check tool is included in the following location based on your installation type:

Installation type Location
Package installation /usr/share/dse/tools/pfc
Tarball installation install_location/tools/pfc

Usage

Run the preflight check without options to run all tests.

sudo ./preflight_check options
Table 1. Options
Short Long Description
-h -help Show help and exit.
-f -fix Attempt to fix issues.
--yaml=YAML_LOCATION Location of cassandra.yaml file
--devices=DEVICES Comma separated lists of HDDs: /dev/sda,/dev/sdb,...
--disk-duration=DISK_DURATION Time (in seconds) for each test disk benchmark. Set to simulate a normal load.
--disk-threads=DISK_THREADS Number of threads for each disk benchmark. Set to simulate a normal load.
--ssd=SSD Comma separated lists of SSDs: /dev/sda,/dev/sdb,...
--nossd The node does not have SSDs.

Creating a new test

Complete the following steps to create your own test:

  1. Create a new Python file in /checks:
    cd /checks
    touch my_test.py
  2. Add the new test to the __all__ section of /checks/init.py:
    __all__ = ['my_test', 'disk', 'blockdev', ...]
  3. Add your test to the preflight_check script.
  4. Run the preflight check script with the new test:
    sudo ./preflight_check options