Skip to main content
Join the official Python Developers Survey 2018 and win valuable prizes: Start the survey!

Chaos Toolkit Extension for Cloud Foundry

Project description

# Chaos Toolkit Cloud Foundry Extension

[![Build Status](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-cloud-foundry.svg?branch=master)](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-cloud-foundry)
[![Python versions](https://img.shields.io/pypi/pyversions/chaostoolkit-cloud-foundry.svg)](https://www.python.org/)
[![Requirements Status](https://requires.io/github/chaostoolkit-incubator/chaostoolkit-cloud-foundry/requirements.svg?branch=master)](https://requires.io/github/chaostoolkit-incubator/chaostoolkit-cloud-foundry/requirements/?branch=master)
[![Has wheel](https://img.shields.io/pypi/wheel/chaostoolkit-cloud-foundry.svg)](http://pythonwheels.com/)

This extension package provides probes and actions for Chaos Engineering
experiments against a Cloud Foundry instance using the
[Chaos Toolkit][chaostoolkit].

## Install

This package requires Python 3.5+

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 -U chaostoolkit-cloud-foundry
```

## Usage

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

```json
{
"type": "action",
"name": "terminate-random-instance",
"provider": {
"type": "python",
"module": "chaoscf.probes",
"func": "terminate_some_random_instance",
"arguments": {
"name": "my-app",
"org_name": "my-org",
"space_name": "my-space"
}
}
},
{
"type": "probe",
"name": "fetch-app-statistics",
"provider": {
"type": "python",
"module": "chaoscf.probes",
"func": "get_app_stats",
"arguments": {
"name": "my-app",
"org_name": "my-org",
"space_name": "my-space"
}
}
}
```

That's it!

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-cloud-foundry --no-install
```

If you have logged in against a Cloud Foundry environment, this will discover
information about it along the way.

## Configuration

This extension to the Chaos Toolkit need credentials to a Cloud Foundry account
with appropriate scopes. Please add the following sections to your experiment
file:

```json
{
"configuration": {
"cf_api_url": "https://api.local.pcfdev.io",
"cf_verify_ssl": false
},
"secrets": {
"cloudfoundry": {
"cf_username": "user",
"cf_password": "pass"
}
}
}
```

You may leave `"cf_verifiy_ssl"` out of the configuration when you want to
verify TLS certificates. Usually, local environments are self-signed so it
may be useful to disable that check in that case.

You may also specify the `"cf_client_id"` and `"cf_client_secret"` secrets
when you need. Their default values are `"cf"` and `""` respectively. These
work well against a local [PCF dev][pcfdev] install.

[pcfdev]: https://pivotal.io/pcf-dev

Then in your probe or action:

```json
{
"type": "probe",
"name": "fetch-app-statistics",
"provider": {
"type": "python",
"secrets": ["cloudfoundry"],
"module": "chaoscf.probes",
"func": "get_app_stats",
"arguments": {
"name": "my-app",
"org_name": "my-org",
"space_name": "my-space"
}
}
}
```


## Test

To run the tests for the project execute the following:

```
$ pip install -r requirements-dev.txt
$ pytest
```

## 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/

The Chaos Toolkit project requires 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


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
chaostoolkit_cloud_foundry-0.6.0-py3-none-any.whl (11.9 kB) Copy SHA256 hash SHA256 Wheel py3 Aug 10, 2018
chaostoolkit-cloud-foundry-0.6.0.tar.gz (13.5 kB) Copy SHA256 hash SHA256 Source None Aug 10, 2018

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