Krkn

Krkn aka Kraken

Installation

Git

Clone the repository

$ git clone https://github.com/krkn-chaos/krkn.git --branch <release version>
$ cd krkn

Install the dependencies

$ python3.9 -m venv chaos
$ source chaos/bin/activate
$ pip3.9 install -r requirements.txt

Note

Make sure python3-devel and latest pip versions are installed on the system. The dependencies install has been tested with pip >= 21.1.3 versions.

Where can your user find your project code? How can they install it (binaries, installable package, build from source)? Are there multiple options/versions they can install and how should they choose the right one for them?

Getting Started with Krkn

If you are wanting to try to edit your config file and scenarios

Running Krkn

$ python3.9 run_kraken.py --config <config_file_location>

Run containerized version

Krkn-hub is a wrapper that allows running Krkn chaos scenarios via podman or docker runtime with scenario parameters/configuration defined as environment variables.

Last modified April 9, 2025: adding contribution starter docs (#17) (0ae64d3)