Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/chaostoolkit-incubator/chaostoolkit-cloud-foundry
Cloud Foundry extension for the Chaos Toolkit
https://github.com/chaostoolkit-incubator/chaostoolkit-cloud-foundry
chaos-engineering chaostoolkit-extension cloudfoundry pcf
Last synced: 22 days ago
JSON representation
Cloud Foundry extension for the Chaos Toolkit
- Host: GitHub
- URL: https://github.com/chaostoolkit-incubator/chaostoolkit-cloud-foundry
- Owner: chaostoolkit-incubator
- License: apache-2.0
- Created: 2018-01-08T11:34:45.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-27T08:03:34.000Z (almost 2 years ago)
- Last Synced: 2024-07-30T17:32:48.802Z (5 months ago)
- Topics: chaos-engineering, chaostoolkit-extension, cloudfoundry, pcf
- Language: Python
- Homepage: https://chaostoolkit.org/
- Size: 73.2 KB
- Stars: 6
- Watchers: 5
- Forks: 7
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Chaos Toolkit Cloud Foundry Extension
[](https://travis-ci.org/chaostoolkit-incubator/chaostoolkit-cloud-foundry)
[](https://www.python.org/)
[](https://requires.io/github/chaostoolkit-incubator/chaostoolkit-cloud-foundry/requirements/?branch=master)
[](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.7+
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:
```
$ python setup.py test
```