alexei-led / pumba

Chaos testing, network emulation, and stress testing tool for containers
Apache License 2.0
2.75k stars 193 forks source link

pumba stress: unclear help string for --stressors #216

Open ghost opened 2 years ago

ghost commented 2 years ago

Hello, i try to specify a different stressor setting. Reading the help string :

$ ./pumba_linux_amd64 --version
Pumba version 0.9.0 - 2e7ab7b (master) 2021-11-21T10:12:49+0200

./pumba_linux_amd64 stress --help
[...]
OPTIONS:
[...]
   --stressors value           stress-ng stressors; see https://kernel.ubuntu.com/~cking/stress-ng/ (default: "--cpu 4 --timeout 60s")

I would expect this command to work:

./pumba_linux_amd64 stress -d 30s --stressors "--cpu 4 --timeout 60s"  my_container
Incorrect Usage: flag provided but not defined: -cpu 4 --timeout 60s

However the accepted one is :

./pumba_linux_amd64 stress -d 30s --stressors= "--cpu 4 --timeout 60s"  my_container

Do I not read the help string correctly, or would you consider a change in the documentation?

The "wrong" way to call the program is also featured here: https://devops.stackexchange.com/a/11705/30414 which could mislead more people.

thank you