Chaos Toolkit Core Library
The Chaos Toolkit core library implementing the Open Chaos Initiative.
The purpose of this library is to provide the core of the Chaos Toolkit model and functions it needs to render its services.
Unless you wish to create your own toolkit, you will likely not use directly this library.
The library provides the followings features:
discover capabilities from extensions Allows you to explore the support from an extension that would help you initialize an experiment against the system this extension targets
validate a given experiment syntax The validation looks at various keys in the experiment and raises errors whenever something doesn't look right. As a nice addition, when a probe calls a Python function with arguments, it tries to validate the given argument list matches the signature of the function to apply.
run your steady state before and after the method. The former as a gate to decide if the experiment can be executed. The latter to see if the system deviated from normal.
run probes and actions declared in an experiment It runs the steps in a experiment method sequentially, applying first steady probes, then actions and finally close probes.
A journal, as a JSON payload, is return of the experiment run.
The library supports running probes and actions defined as Python functions, from importable Python modules, processes and HTTP calls.
run experiment's rollbacks when provided
Load secrets from the experiments, the environ or vault
Provides event notification from Chaos Toolkit flow (although the actual events are published by the CLI itself, not from this library), supported events are:
- on experiment validation: started, failed or completed
- on discovery: started, failed or completed
- on initialization of experiments: started, failed or completed
- on experiment runs: started, failed or completed
For each event, the according payload is part of the event as well as a UTC timestamp.
If you are user of the Chaos Toolkit, you probably do not need to install this package yourself as it comes along with the chaostoolkit cli.
However, should you wish to integrate this library in your own Python code, please install it as usual:
$ pip install -U chaostoolkit-lib
In addition to essential dependencies, the package can install a couple of other extra dependencies for specific use-cases. They are not mandatory and the library will warn you if you try to use a feature that requires them.
If you need Vault support to read secrets from, run the following command:
$ pip install -U chaostoolkit-lib[vault]
To authenticate with Vault, you can either:
- Use a token through the
- Use an AppRole via the
vault_secret_idpair of configuration keys
- Use a service account configured with an appropriate role via the
vault_sa_roleconfiguration key. The
vault_secrets_mount_pointconfiguration keys can optionally be specified to point to a location containing a service account token, a different Kubernetes authentication method mount point, or a different secrets mount point, respectively.
If you need JSON Path support for tolerance probes in the hypothesis, also run the following command:
$ pip install -U chaostoolkit-lib[jsonpath]
When using a process activity, the standard output end error streams are logged
chaostoolkit.log file. The default encoding used is
utf-8 to decode
those streams. Sometimes, this is not the right encoding, so you can install
the chardet or cchardet packages to attempt the detection of the right
$ pip install -U chaostoolkit-lib[decoders]
Contributors to this project are welcome as this is an open-source effort that seeks discussions and continuous improvement.
From a code perspective, if you wish to contribute, you will need to run a
Python 3.6+ environment. Please, fork this project, write unit tests to cover
the proposed changes, implement the changes, ensure they meet the formatting
standards set out by
isort, add an entry into
CHANGELOG.md, and then raise a PR to the repository for review.
Please refer to the formatting section for more information on the formatting standards.
The Chaos Toolkit projects require 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.
If you wish to develop on this project, make sure to install the development dependencies. But first, create a virtual environment and then install those dependencies.
$ make install-dev
Now, you can edit the files and they will be automatically be seen by your
environment, even when running from the
chaos command locally.
To run the tests for the project execute the following:
$ make tests
Formatting and Linting
Before raising a Pull Request, we recommend you run formatting against your code with:
$ make format
This will automatically format any code that doesn't adhere to the formatting standards.
As some things are not picked up by the formatting, we also recommend you run:
$ make lint
To ensure that any unused import statements/strings that are too long, etc. are also picked up.