Streaming

rpk iotune

This command is not supported on Darwin, macOS, Windows.

rpk iotune measures the I/O performance of the hardware used by a Redpanda instance. It writes its parameters to an I/O configuration file that Redpanda reads on startup to optimize its I/O performance. Its benchmarks measure read/write IOPS and bandwidth.

By default rpk iotune writes its output parameters to /etc/redpanda/io-config.yaml.

Usage

rpk iotune [flags]

Flags

Value Type Description

--directories

strings

List of directories to evaluate.

--duration

duration

Duration of tests. The value passed is a sequence of decimal numbers, each with optional fraction and a unit suffix, such as 300ms, 1.5s or 2h45m. Valid time units are ns, us (or µs), ms, s, m, h (default 10m0s).

-h, --help

-

Help for iotune.

--iotune-path

string

Path to the iotune executable (default: iotune-redpanda).

--no-confirm

-

Disable confirmation prompt if the iotune file already exists.

--out

string

The file path where the IO config will be written (default "/etc/redpanda/io-config.yaml").

--timeout

duration

The maximum time after — to wait for iotune to complete (for example, 300ms, 1.5s, 2h45m). Default 1h0m0s.

--config

string

Redpanda or rpk config file; default search paths are /var/lib/redpanda/.config/rpk/rpk.yaml, $PWD/redpanda.yaml, and /etc/redpanda/redpanda.yaml.

-X, --config-opt

stringArray

Override rpk configuration settings. See rpk -X or execute rpk -X help for inline detail or rpk -X list for terser detail.

--profile

string

Profile to use. See rpk profile for more details.

-v, --verbose

-

Enable verbose logging.

Example output

Running rpk iotune produces an output file that by default is saved in /etc/redpanda/io-config.yaml.

The contents of an example io-config.yaml:

disks:
- mountpoint: /var/lib/redpanda/data
  read_iops: 40952
  read_bandwidth: 5638210048
  write_iops: 6685
  write_bandwidth: 1491679488