proofdock-chaos-kit 0.0.4

Extend the Chaos Toolkit with capabilities for the Proofdock Chaos Engineering Platform

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.

Install

This package requires Python 3.5+

$ pip install -U proofdock-chaos-kit

Usage

To use the features ...

Configuration

The Proofdock Chaos Kit uses the Chaos Toolkit under the hood. The Proofdock Chaos Kit expects that you have an API url and a proper API token that allows you to authenticate against the Proofdock chaos API.

Configuration values for the Proofdock Chaos Kit can come from several sources:

• Settings file, e.g.

  # located in ~/.chaostoolkit/settings.yaml
  auths:
    chaosapi.proofdock.io:
      type: bearer
      value: my_api_token_here
  controls:
    proofdock:
      provider:
        arguments:
          api_url: https://chaosapi.proofdock.io/
        module: pdchaoskit.controls
        type: python
  

• Environment variables:
  • PROOFDOCK_API_TOKEN - override the token from your settings file.

The Proofdock Chaos Kit will first try to load the configuration from the settings file. If no configuration is provided, it will try to load it from the environment variables. Please check the usage command to see how to set up the settings file with the Proofdock Chaos Kit.

Putting it all together

Here is a full example for

Contribute

If you wish to contribute more functions to this package, you are more than welcome to do so. Please, fork this project, make your changes following the usual PEP 8 code style, sprinkling with tests and submit a PR for review.

The Proofdock projects require all contributors to 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.

Develop

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.

$ pip install -r requirements-dev.txt -r requirements.txt

Then, point your environment to this directory:

$ python setup.py develop

Now, you can edit the files and they will be automatically be seen by your environment, even when running from the chaos command locally.

Test

To run the tests for the project execute the following:

$ pytest