Metadata-Version: 2.0
Name: chaostoolkit-kubernetes
Version: 0.4.0
Summary: Chaos Toolkit Kubernetes support
Home-page: http://chaostoolkit.org
Author: chaostoolkit Team
Author-email: sh@defuze.org
License: Apache License Version 2.0
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: Freely Distributable
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation
Classifier: Programming Language :: Python :: Implementation :: CPython
Requires-Python: >=3.5.*
Requires-Dist: chaostoolkit-lib
Requires-Dist: kubernetes
Requires-Dist: pycodestyle
Requires-Dist: pyyaml

# Chaos Toolkit Kubernetes Support

[![Build Status](https://travis-ci.org/chaostoolkit/chaostoolkit-kubernetes.svg?branch=master)](https://travis-ci.org/chaostoolkit/chaostoolkit-kubernetes)

This project contains activities, such as probes and actions, you can call from
your experiment through the Chaos Toolkit.

## Install

To be used from your experiment, this package must be installed in the Python
environment where [chaostoolkit][] already lives.

[chaostoolkit]: https://github.com/chaostoolkit/chaostoolkit

```
$ pip install chaostoolkit-kubernetes
```

## Usage

First, in your experimenty project, make sure

To use the probes and actions from this package, add the following to your
experiment file:

```json
{
    "title": "Our microservice should really be gone by now",
    "layer": "kubernetes",
    "type": "python",
    "module": "chaosk8s.probes",
    "func": "microservice_available_and_healthy",
    "arguments": {
        "name": "mysvc"
    }
}
```

That's it!

Please explore the code to see existing provbes and actions.

## Configuration

This extension to the Chaos Toolkit expects the Kubernetes configuyration to 
be found at the usual place in your HOME directory under `~/.kube/`.

You should therefore ensure you can fully connect to your Kubernetes cluster
from a `kubectl` command before using this extension in your experiment.

## 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][pep8] code style, sprinkling with tests and submit a PR for
review.

[pep8]: https://pycodestyle.readthedocs.io/en/latest/


