Skip to content

Latest commit

 

History

History
28 lines (15 loc) · 2.22 KB

README.md

File metadata and controls

28 lines (15 loc) · 2.22 KB
Raw

Welcome to the Open Chaos Experiment Catalog!

This is a free, public and community-contributed catalog of chaos engineering experiments.

Catalog Layout and Experiment Format

The format of the catalog is relatively flexible, being a resource that will index many different types of experiments and even potentially different experiment-executing tools and systems. The current convention, where applicable, for a new experiment to be added to the catalog are:

  1. Every experiment should reside in its own directory below a parent directory that is used to group experiments by target platform context, i.e. Kubernetes, Azure, AWS etc.

  2. Top level tags for an experiment are recommended to be platform and service, with a corresponding descriptor after a :.

    Platform specifies the overall platform being targetted or manipulated by the experiment, for example platform:kubernetes. service, where applicable, specifies any sub-service of the platform being employed, such as service:node. Any combination of platform:* and service:* tags may be used for a single experiment so that it is appropriately indexed for catalog searching.

  3. A README.md is recommended, following the general template form as show by the file-must-not-disappear experiment sample.

  4. Optionally Yaml as well as JSON can be provided as the preferred format of an experiment, according to an author's tastes. However it is advised to submit both formats if possible.

Contributing to this Experiment Catalog

If you wish to contribute to this experiment catalog, you are more than welcome to do so. Please, fork this project, make your changes, and submit a PR for review.

We recommend that any experiments written to use the Chaos Toolkit should use the toolkit's chaos validate command to test the syntax of an experiment before it is submitted for consideration to the catalog.

This project also requires all contributors must sign a Developer Certificate of Origin on each commit they would like to merge into the master branch of the repository. Please, make sure you can abide by the rules of the DCO before submitting a PR.