Preflight check tool

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:

Preflight check tool installation location
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

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:

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

Preflight check tool

Usage

Creating a new test

Was this helpful?

Give Feedback