mirror of
https://github.com/krkn-chaos/krkn.git
synced 2026-04-15 06:57:28 +00:00
45 lines
2.3 KiB
Markdown
45 lines
2.3 KiB
Markdown
# Kraken
|
|
Chaos and resiliency testing tool for Kubernetes and OpenShift.
|
|
Kraken injects deliberate failures into Kubernetes/OpenShift clusters to check if it is resilient to turbulent conditions.
|
|
|
|
|
|
### Workflow
|
|
|
|
|
|
|
|
### Installation and usage
|
|
Instructions on how to setup, configure and run Kraken can be found at [Installation](docs/installation.md).
|
|
|
|
|
|
### 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 and time/date based scenarios.
|
|
|
|
- [Pod Scenarios](docs/pod_scenarios.md)
|
|
|
|
- [Node Scenarios](docs/node_scenarios.md)
|
|
|
|
- [Time Scenarios](docs/time_scenarios.md)
|
|
|
|
### Kraken scenario pass/fail criteria and report
|
|
It's important to make sure to check if the targeted component recovered from the chaos injection and also if the Kubernetes/OpenShift cluster is healthy as failures in one component can have an adverse impact on other components. Kraken does this by:
|
|
- Having built in checks for pod and node based scenarios to ensure the expected number of replicas and nodes are up. It also supports running custom scripts with the checks.
|
|
- Leveraging [Cerberus](https://github.com/openshift-scale/cerberus) to monitor the cluster under test and consuming the aggregated go/no-go signal to determine pass/fail. It is highly recommended to turn on the Cerberus health check feature avaliable in Kraken. Instructions on installing and setting up Cerberus can be found [here](https://github.com/openshift-scale/cerberus#installation). Once Cerberus is up and running, set cerberus_enabled to True and cerberus_url to the url where Cerberus publishes go/no-go signal in the Kraken config file.
|
|
|
|
|
|
### Blogs and other useful resources
|
|
- https://www.openshift.com/blog/introduction-to-kraken-a-chaos-tool-for-openshift/kubernetes
|
|
|
|
|
|
### Contributions
|
|
We are always looking for more enhancements, fixes to make it better, any contributions are most welcome. Feel free to report or work on the issues filed on github.
|
|
|
|
|
|
### Community
|
|
Key Members(slack_usernames): paigerube14, rook, mffiedler, mohit, dry923, rsevilla, ravi
|
|
* [**#sig-scalability on Kubernetes Slack**](https://kubernetes.slack.com)
|
|
* [**#forum-perfscale on CoreOS Slack**](https://coreos.slack.com)
|