From d62f2f45e5298b562285e52e4e24ea0f65eaf534 Mon Sep 17 00:00:00 2001 From: Shubham Chaudhary Date: Wed, 15 Dec 2021 18:09:58 +0530 Subject: [PATCH] update(readme): adding charts details inside readme (#519) * update(readme): adding charts details inside readme Signed-off-by: shubham chaudhary * Apply suggestions from code review Co-authored-by: shubham chaudhary --- README.md | 199 +++++++++++++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 197 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0091e6c..7758d75 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,202 @@ # Chaos-Charts -[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bgithub.com%2Flitmuschaos%2Fchaos-charts.svg?type=shield)](https://app.fossa.io/projects/git%2Bgithub.com%2Flitmuschaos%2Fchaos-charts?ref=badge_shield) +[![Slack Channel](https://img.shields.io/badge/Slack-Join-purple)](https://slack.litmuschaos.io) +![GitHub Workflow](https://github.com/litmuschaos/chaos-charts/actions/workflows/push.yml/badge.svg?branch=master) +[![Docker Pulls](https://img.shields.io/docker/pulls/litmuschaos/go-runner.svg)](https://hub.docker.com/r/litmuschaos/go-runner) +[![GitHub issues](https://img.shields.io/github/issues/litmuschaos/chaos-charts)](https://github.com/litmuschaos/chaos-charts/issues) +[![Twitter Follow](https://img.shields.io/twitter/follow/litmuschaos?style=social)](https://twitter.com/LitmusChaos) +[![YouTube Channel](https://img.shields.io/badge/YouTube-Subscribe-red)](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw) +

+ +This repository hosts the Litmus Chaos Charts. A set of related chaos experiments are bundled into a Chaos Chart. Chaos Charts are classified into the following categories. + +- [Generic Chaos](#generic-chaos) +- [Application Chaos](#application-chaos) +- [Platform Chaos](#platform-chaos) + +### Generic Chaos + +Chaos actions that apply to generic Kubernetes resources are classified into this category. Following chaos experiments are supported under Generic Chaos Chart + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Experiment Name Description Link
Container Kill Kill one container in the application pod container-kill
Disk Fill Fill the Ephemeral Storage of the Pod disk-fill
Docker Service Kill Kill docker service of the target node docker-service-kill
Kubelet Service Kill Kill kubelet service of the target node kubelet-service-kill
Node CPU Hog Stress the cpu of the target node node-cpu-hog
Node Drain Drain the target node node-drain
Node IO Stress Stress the IO of the target node node-io-stress
Node Memory Hog Stress the memory of the target node node-memory-hog
Node Restart Restart the target node node-restart
Node Taint Taint the target node node-taint
Pod Autoscaler Scale the replicas of the target application pod-autoscaler
Pod CPU Hog Stress the CPU of the target pod pod-cpu-hog
Pod Delete Delete the target pods pod-delete
Pod DNS Spoof Spoof dns requests to desired target hostnames pod-dns-spoof
Pod DNS Error Error the dns requests of the target pod pod-dns-error
Pod IO Stress Stress the IO of the target pod pod-io-stress
Pod Memory Hog Stress the memory of the target pod pod-memory-hog
Pod Network Latency Induce the network latency in target pod pod-network-latency
Pod Network Corruption Induce the network packet corruption in target pod pod-network-corruption
Pod Network Duplication Induce the network packet duplication in target pod pod-network-duplication
Pod Network Loss Induce the network loss in target pod pod-network-loss
Pod Network Partition Disrupt network connectivity to kubernetes pods pod-network-partition
+ +### Application Chaos + +While Chaos Experiments under the Generic category offer the ability to induce chaos into Kubernetes resources, it is difficult to analyze and conclude if the chaos induced found a weakness in a given application. The application specific chaos experiments are built with some checks on *pre-conditions* and some expected outcomes after the chaos injection. The result of the chaos experiment is determined by matching the outcome with the expected outcome. + + + + + + + + + + + + + + + + + + + + + + + +
Experiment Name Description Link
OpenEBS Experiments Injects faults in OpenEBS tool OpenEBS experiments
Kafka Experiments Inject faults in kafka application kafka experiments
Cassandra Experiments Inject faults in cassandra application cassandra experiments
+ +### Platform Chaos + +Chaos experiments that inject chaos into the platform resources of Kubernetes are classified into this category. Management of platform resources vary significantly from each other, Chaos Charts may be maintained separately for each platform (For example, AWS, GCP, Azure, VMWare etc) + +Following Platform Chaos experiments are available on ChaosHub + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Experiment Name Description Link
AWS Experiments AWS Platform specific chaos AWS Experiments
Azure Experiments Azure Platform specific chaos Azure Experiments
GCP Experiments GCP Platform specific chaos GCP Experiments
VMWare Experiments VMWare Platform specific chaos VMWare Experiments
-This repository hosts the Litmus Chaos Charts. ## Installation Steps for Chart Releases