# Chaos Toolkit Kubernetes Support
[](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"
}
}
},
{
"type": "action",
"name": "terminate-db-pod",
"provider": {
"type": "python",
"module": "chaosk8s.pod.actions",
"func": "terminate_pods",
"arguments": {
"label_selector": "app=my-app",
"name_pattern": "my-app-[0-9]$",
"rand": true,
"ns": "default"
}
},
"pauses": {
"after": 5
}
}
```
That's it! Notice how the action gives you the way to kill one pod randomly.
Please explore the code to see existing probes and actions.
### Discovery
You may use the Chaos Toolkit to discover the capabilities of this extension:
```
$ chaos discover chaostoolkit-kubernetes --no-install
```
## 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:
```json
{
"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/
The Chaos Toolkit projects require all contributors must sign a
[Developer Certificate of Origin][dco] 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.
[dco]: https://github.com/probot/dco#how-it-works
[](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"
}
}
},
{
"type": "action",
"name": "terminate-db-pod",
"provider": {
"type": "python",
"module": "chaosk8s.pod.actions",
"func": "terminate_pods",
"arguments": {
"label_selector": "app=my-app",
"name_pattern": "my-app-[0-9]$",
"rand": true,
"ns": "default"
}
},
"pauses": {
"after": 5
}
}
```
That's it! Notice how the action gives you the way to kill one pod randomly.
Please explore the code to see existing probes and actions.
### Discovery
You may use the Chaos Toolkit to discover the capabilities of this extension:
```
$ chaos discover chaostoolkit-kubernetes --no-install
```
## 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:
```json
{
"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/
The Chaos Toolkit projects require all contributors must sign a
[Developer Certificate of Origin][dco] 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.
[dco]: https://github.com/probot/dco#how-it-works
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file chaostoolkit-kubernetes-0.11.0.tar.gz.
File metadata
- Download URL: chaostoolkit-kubernetes-0.11.0.tar.gz
- Upload date:
- Size: 13.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
3801951547bf22b928511492851aafd571386a1b61de6e1dd30425622348a86c
|
|
| MD5 |
f60eced1a60c3dc437736edc4fc3361d
|
|
| BLAKE2b-256 |
ecac30953264bbd514272c3a1d64576344f1e002628409db510aaf55ec648bd3
|
File details
Details for the file chaostoolkit_kubernetes-0.11.0-py3-none-any.whl.
File metadata
- Download URL: chaostoolkit_kubernetes-0.11.0-py3-none-any.whl
- Upload date:
- Size: 11.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
07f264a27745197ff695667d7240ef383b11011e4b15c458480720aa1d9fc85f
|
|
| MD5 |
a2af144b35ff30c6a12daba5cbfbe569
|
|
| BLAKE2b-256 |
fcca0c0ebf83a65c8b4a8bd5bda4fb27171c4c3ade7e3e2ca9d2a9ab5fb0607f
|
