Litmus helps SREs and developers practice chaos engineering in a Cloud-native way. Chaos experiments are published at the ChaosHub (https://hub.litmuschaos.io). Community notes is at https://hackmd.io/a4Zu_sH4TZGeih-xCimi3Q

Go to file

Karthik Satchitanand 84cd26daed (feat)developer_docs: add tool to scaffold experiment artefacts (#887 ) Signed-off-by: ksatchit <ksatchit@mayadata.io>		2019-10-23 18:41:05 +05:30
.github	adding multiple templates for github issues (#838 )	2019-10-11 09:10:34 +05:30
build	Experiment[YAML]: CPU_Hog (#830 )	2019-10-21 19:35:16 +05:30
chaoslib	Experiment[YAML]: CPU_Hog (#830 )	2019-10-21 19:35:16 +05:30
ci_plugins/gitlab	(restructure)repo: restructure litmus repo for generic chaos: contd	2019-09-30 10:50:28 +00:00
contribute/developer_guide	(feat)developer_docs: add tool to scaffold experiment artefacts (#887 )	2019-10-23 18:41:05 +05:30
executor	Delete Completed Jobs and updated README.md for steps (#854 )	2019-10-21 16:22:24 +05:30
experiments	Experiment[YAML]: CPU_Hog (#830 )	2019-10-21 19:35:16 +05:30
hack	refactor[Makefile]: Modified the docker repo name in Makefile (#766 )	2019-09-30 11:39:35 +05:30
images	Adding new images to be used for Litmus branding (#812 )	2019-10-06 17:55:19 +05:30
utils	(restructure)repo: restructure litmus repo for generic chaos: contd	2019-09-30 10:50:28 +00:00
.gitignore	Create unit test for pkg/time/time.go (#306 )	2018-10-16 07:16:59 +05:30
.travis.yml	(chore)ci: add sonarqube quality check (#847 )	2019-10-14 12:46:06 +05:30
CODE_OF_CONDUCT.md	(fix): Typo fix in CODE_OF_CONDUCT.md and README.md (#834 )	2019-10-11 13:45:41 +05:30
CONTRIBUTING.md	(community)contributing_guide: include sync up meeting details (#884 )	2019-10-22 15:07:04 +05:30
LICENSE	fix(licence): Update LICENCE fields	2018-10-03 16:10:11 +02:00
Makefile	(refactor)experiments: rename experiment artefacts (#800 )	2019-10-04 20:24:12 +05:30
NOTICE.md	(restructure)repo: restructure litmus repo for generic chaos: contd	2019-09-30 10:50:28 +00:00
README.md	Update README.md (#846 )	2019-10-22 21:14:22 +05:30
sonar-project.properties	(chore)ci: add sonarqube quality check (#847 )	2019-10-14 12:46:06 +05:30

README.md

Cloud-Native Chaos Engineering; Kubernetes-Native Chaos Engineering; Chaos Engineering for Kubernetes

Overview

Litmus is a toolset to do cloud-native chaos engineering. Litmus provides tools to orchestrate chaos on Kubernetes to help SREs find weaknesses in their deployments. SREs use Litmus to run chaos experiments initially in the staging environment and eventually in production to find bugs, vulnerabilities. Fixing the weaknesses leads to increased resilience of the system.

Litmus takes a cloud-native approach to create, manage and monitor chaos. Chaos is orchestrated using the following Kubernetes Custom Resource Definitions (CRDs):

ChaosEngine: A resource to link a Kubernetes application or Kubernetes node to a ChaosExperiment. ChaosEngine is watched by Litmus' Chaos-Operator which then invokes Chaos-Experiments
ChaosExperiment: A resource to group the configuration parameters of a chaos experiment. ChaosExperiment CRs are created by the operator when experiments are invoked by ChaosEngine.
ChaosResult: A resource to hold the results of a chaos-experiment. The Chaos-exporter reads the results and exports the metrics into a configured Prometheus server.

Chaos experiments are hosted on hub.litmuschaos.io. It is a central hub where the application developers or vendors share their chaos experiments so that their users can use them to increase the resilience of the applications in production.

Use cases

For Developers: To run chaos experiments during application development as an extension of unit testing or integration testing.
For CI pipeline builders: To run chaos as a pipeline stage to find bugs when the application is subjected to fail paths in a pipeline.
For SREs: To plan and schedule chaos experiments into the application and/or surrounding infrastructure. This practice identifies the weaknesses in the system and increases resilience.

Demo

Getting Started with Litmus

See Litmus Docs.

Contributing to Chaos Hub

See Contributing to chaos hub

Adopters

(Send a PR to the above page if you are using Litmus in your chaos engineering practice)

License

Litmus is licensed under the Apache License, Version 2.0. See LICENSE for the full license text. Some of the projects used by the Litmus project may be governed by a different license, please refer to its specific license.

Important Links

Litmus Docs

CNCF Landscape