Skip to main content
Donate to the Python Software Foundation or Purchase a PyCharm License to Benefit the PSF! Donate Now

PowerfulSeal - a powerful testing tool for Kubernetes clusters

Project description

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2017 Bloomberg Finance L.P.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Description: # PowerfulSeal [![Travis](https://img.shields.io/travis/bloomberg/powerfulseal.svg)](https://travis-ci.org/bloomberg/powerfulseal) [![PyPI](https://img.shields.io/pypi/v/powerfulseal.svg)](https://pypi.python.org/pypi/powerfulseal)

__PowerfulSeal__ adds chaos to your Kubernetes clusters, so that you can detect problems in your systems as early as possible. It kills targeted pods and takes VMs up and down.

![Powerful Seal Logo](media/powerful-seal.png)

It follows the [Principles of Chaos Engineering](http://principlesofchaos.org/), and is inspired by [Chaos Monkey](https://github.com/Netflix/chaosmonkey). [Watch the Seal at KubeCon 2017 Austin](https://youtu.be/00BMn0UjsG4).

Embrace the inevitable failure. __Embrace The Seal__.


## On the menu

- [Highlights](#highlights)
- [Introduction](#introduction)
- [Modes of operation](#modes-of-operation)
- [Interactive mode](#interactive-mode)
- [Autonomous mode](#autonomous-mode)
- [Metrics Collection](#metrics-collection)
- [Web user interface](#web-user-interface)
- [Writing policies](#writing-policies)
- [Label mode](#label-mode)
- [Demo mode](#demo-mode)
- [Setup](#setup)
- [Minikube setup](#minikube-setup)
- [Getting started](#getting-started)
- [Testing](#testing)
- [Read about the PowerfulSeal](#read-about-the-powerfulseal)
- [FAQ](#faq)
- [Footnotes](#footnotes)

## Highlights

- works with `OpenStack`, `AWS` and local machines
- speaks `Kubernetes` natively
- interactive and autonomous, policy-driven mode
- web interface to interact with PowerfulSeal
- metric collection and exposition to `Prometheus`
- minimal setup, easy yaml-based policies
- easy to extend


## Introduction

__PowerfulSeal__ works in several modes:

- __Interactive__ mode is designed to allow you to discover your cluster's components and manually break things to see what happens. It operates on nodes, pods, deployments and namespaces.

- __Autonomous__ mode reads a policy file, which can contain any number of pod and node scenarios. Each scenario describes a list of matches, filters and actions to execute on your cluster, and will be executed in a loop.

- __Label__ mode allows you to specify which pods to kill with a small number of options by adding `seal/` labels to pods. This is a more imperative alternative to autonomous mode.

- __Demo__ mode allows you to point the Seal at a cluster and a `heapster` server and let it try to figure out what to kill based on the resource utilisation.

## Modes of operation

## Interactive mode

```sh
$ seal interactive --help
usage: seal interactive [-h] --kubeconfig KUBECONFIG
(--openstack | --aws | --no-cloud)
[--openstack-cloud-name OPENSTACK_CLOUD_NAME]
(-i INVENTORY_FILE | --inventory-kubernetes)
[--remote-user REMOTE_USER]
[--ssh-allow-missing-host-keys]
[--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]

optional arguments:
-h, --help show this help message and exit

Kubernetes settings:
--kubeconfig KUBECONFIG
Location of kube-config file

Cloud settings:
--openstack use OpenStack cloud provider
--aws use AWS cloud provider
--no-cloud don't use cloud provider
--openstack-cloud-name OPENSTACK_CLOUD_NAME
optional name of the open stack cloud from your config
file to use

Inventory settings:
-i INVENTORY_FILE, --inventory-file INVENTORY_FILE
the inventory file of groups of hosts to work with
--inventory-kubernetes
reads all kubernetes cluster nodes as inventory

SSH settings:
--remote-user REMOTE_USER
the of the user for the ssh connections
--ssh-allow-missing-host-keys
Allow connection to hosts not present in known_hosts
--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
Path to ssh private key
```



Here's a sneak peek of what you can do in the interactive mode:

![demo nodes](./media/video-nodes.gif)

![demo pods](./media/video-pods.gif)


## Autonomous mode

Autonomous reads the scenarios to execute from the policy file, and runs them:

1. The matches are combined together and deduplicated to produce an initial working set
2. They are run through a series of filters
3. For all the items remaining after the filters, all actions are executed

```sh
$ seal autonomous --help
usage: seal autonomous [-h] --kubeconfig KUBECONFIG
(--openstack | --aws | --no-cloud)
[--openstack-cloud-name OPENSTACK_CLOUD_NAME]
(-i INVENTORY_FILE | --inventory-kubernetes)
[--remote-user REMOTE_USER]
[--ssh-allow-missing-host-keys]
[--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
--policy-file POLICY_FILE
[--stdout-collector | --prometheus-collector]
[--prometheus-host PROMETHEUS_HOST]
[--prometheus-port PROMETHEUS_PORT] [--headless]
[--host HOST] [--port PORT]

optional arguments:
-h, --help show this help message and exit

Kubernetes settings:
--kubeconfig KUBECONFIG
Location of kube-config file

Cloud settings:
--openstack use OpenStack cloud provider
--aws use AWS cloud provider
--no-cloud don't use cloud provider
--openstack-cloud-name OPENSTACK_CLOUD_NAME
optional name of the open stack cloud from your config
file to use

Inventory settings:
-i INVENTORY_FILE, --inventory-file INVENTORY_FILE
the inventory file of groups of hosts to work with
--inventory-kubernetes
reads all kubernetes cluster nodes as inventory

SSH settings:
--remote-user REMOTE_USER
the of the user for the ssh connections
--ssh-allow-missing-host-keys
Allow connection to hosts not present in known_hosts
--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
Path to ssh private key

Policy settings:
--policy-file POLICY_FILE
the policy file to run

Metrics settings:
--stdout-collector print metrics collected to stdout
--prometheus-collector
store metrics in Prometheus and expose metrics over a
HTTP server

Prometheus settings:
--prometheus-host PROMETHEUS_HOST
Host to expose Prometheus metrics via the HTTP server
when using the --prometheus-collector flag
--prometheus-port PROMETHEUS_PORT
Port to expose Prometheus metrics via the HTTP server
when using the --prometheus-collector flag

Web UI settings:
--headless Doesn't start the UI, just runs the policy
--host HOST Specify host for the PowerfulSeal web server
--port PORT Specify port for the PowerfulSeal web server
```

### Metrics collection

Autonomous mode also comes with the ability for metrics useful for monitoring to be collected. PowerfulSeal currently has a `stdout` and Prometheus collector. However, metric collectors are easily extensible so it is easy to add your own. More details can be found [here](METRICS.md).

### Web User Interface

#### If you're not going to use the UI, use the flag `--headless` to disable it

PowerfulSeal comes with a web interface to help you navigate Autonomous Mode. Features include:

- starting/stopping autonomous mode
- viewing and filtering logs
- changing the configuration (either overwriting the remote policy file or copying the changes to clipboard)
- stopping/killing individual nodes and pods


![web interface](./media/web.png)

### Writing policies

A minimal policy file, doing nothing, looks like this:

```yaml
config:
minSecondsBetweenRuns: 77
maxSecondsBetweenRuns: 100

nodeScenarios: []

podScenarios: []
```

A more interesting schema, that kills a random pod in `default` namespace every 1-30 seconds:

```yaml
config:
minSecondsBetweenRuns: 1
maxSecondsBetweenRuns: 30

nodeScenarios: []
podScenarios:
- name: "delete random pods in default namespace"

match:
- namespace:
name: "default"

filters:
- randomSample:
size: 1

actions:
- kill:
probability: 0.77
force: true
```

A [full featured example](./tests/policy/example_config.yml) listing most of the available options can be found in the [tests](./tests/policy).

The schemas are validated against the [powerful JSON schema](./powerfulseal/policy/ps-schema.json).

## Label mode

Label mode is a more imperative alternative to autonomous mode, allowing you to specify which specific _per-pod_ whether a pod should be killed, the days/times it can be killed and the probability of it being killed.

To mark a pod for attack, do `kubectl label pods my-app-1 seal/enabled=true`, and the `Seal` will start attacking it, but only during working hours (defaults).

Instructions on how to use label mode can be found in [LABELS.md](LABELS.md).

```sh
$ seal label --help
usage: seal label [-h] --kubeconfig KUBECONFIG
(--openstack | --aws | --no-cloud)
[--openstack-cloud-name OPENSTACK_CLOUD_NAME]
(-i INVENTORY_FILE | --inventory-kubernetes)
[--remote-user REMOTE_USER] [--ssh-allow-missing-host-keys]
[--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
[--kubernetes-namespace KUBERNETES_NAMESPACE]
[--min-seconds-between-runs MIN_SECONDS_BETWEEN_RUNS]
[--max-seconds-between-runs MAX_SECONDS_BETWEEN_RUNS]
[--stdout-collector | --prometheus-collector]
[--prometheus-host PROMETHEUS_HOST]
[--prometheus-port PROMETHEUS_PORT]

optional arguments:
-h, --help show this help message and exit

Kubernetes settings:
--kubeconfig KUBECONFIG
Location of kube-config file

Cloud settings:
--openstack use OpenStack cloud provider
--aws use AWS cloud provider
--no-cloud don't use cloud provider
--openstack-cloud-name OPENSTACK_CLOUD_NAME
optional name of the open stack cloud from your config
file to use

Inventory settings:
-i INVENTORY_FILE, --inventory-file INVENTORY_FILE
the inventory file of groups of hosts to work with
--inventory-kubernetes
reads all kubernetes cluster nodes as inventory

SSH settings:
--remote-user REMOTE_USER
the of the user for the ssh connections
--ssh-allow-missing-host-keys
Allow connection to hosts not present in known_hosts
--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
Path to ssh private key

Kubernetes options:
--kubernetes-namespace KUBERNETES_NAMESPACE
Namespace to use for label and demo mode (set to blank
for all namespaces)

Policy settings:
--min-seconds-between-runs MIN_SECONDS_BETWEEN_RUNS
Minimum number of seconds between runs
--max-seconds-between-runs MAX_SECONDS_BETWEEN_RUNS
Maximum number of seconds between runs

Metrics settings:
--stdout-collector print metrics collected to stdout
--prometheus-collector
store metrics in Prometheus and expose metrics over a
HTTP server

Prometheus settings:
--prometheus-host PROMETHEUS_HOST
Host to expose Prometheus metrics via the HTTP server
when using the --prometheus-collector flag
--prometheus-port PROMETHEUS_PORT
Port to expose Prometheus metrics via the HTTP server
when using the --prometheus-collector flag
```


## Demo mode

The main way to use PowerfulSeal is to write a policy file for Autonomous mode which reflects realistic failures in your system. However, PowerfulSeal comes with a demo mode to demonstrate how it can cause chaos on your Kubernetes cluster. Demo mode gets all the pods in the cluster, selects those which are using the most resources, then kills them based on a probability.

Demo mode requires [Heapster](https://github.com/kubernetes/heapster). To run demo mode, use the `demo` subcommand along with `--heapster-path` (path to heapster without a trailing slash, e.g., `http://localhost:8001/api/v1/namespaces-kube-system/services/heapster/proxy`). You can also optionally specify `--aggressiveness` (from `1` (weakest) to `5` (strongest)) inclusive, as well as `--[min/max]-seconds-between-runs`.

```sh
$ seal demo --help
usage: seal demo [-h] --kubeconfig KUBECONFIG
(--openstack | --aws | --no-cloud)
[--openstack-cloud-name OPENSTACK_CLOUD_NAME]
(-i INVENTORY_FILE | --inventory-kubernetes)
[--remote-user REMOTE_USER] [--ssh-allow-missing-host-keys]
[--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY]
[--kubernetes-namespace KUBERNETES_NAMESPACE]
[--min-seconds-between-runs MIN_SECONDS_BETWEEN_RUNS]
[--max-seconds-between-runs MAX_SECONDS_BETWEEN_RUNS]
[--stdout-collector | --prometheus-collector]
[--prometheus-host PROMETHEUS_HOST]
[--prometheus-port PROMETHEUS_PORT] --heapster-path
HEAPSTER_PATH [--aggressiveness AGGRESSIVENESS]

optional arguments:
-h, --help show this help message and exit

Kubernetes settings:
--kubeconfig KUBECONFIG
Location of kube-config file

Cloud settings:
--openstack use OpenStack cloud provider
--aws use AWS cloud provider
--no-cloud don't use cloud provider
--openstack-cloud-name OPENSTACK_CLOUD_NAME
optional name of the open stack cloud from your config
file to use

Inventory settings:
-i INVENTORY_FILE, --inventory-file INVENTORY_FILE
the inventory file of groups of hosts to work with
--inventory-kubernetes
reads all kubernetes cluster nodes as inventory

SSH settings:
--remote-user REMOTE_USER
the of the user for the ssh connections
--ssh-allow-missing-host-keys
Allow connection to hosts not present in known_hosts
--ssh-path-to-private-key SSH_PATH_TO_PRIVATE_KEY
Path to ssh private key

Kubernetes options:
--kubernetes-namespace KUBERNETES_NAMESPACE
Namespace to use for label and demo mode (set to blank
for all namespaces)

Policy settings:
--min-seconds-between-runs MIN_SECONDS_BETWEEN_RUNS
Minimum number of seconds between runs
--max-seconds-between-runs MAX_SECONDS_BETWEEN_RUNS
Maximum number of seconds between runs

Metrics settings:
--stdout-collector print metrics collected to stdout
--prometheus-collector
store metrics in Prometheus and expose metrics over a
HTTP server

Prometheus settings:
--prometheus-host PROMETHEUS_HOST
Host to expose Prometheus metrics via the HTTP server
when using the --prometheus-collector flag
--prometheus-port PROMETHEUS_PORT
Port to expose Prometheus metrics via the HTTP server
when using the --prometheus-collector flag

Heapster settings:
--heapster-path HEAPSTER_PATH
Base path of Heapster without trailing slash
--aggressiveness AGGRESSIVENESS
Aggressiveness of demo mode (default: 3)
```


## Setup

Setup includes:
- pointing PowerfulSeal at your Kubernetes cluster by giving it a Kubernetes config file
- pointing PowerfulSeal at your cloud by specifying the cloud driver to use and providing credentials
- making sure that PowerfulSeal can SSH into the nodes to execute commands on them
- writing a set of policies

These interactions are available:

![pipeline](./media/setup.png)


### Minikube setup

It is possible to test a subset of Seal's functionality using a [`minikube`](https://kubernetes.io/docs/setup/minikube/) setup.

To achieve that, please inspect the [Makefile](./Makefile). You will need to override the ssh host, specify the correct username and use minikube's ssh keys.


If you'd like to test out the interactive mode, start with this:

```sh
seal \
-vv \
interactive \
--no-cloud \
--inventory-kubernetes \
--ssh-allow-missing-host-keys \
--remote-user docker \
--ssh-path-to-private-key `minikube ssh-key` \
--override-ssh-host `minikube ip`
```

For label mode, try something like this:

```sh
seal \
-vv \
label \
--no-cloud \
--min-seconds-between-runs 3 \
--max-seconds-between-runs 10 \
--inventory-kubernetes \
--ssh-allow-missing-host-keys \
--remote-user docker \
--ssh-path-to-private-key `minikube ssh-key` \
--override-ssh-host `minikube ip`
```

For autonomous mode, this should get you started:

```sh
seal \
-vv \
autonomous \
--no-cloud \
--policy-file ./examples/policy_kill_random_default.yml \
--inventory-kubernetes \
--prometheus-collector \
--prometheus-host 0.0.0.0 \
--prometheus-port 9999 \
--ssh-allow-missing-host-keys \
--remote-user docker \
--ssh-path-to-private-key `minikube ssh-key` \
--override-ssh-host `minikube ip` \
--host 0.0.0.0 \
--port 30100
```



## Getting started

`PowerfulSeal` is available to install through pip:

```sh
pip install powerfulseal
powerfulseal --help # or seal --help
```

To start the web interface, use flags `--server --server-host [HOST] --server-port [PORT]` when starting PowerfulSeal in autonomous mode and visit the web server at `http://HOST:PORT/`.

Both Python 2.7 and Python 3 are supported.

## Testing

PowerfulSeal uses [tox](https://github.com/tox-dev/tox) to test with multiple versions on Python. The recommended setup is to install and locally activate the Python versions under `tox.ini` with [pyenv](https://github.com/pyenv/pyenv).

Once the required Python versions are set up and can be discovered by tox (e.g., by having them discoverable in your PATH), you can run the tests by running `tox`.

For testing the web server and more details on testing, see [TESTING.md](TESTING.md).

## Read about the PowerfulSeal

- https://www.techatbloomberg.com/blog/powerfulseal-testing-tool-kubernetes-clusters/
- https://siliconangle.com/blog/2017/12/17/bloomberg-open-sources-powerfulseal-new-tool-testing-kubernetes-clusters/
- https://github.com/ramitsurana/awesome-kubernetes#testing
- https://github.com/ramitsurana/awesome-kubernetes#other-useful-videos
- https://github.com/dastergon/awesome-chaos-engineering#notable-tools
- https://www.linux.com/news/powerfulseal-testing-tool-kubernetes-clusters-0
- https://www.infoq.com/news/2018/01/powerfulseal-chaos-kubernetes

## FAQ

### Where can I learn more about Chaos Engineering ?

We found these two links to be a good start:

- http://principlesofchaos.org/
- https://github.com/dastergon/awesome-chaos-engineering

### How is it different from Chaos Monkey ?

PowerfulSeal was inspired by Chaos Monkey, but it differs in a couple of important ways.

The Seal does:
- speak Kubernetes
- offer flexible, easy to write YAML scenarios
- provide interactive mode with awesome tab-completion

The Seal doesn't:
- need external dependencies (db, Spinnaker), apart from SSH, cloud and Kubernetes API access
- need you to setup ```cron```

### Can I contribute to The Seal ?

We would love you to. In particular, it would be great to get help with:

- get more [cloud drivers](./powerfulseal/clouddrivers/driver.py) (currently `OpenStack` and `AWS`)
- get more [awesome filters](./powerfulseal/policy/scenario.py)
- <del>__get an amazing logo__</del>
- make the PowerfulSeal more powerful

Check out our [CONTRIBUTING.md](CONTRIBUTING.md) file for more information about how to contribute.

### Why a Seal ?

It might have been inspired by [this comic](https://randowis.com/2015/01/07/the-tower/).



## Footnotes

PowerfulSeal logo Copyright 2018 The Linux Foundation, and distributed under the Creative Commons Attribution (CC-BY-4.0) [license](https://creativecommons.org/licenses/by/4.0/legalcode).

Platform: UNKNOWN
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Test Tools
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3
Provides-Extra: testing

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
powerfulseal-2.0.1.tar.gz (1.7 MB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page