| Name | chaostoolkit-google-cloud-platform JSON |
| Version |
0.37.0
JSON |
| download |
| home_page | None |
| Summary | Google Cloud Platform extension for the Chaos Toolkit |
| upload_time | 2024-07-17 13:15:06 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8 |
| license | Apache-2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<h2 align="center">
<br>
<p align="center"><img src="https://avatars.githubusercontent.com/u/32068152?s=200&v=4"></p>
</h2>
<h4 align="center">Google Cloud Platform Extension for the Chaos Toolkit</h4>
<p align="center">
<a href="https://pypi.org/project/chaostoolkit-google-cloud-platform/">
<img alt="Release" src="https://img.shields.io/pypi/v/chaostoolkit-google-cloud-platform.svg">
<a href="#">
<img alt="Build" src="https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/actions/workflows/build.yaml/badge.svg">
<a href="https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/issues">
<img alt="GitHub issues" src="https://img.shields.io/github/issues/chaostoolkit-incubator/chaostoolkit-google-cloud-platform?style=flat-square&logo=github&logoColor=white">
<a href="https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/blob/master/LICENSE.md">
<img alt="License" src="https://img.shields.io/github/license/chaostoolkit-incubator/chaostoolkit-google-cloud-platform">
<a href="#">
<img alt="Python version" src="https://img.shields.io/pypi/pyversions/chaostoolkit-google-cloud-platform.svg">
<a href="https://pkg.go.dev/github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform">
</p>
<p align="center">
<a href="https://join.slack.com/t/chaostoolkit/shared_invite/zt-22c5isqi9-3YjYzucVTNFFVIG~Kzns8g">Community</a> •
<a href="https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/blob/master/CHANGELOG.md">ChangeLog</a>
</p>
---
Welcome to the Google Cloud Platform (GCP) extension for Chaos Toolkit. The
package aggregates activities to target your GCP projects and explore
your resilience via Chaos Engineering experiments.
## Install
This package requires Python 3.8+
To be used from your experiment, this package must be installed in the Python
environment where Chaos Toolkit already lives.
```
$ pip install -U chaostoolkit-google-cloud-platform
```
## Usage
To use the probes and actions from this package, add the following to your
experiment file:
```json
{
"version": "1.0.0",
"title": "Our users should not be impacted by increased latency from our services",
"description": "Use traffic shaping from the load Balancer to explore the impact of latency on our users",
"method": [
{
"name": "add-delay-to-traffic",
"type": "action",
"provider": {
"type": "python",
"module": "chaosgcp.lb.actions",
"func": "inject_traffic_delay",
"arguments": {
"url_map": "my-service",
"target_name": "all-paths",
"target_path": "/*",
"delay_in_seconds": 1,
"impacted_percentage": 80
}
},
"pauses": {
"after": 180
}
}
],
"rollbacks": [
{
"name": "remove-traffic-delay",
"type": "action",
"provider": {
"type": "python",
"module": "chaosgcp.lb.actions",
"func": "remove_fault_injection_traffic_policy",
"arguments": {
"url_map": "my-service",
"target_name": "all-paths",
"target_path": "/*"
}
}
}
]
}
```
That's it! You can now run it as `chaos run experiment.json`
Please explore the code to see existing probes and actions.
The extension picks up the credentials found on the machine running the
experiment as describe in the official
[Python GCP client](https://googleapis.dev/python/google-api-core/latest/auth.html).
## 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 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. You will need to install [PDM](https://pdm-project.org).
```console
$ pdm install --dev
```
Whenever you need to make contribution, ensure to run the linter as follows:
```console
$ pdm run format
$ pdm run lint
```
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:
```
$ pdm run test
```
Raw data
{
"_id": null,
"home_page": null,
"name": "chaostoolkit-google-cloud-platform",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Chaos Toolkit <contact@chaostoolkit.org>, Sylvain Hellegouarch <sh@defuze.org>",
"download_url": "https://files.pythonhosted.org/packages/fa/11/eb5c76632ba459e1b6cc5135817b61089f4855a9642889036385c6f7102c/chaostoolkit_google_cloud_platform-0.37.0.tar.gz",
"platform": null,
"description": "<h2 align=\"center\">\n <br>\n <p align=\"center\"><img src=\"https://avatars.githubusercontent.com/u/32068152?s=200&v=4\"></p>\n</h2>\n\n<h4 align=\"center\">Google Cloud Platform Extension for the Chaos Toolkit</h4>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/chaostoolkit-google-cloud-platform/\">\n <img alt=\"Release\" src=\"https://img.shields.io/pypi/v/chaostoolkit-google-cloud-platform.svg\">\n <a href=\"#\">\n <img alt=\"Build\" src=\"https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/actions/workflows/build.yaml/badge.svg\">\n <a href=\"https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/issues\">\n <img alt=\"GitHub issues\" src=\"https://img.shields.io/github/issues/chaostoolkit-incubator/chaostoolkit-google-cloud-platform?style=flat-square&logo=github&logoColor=white\">\n <a href=\"https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/blob/master/LICENSE.md\">\n <img alt=\"License\" src=\"https://img.shields.io/github/license/chaostoolkit-incubator/chaostoolkit-google-cloud-platform\">\n <a href=\"#\">\n <img alt=\"Python version\" src=\"https://img.shields.io/pypi/pyversions/chaostoolkit-google-cloud-platform.svg\">\n <a href=\"https://pkg.go.dev/github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform\">\n</p>\n\n<p align=\"center\">\n <a href=\"https://join.slack.com/t/chaostoolkit/shared_invite/zt-22c5isqi9-3YjYzucVTNFFVIG~Kzns8g\">Community</a> \u2022\n <a href=\"https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/blob/master/CHANGELOG.md\">ChangeLog</a>\n</p>\n\n---\n\nWelcome to the Google Cloud Platform (GCP) extension for Chaos Toolkit. The\npackage aggregates activities to target your GCP projects and explore\nyour resilience via Chaos Engineering experiments.\n\n## Install\n\nThis package requires Python 3.8+\n\nTo be used from your experiment, this package must be installed in the Python\nenvironment where Chaos Toolkit already lives.\n\n```\n$ pip install -U chaostoolkit-google-cloud-platform\n```\n\n## Usage\n\nTo use the probes and actions from this package, add the following to your\nexperiment file:\n\n```json\n{\n \"version\": \"1.0.0\",\n \"title\": \"Our users should not be impacted by increased latency from our services\",\n \"description\": \"Use traffic shaping from the load Balancer to explore the impact of latency on our users\",\n \"method\": [\n {\n \"name\": \"add-delay-to-traffic\",\n \"type\": \"action\",\n \"provider\": {\n \"type\": \"python\",\n \"module\": \"chaosgcp.lb.actions\",\n \"func\": \"inject_traffic_delay\",\n \"arguments\": {\n \"url_map\": \"my-service\",\n \"target_name\": \"all-paths\",\n \"target_path\": \"/*\",\n \"delay_in_seconds\": 1,\n \"impacted_percentage\": 80\n }\n },\n \"pauses\": {\n \"after\": 180\n }\n }\n ],\n \"rollbacks\": [\n {\n \"name\": \"remove-traffic-delay\",\n \"type\": \"action\",\n \"provider\": {\n \"type\": \"python\",\n \"module\": \"chaosgcp.lb.actions\",\n \"func\": \"remove_fault_injection_traffic_policy\",\n \"arguments\": {\n \"url_map\": \"my-service\",\n \"target_name\": \"all-paths\",\n \"target_path\": \"/*\"\n }\n }\n }\n ]\n}\n```\n\nThat's it! You can now run it as `chaos run experiment.json`\n\nPlease explore the code to see existing probes and actions.\n\nThe extension picks up the credentials found on the machine running the\nexperiment as describe in the official\n[Python GCP client](https://googleapis.dev/python/google-api-core/latest/auth.html).\n\n\n## Contribute\n\nIf you wish to contribute more functions to this package, you are more than\nwelcome to do so. Please, fork this project, make your changes following the\nusual [PEP 8][pep8] code style, sprinkling with tests and submit a PR for\nreview.\n\n[pep8]: https://pycodestyle.readthedocs.io/en/latest/\n\nThe Chaos Toolkit projects require all contributors must sign a\n[Developer Certificate of Origin][dco] on each commit they would like to merge\ninto the master branch of the repository. Please, make sure you can abide by\nthe rules of the DCO before submitting a PR.\n\n[dco]: https://github.com/probot/dco#how-it-works\n\n### Develop\n\nIf you wish to develop on this project, make sure to install the development\ndependencies. You will need to install [PDM](https://pdm-project.org).\n\n```console\n$ pdm install --dev\n```\n\nWhenever you need to make contribution, ensure to run the linter as follows:\n\n```console\n$ pdm run format\n$ pdm run lint\n```\n\nNow, you can edit the files and they will be automatically be seen by your\nenvironment, even when running from the `chaos` command locally.\n\n### Test\n\nTo run the tests for the project execute the following:\n\n```\n$ pdm run test\n```\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "Google Cloud Platform extension for the Chaos Toolkit",
"version": "0.37.0",
"project_urls": {
"Changelog": "https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform/blob/main/CHANGELOG.md",
"Documentation": "https://chaostoolkit.org/drivers/gcp/",
"Homepage": "https://chaostoolkit.org/",
"Repository": "https://github.com/chaostoolkit-incubator/chaostoolkit-google-cloud-platform"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bf5da4518bee9574efecdbe655ecc7f56333fb6b00f88320b465291a3e83cb6d",
"md5": "fb5cfa6906a66f42b92190480223eeb8",
"sha256": "882c4e0cc09036e0eac0cb27d9a9ec6c6719b7246392282a3a1ba3d7455b78a6"
},
"downloads": -1,
"filename": "chaostoolkit_google_cloud_platform-0.37.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fb5cfa6906a66f42b92190480223eeb8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 52313,
"upload_time": "2024-07-17T13:15:04",
"upload_time_iso_8601": "2024-07-17T13:15:04.651622Z",
"url": "https://files.pythonhosted.org/packages/bf/5d/a4518bee9574efecdbe655ecc7f56333fb6b00f88320b465291a3e83cb6d/chaostoolkit_google_cloud_platform-0.37.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "fa11eb5c76632ba459e1b6cc5135817b61089f4855a9642889036385c6f7102c",
"md5": "bf694fc8d3f0f413ac8ed7a65bf2dc17",
"sha256": "416fde8a51f6c1dd8d54ffeb01be58b71ead93eac89fd97c6eff4366cc3c7524"
},
"downloads": -1,
"filename": "chaostoolkit_google_cloud_platform-0.37.0.tar.gz",
"has_sig": false,
"md5_digest": "bf694fc8d3f0f413ac8ed7a65bf2dc17",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 46785,
"upload_time": "2024-07-17T13:15:06",
"upload_time_iso_8601": "2024-07-17T13:15:06.189840Z",
"url": "https://files.pythonhosted.org/packages/fa/11/eb5c76632ba459e1b6cc5135817b61089f4855a9642889036385c6f7102c/chaostoolkit_google_cloud_platform-0.37.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-17 13:15:06",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "chaostoolkit-incubator",
"github_project": "chaostoolkit-google-cloud-platform",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "chaostoolkit-google-cloud-platform"
}
