Developers Guide

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

  1. Krkn Main README
  2. List of all Supported Scenarios

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

  1. Add k8s functionality to krkn-lib
  2. Add a New Chaos Scenario using Plugin API: Adding a new scenario into krkn
  3. Test your changes

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

Once a scenario gets added to krkn, changes will be need in krkn-hub and krknctl as well. See steps below on help to edit krkn-hub and krknctl

Questions?

For any questions or further guidance, feel free to reach out to us on the Kubernetes workspace in the #krkn channel. We’re happy to assist. Now, release the Krkn!

Follow Contribution Guide

Once all you’re happy with your changes, follow the contribution guide on how to create your own branch and squash your commits