github/krkn
1
0
Fork 0
mirror of https://github.com/krkn-chaos/krkn.git synced 2026-02-14 18:10:00 +00:00
Code Issues Packages Projects Releases Wiki Activity

Adding getting started docs

Browse Source
This commit is contained in:
prubenda
2021-02-25 10:06:10 -05:00
committed by Naga Ravi Chaitanya Elluri
parent 41bf815f98
commit 5456fce924
5 changed files with 96 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -7,14 +7,17 @@ Kraken injects deliberate failures into Kubernetes/OpenShift clusters to check i
![Kraken workflow](media/kraken-workflow.png)
### Installation and usage
### How to Get Started
Instructions on how to setup, configure and run Kraken can be found at [Installation](docs/installation.md).
See the [getting started doc](docs/getting_started.md) on support on how to get started with your own custom scenario or editing current scenarios for your specific usage
After installation, refer back to the below sections for supported scenarios and how to tweak the kraken config to load them on your cluster
### Config
Instructions on how to setup the config and the options supported can be found at [Config](docs/config.md).
### Kubernetes/OpenShift chaos scenarios supported
Kraken supports pod, node, time/date and [litmus](https://github.com/litmuschaos/litmus) based scenarios.