litmus README

The project's README from github.com/litmuschaos/litmus. As one markdown file: README.md.

LitmusChaos

LitmusChaos

Open Source Chaos Engineering Platform

Slack Channel GitHub Workflow Docker Pulls GitHub stars GitHub issues Twitter Follow OpenSSF Best Practices FOSSA Status YouTube Channel



Read this in other languages.

🇰🇷 🇨🇳 🇧🇷 🇮🇳 🇪🇸

Overview

LitmusChaos is an open source Chaos Engineering platform that enables teams to identify weaknesses & potential outages in infrastructures by inducing chaos tests in a controlled way. Developers & SREs can practice Chaos Engineering with LitmusChaos as it is easy to use, based on modern Chaos Engineering principles & community collaborated. It is 100% open source & a CNCF project.

LitmusChaos takes a cloud-native approach to create, manage and monitor chaos. The platform itself runs as a set of microservices and uses Kubernetes custom resources (CRs) to define the chaos intent, as well as the steady state hypothesis.

At a high-level, Litmus comprises of:

architecture summary

At the heart of the platform are the following chaos custom resources:

The ChaosExperiment & ChaosEngine CRs are embedded within a Workflow object that can string together one or more experiments in a desired order.

ChaosExperiment CRs 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

Getting Started with Litmus

To get started, check out the Litmus Docs and specifically the Installation section of the Getting Started with Litmus page.

Contributing to Chaos Hub

Check out the Contributing Guidelines for the Chaos Hub

Community

Community Resources:

Feel free to reach out if you have any queries, concerns, or feature requests

Community Meetings

  1. Community Meetings
  1. Contributor Meetings

Fill out the LitmusChaos Meetings invite form to get your Calendar invite!

Videos

And More....

Blogs

Community Blogs:

Adopters

Check out the Adopters of LitmusChaos

(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.

FOSSA Status

Litmus Chaos is part of the CNCF Projects.

CNCF

Litmus Docs Litmus Docs
CNCF Landscape Litmus on CNCF Landscape

litmus (litmuschaos/litmus)

Searching Database…

5.7K ·GitHub
What is this?LitmusChaos is an open source, cloud-native chaos engineering platform built for Kubernetes that lets SREs and developers run controlled chaos experiments to find weaknesses before a real outage does.
Is this a standalone app or something that runs inside my Kubernetes cluster?It runs as a set of microservices on top of Kubernetes: a Chaos Control Plane (chaos-center) builds, schedules and visualizes chaos workflows, while the Chaos Execution Plane (a chaos agent plus operators) actually runs the faults against your target cluster.
How do I get Litmus running?The README points to the Installation section of the Getting Started with Litmus page in the official docs rather than giving install commands directly.
Do I need an existing Kubernetes cluster to use this?Yes — Litmus is built entirely around Kubernetes custom resources (ChaosExperiment, ChaosEngine, ChaosResult) that are deployed against a target Kubernetes environment, so a running cluster is required.
Who is Litmus meant for — developers, CI/CD, or ops teams?All three: developers can run chaos tests as an extension of unit/integration testing, CI/CD pipeline builders can add chaos as a pipeline stage, and SREs can plan and schedule chaos experiments to harden production infrastructure.
What is the ChaosHub?ChaosHub (hub.litmuschaos.io) is a central hub where developers and vendors publish their ChaosExperiment custom resources so other users can reuse them to test the resilience of their own applications.
Can I plug in my own fault-injection tooling instead of using Litmus's built-in experiments?Yes, through BYOC (bring-your-own-chaos) a ChaosExperiment can wrap any third-party fault-injection tool while Litmus still handles scheduling and the steady-state checks.
How do I see whether a chaos experiment passed or failed?Each run produces a ChaosResult resource with the verdict and rollback status, and a chaos-exporter turns that into Prometheus metrics for dashboards and automated pipelines.
What are ChaosExperiment, ChaosEngine and ChaosResult?ChaosExperiment defines a reusable fault template, ChaosEngine links that fault to a specific target workload/node with run and probe settings, and ChaosResult stores the outcome of the run.
What are similar projects?thanos, istio, post-mortems, apisix, cilium, chaosmonkey, jaeger, faas
Size
172.7 MB
Stars
5.7K
Age
9y
Commits · 90 Days