jinlxz / chaos-mesh

A Chaos Engineering Platform for Kubernetes.

Note:

This readme and related documentation are Work in Progress.

Chaos Mesh® is a Cloud Native Computing Foundation (CNCF) hosted project. It is a cloud-native Chaos Engineering platform that orchestrates chaos on Kubernetes environments. At the current stage, it has the following components:

• Chaos Operator: the core component for chaos orchestration. Fully open sourced.
• Chaos Dashboard: a Web UI for managing, designing, monitoring Chaos Experiments; under development.

See the following demo video for a quick view of Chaos Mesh:

Chaos Operator

Chaos Operator injects chaos into the applications and Kubernetes infrastructure in a manageable way, which provides easy, custom definitions for chaos experiments and automatic orchestration. There are three components at play:

Controller-manager: used to schedule and manage the lifecycle of CRD objects

Chaos-daemon: runs as daemonset with privileged system permissions over network, Cgroup, etc. for a specific node

Chaos Operator uses Custom Resource Definition (CRD) to define chaos objects. The current implementation supports a few types of CRD objects for fault injection, namely DNSChaos, PodChaos, PodIoChaos, PodNetworkChaos, NetworkChaos, IoChaos, TimeChaos, StressChaos, and KernelChaos, which correspond to the following major actions (experiments):

• pod-kill: The selected pod is killed (ReplicaSet or something similar may be needed to ensure the pod will be restarted).
• pod-failure: The selected pod will be unavailable in a specified period of time.
• container-kill: The selected container is killed in the selected pod.
• netem chaos: Network chaos such as delay, duplication, etc.
• network-partition: Simulate network partition.
• IO chaos: Simulate file system faults such as I/O delay, read/write errors, etc.
• time chaos: The selected pod will be injected with clock skew.
• cpu-burn: Simulate the CPU of the selected pod stress.
• memory-burn: Simulate the memory of the selected pod stress.
• kernel chaos: The selected pod will be injected with (slab, bio, etc) errors.
• dns chaos: The selected pod will be injected with dns errors, such as error, random.

Quick start

• Get Started on kind
• Get Started on minikube

Deploy and use

See Docs.

Adopters

See ADOPTERS.

Blogs

Blogs on Chaos Mesh design & implementation, features, chaos engineering, community updates, etc. See Chaos Mesh Blogs. Here are some recommended ones for you to start with:

• Chaos Mesh - Your Chaos Engineering Solution for System Resiliency on Kubernetes
• Run Your First Chaos Experiment in 10 Minutes
• Simulating Clock Skew in K8s Without Affecting Other Containers on the Node
• Building an Automated Testing Framework Based on Chaos Mesh® and Argo
• Chaos Mesh 1.0: Chaos Engineering on Kubernetes Made Easier

Contribute

See the contributing guide and development guide.

Community

Please reach out for bugs, feature requests, and other issues via:

• Following us on Twitter at @chaos_mesh.
• Joining the #project-chaos-mesh channel in the CNCF Slack workspace.
• Filing an issue or opening a PR against this repository.

Community meeting

On the fourth Thursday of every month (unless otherwise specified), the Chaos Mesh community holds a monthly meeting by video conference to discuss the status of Chaos Mesh.

Quick links:

• Meeting notes
• Zoom meeting link

Community blog

• Grant Tarrant-Fisher: Integrate your Reliability Toolkit with Your World, Part 2
• Yoshinori Teraoka: Streake: Chaos Mesh によるカオスエンジニアリング
• Sébastien Prud'homme: Chaos Mesh : un générateur de chaos pour Kubernetes
• Craig Morten
  • K8s Chaos Dive: Chaos-Mesh Part 1
  • K8s Chaos Dive: Chaos-Mesh Part 2
• Ronak Banka: Getting Started with Chaos Mesh and Kubernetes
• kondoumh: ​Kubernetes ネイティブなカオスエンジニアリングツール Chaos Mesh を使ってみる
• Vadim Tkachenko: ChaosMesh to Create Chaos in Kubernetes
• Hui Zhang: How a Top Game Company Uses Chaos Engineering to Improve Testing

Media coverage

• CodeZine: オープンソースのカオステストツール「Chaos Mesh 1.0」、一般提供を開始
• @IT atmarkit: Kubernetes 向けカオスエンジニアリングプラットフォーム「Chaos Mesh 1.0」が公開
• Publickey: Kubernetes の Pod やネットワークをわざと落としまくってカオスエンジニアリングのテストができる「Chaos Mesh」がバージョン 1.0 に到達
• InfoQ: Chaos Engineering on Kubernetes : Chaos Mesh Generally Available with v1.0
• TechGenix: Chaos Mesh Promises to Bring Order to Chaos Engineering

FAQs

See FAQs.

Roadmap

See ROADMAP.

License

Chaos Mesh is licensed under the Apache License, Version 2.0. See LICENSE for the full license text.

Trademark

Chaos Mesh® is a trademark of The Linux Foundation. All rights reserved.