Proofdock extension for the Chaos Toolkit

This project is a collection of features gathered as an extension to the Proofdock Chaos Engineering Platform and the Chaos Toolkit.

Project description

This project is part of the Proofdock Chaos Engineering Platform that helps you to write, run, store and analyze chaos experiments in your Azure DevOps environment.

For more information visit our official website or documentation. Feel free to ask for support for this package on GitHub.

Getting started

To get started check out our official guide.

Install

This package requires Python 3.5+

$ pip install -U proofdock-chaos-kit

Configuration

The Proofdock Chaos CLI expects that you have a proper API token that allows you to authenticate against the Proofdock cloud. Learn more about the API token generation here.

To configure the API token you simply pass it to the chaos configure command.

chaos configure --token <API token>

Chaos CLI stores your API token in a settings file located under the following path:

$HOME/.chaostoolkit/settings.yaml

Alternatively set the API token using an environment variable PROOFDOCK_API_TOKEN.

export PROOFDOCK_API_TOKEN=<API token>

Precedence of options

If you specify the API token by using the PROOFDOCK_API_TOKEN environment variable, it overrides any API token value loaded from a settings file.

Commands

The Proofdock Chaos CLI introduces new commands:

• chaos configure
• chaos experiment

and extends an existing chaos run command with new options.

Run

You use the chaos run command to run an experiment and upload its results to the Proofdock cloud.

chaos run [OPTIONS] experiment.json

Configure

You use the chaos configure command to set the API token in a settings file.

chaos configure --token <API token>

Options

  --token TEXT            Token value

List

You use experiment list command to list all experiments in your project.

chaos experiment list