Chaos Toolkit Kubernetes support
Project description
# 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
To use the probes and actions from this package, add the following to your
experiment file:
```json
{
"name": "all-our-microservices-should-be-healthy",
"provider": {
"type": "python",
"module": "chaosk8s.probes",
"func": "microservice_available_and_healthy",
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
}
```
That's it!
Please explore the code to see existing probes and actions.
## Configuration
This extension to the Chaos Toolkit can use the Kubernetes configuration
found at the usual place in your HOME directory under `~/.kube/`. You can
also pass the credentials via secrets as follows:
```json
{
"secrets": {
"kubernetes": {
"KUBERNETES_HOST": "http://somehost",
"KUBERNETES_API_KEY": {
"type": "env",
"key": "SO%E_ENV_VAR"
}
}
}
}
```
Then in your probe or action:
```
{
"name": "all-our-microservices-should-be-healthy",
"provider": {
"type": "python",
"module": "chaosk8s.probes",
"func": "microservice_available_and_healthy",
"secrets": ["kubernetes"],
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
}
```
## 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, add appropriate tests and submit a PR for
review.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
[![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
To use the probes and actions from this package, add the following to your
experiment file:
```json
{
"name": "all-our-microservices-should-be-healthy",
"provider": {
"type": "python",
"module": "chaosk8s.probes",
"func": "microservice_available_and_healthy",
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
}
```
That's it!
Please explore the code to see existing probes and actions.
## Configuration
This extension to the Chaos Toolkit can use the Kubernetes configuration
found at the usual place in your HOME directory under `~/.kube/`. You can
also pass the credentials via secrets as follows:
```json
{
"secrets": {
"kubernetes": {
"KUBERNETES_HOST": "http://somehost",
"KUBERNETES_API_KEY": {
"type": "env",
"key": "SO%E_ENV_VAR"
}
}
}
}
```
Then in your probe or action:
```
{
"name": "all-our-microservices-should-be-healthy",
"provider": {
"type": "python",
"module": "chaosk8s.probes",
"func": "microservice_available_and_healthy",
"secrets": ["kubernetes"],
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
}
```
## 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, add appropriate tests and submit a PR for
review.
[pep8]: https://pycodestyle.readthedocs.io/en/latest/
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for chaostoolkit-kubernetes-0.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3daf612253eae53293e462941465c3dcd7eb1ed555b6521c7d8a91191128692d |
|
MD5 | 90658f732f500907e19b67e0463e2255 |
|
BLAKE2b-256 | f42677b14bd37eda2bdf2e2d278cfc2d3edfcb217cbd2efeacd3416b2fce46eb |
Close
Hashes for chaostoolkit_kubernetes-0.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6474bb9d323368487e45a5ef81313fde9e9e13f466c1b06c25ca73663bd84046 |
|
MD5 | 64f9571152c4f95f9047202709ea9c10 |
|
BLAKE2b-256 | 5562cd98dd85a4067aa86a7bd4325a3a5c0f4dc58131993b1afafd0dec9e8093 |