Extended version of Chaos Toolkit Kubernetes support
Project description
# This is extended version of Chaos Toolkit Kubernetes Support
# Created to provide more flexibility with experiments
This project contains activities, such as probes and actions, you can call from
your experiment through the [Chaos Toolkit][chaostoolkit].
## 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-k8s-wix
```
## 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_wix,
"func": "microservice_available_and_healthy",
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
},
{
"type": "action",
"name": "terminate-db-pod",
"provider": {
"type": "python",
"module": chaosk8s_wix,
"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-k8s-wix --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/`, or, when
run from a Pod in a Kubernetes cluster, it will use the local service account.
In that case, make sure to set the `CHAOSTOOLKIT_IN_POD` environment variable
to `"true"`.
You can also pass the credentials via secrets as follows:
```json
{
"secrets": {
"kubernetes": {
"KUBERNETES_HOST": "http://somehost",
"KUBERNETES_API_KEY": {
"type": "env",
"key": "SOME_ENV_VAR"
}
}
}
}
```
Then in your probe or action:
```json
{
"name": "all-our-microservices-should-be-healthy",
"provider": {
"type": "python",
"module": chaosk8s_wix,
"func": "microservice_available_and_healthy",
"secrets": ["kubernetes"],
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
}
```
You may specify the Kubernetes context you want to use as follows:
```json
{
"secrets": {
"kubernetes": {
"KUBERNETES_CONTEXT": "minikube"
}
}
}
```
Or via the environment:
```
$ export KUBERNETES_CONTEXT=minikube
```
In the same spirit, you can specify where to find your Kubernetes configuration
with:
```
$ export KUBECONFIG=some/path/config
```
## 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
### Develop
If you wish to develop on this project, make sure to install the development
dependencies. But first, [create a virtual environment][venv] and then install
those dependencies.
[venv]: http://chaostoolkit.org/reference/usage/install/#create-a-virtual-environment
```console
$ pip install -r requirements-dev.txt -r requirements.txt
```
Then, point your environment to this directory:
```console
$ 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
```
# Created to provide more flexibility with experiments
This project contains activities, such as probes and actions, you can call from
your experiment through the [Chaos Toolkit][chaostoolkit].
## 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-k8s-wix
```
## 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_wix,
"func": "microservice_available_and_healthy",
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
},
{
"type": "action",
"name": "terminate-db-pod",
"provider": {
"type": "python",
"module": chaosk8s_wix,
"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-k8s-wix --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/`, or, when
run from a Pod in a Kubernetes cluster, it will use the local service account.
In that case, make sure to set the `CHAOSTOOLKIT_IN_POD` environment variable
to `"true"`.
You can also pass the credentials via secrets as follows:
```json
{
"secrets": {
"kubernetes": {
"KUBERNETES_HOST": "http://somehost",
"KUBERNETES_API_KEY": {
"type": "env",
"key": "SOME_ENV_VAR"
}
}
}
}
```
Then in your probe or action:
```json
{
"name": "all-our-microservices-should-be-healthy",
"provider": {
"type": "python",
"module": chaosk8s_wix,
"func": "microservice_available_and_healthy",
"secrets": ["kubernetes"],
"arguments": {
"name": "myapp",
"ns": "myns"
}
}
}
```
You may specify the Kubernetes context you want to use as follows:
```json
{
"secrets": {
"kubernetes": {
"KUBERNETES_CONTEXT": "minikube"
}
}
}
```
Or via the environment:
```
$ export KUBERNETES_CONTEXT=minikube
```
In the same spirit, you can specify where to find your Kubernetes configuration
with:
```
$ export KUBECONFIG=some/path/config
```
## 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
### Develop
If you wish to develop on this project, make sure to install the development
dependencies. But first, [create a virtual environment][venv] and then install
those dependencies.
[venv]: http://chaostoolkit.org/reference/usage/install/#create-a-virtual-environment
```console
$ pip install -r requirements-dev.txt -r requirements.txt
```
Then, point your environment to this directory:
```console
$ 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
```
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
chaostoolkit-k8s-wix-1.1.4.tar.gz
(22.4 kB
view hashes)
Built Distribution
Close
Hashes for chaostoolkit-k8s-wix-1.1.4.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d0958f155148ded2e851a986ad2801f74ba8b58565ab7297199e4e1dbe2428cc |
|
MD5 | d971c87048dcf4063fdb1f28765f66d7 |
|
BLAKE2b-256 | b863e9acbbc16b29eb4c4fdab42ddd9d60856805375c506befb2ca0fce195eea |
Close
Hashes for chaostoolkit_k8s_wix-1.1.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c076092032b17aaa47ca92f27beee4c08b1e519ded1f995a74d53d36c0315e7a |
|
MD5 | 78c6df05f8b83361ea0ee14116dc176b |
|
BLAKE2b-256 | 4393860b2e3a52b5bbe41aa3f52bf74464421c2e213d3859beca25c9d615d8a1 |