New Scenarios on Krkn

Adding scenarios via plugin api

Mon, 01 Jan 0001 00:00:00 +0000

Scenario Plugin API:

This API enables seamless integration of Scenario Plugins for Krkn. Plugins are automatically detected and loaded by the plugin loader, provided they extend the AbstractPluginScenario abstract class, implement the required methods, and adhere to the specified naming conventions.

Plugin folder:

The plugin loader automatically loads plugins found in the krkn/scenario_plugins directory, relative to the Krkn root folder. Each plugin must reside in its own directory and can consist of one or more Python files. The entry point for each plugin is a Python class that extends the AbstractPluginScenario abstract class and implements its required methods.

Adding New Scenario to Krknctl

Mon, 01 Jan 0001 00:00:00 +0000

Adding a New Scenario to Krknctl

For krknctl to find the parameters of the scenario it uses a krknctl input json file. Once this file is added to krkn-hub, krknctl will be able to find it along with the details of how to run the scenario.

Add KrknCtl Input Json

This file adds every environment variable that is set up for krkn-hub to be defined as a flag to the krknctl cli command. There are a number of different type of variables that you can use, each with their own required fields. See below for an example of the different variable types

Developers Guide

Mon, 01 Jan 0001 00:00:00 +0000

This document describes how to develop and add to Krkn. Before you start, it is recommended that you read the following documents first:

Be sure to properly install Krkn. Then you can start to develop krkn. The following documents will help you get started:

Add k8s functionality to krkn-lib
Add a New Chaos Scenario using Plugin API: Adding a new scenario into krkn
Add a Health Check Plugin: Monitor services during chaos using the health check plugin system
Test your changes

NOTE: All base kubernetes functionality should be added into krkn-lib and called from krkn