diff --git a/README.md b/README.md index f969060..3e3bfd6 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,8 @@ # The Chaos Toolkit Community Playground -The goal of this project is to creat a collection of sample applications and accompanying setups and sample experiments to demonstrate how to use the Chaos Toolkit to surface evidence of system weaknesses as well as then usew those same experiments to form the basis of a Continuous Chaos environment where the experiments have graduated into becoming chaos tests. +The goal of this project is to creat a collection of sample applications and accompanying setups and sample experiments to demonstrate how to use the Chaos Toolkit to surface evidence of system weaknesses as well as then use those same experiments to form the basis of a Continuous Chaos environment where the experiments have graduated into becoming chaos tests. -This project exists to provide a place where the Chaos Toolkit community can share their experiments and collectively show how we can all collaborate on choas engineering while targetting a selection of samples that are likely to grow in complexity over time. Rather than lock a collection of samples and experiments away in different repos, this project will be wholly owned and evolved by the community to showcase real-world experiments against sample applications that we'll also try to make as real as possible. +This project exists to provide a place where the Chaos Toolkit community can share their experiments and collectively show how we can all collaborate on chaos engineering while targetting a selection of samples that are likely to grow in complexity over time. Rather than lock a collection of samples and experiments away in different repos, this project will be wholly owned and evolved by the community to showcase real-world experiments against sample applications that we'll also try to make as real as possible. ## Get Involved! @@ -12,7 +12,7 @@ If you'd prefer not to use Slack then please consider raising GitHub issues on t ## Relationship to Learning Chaos Engineering -The book ["Learning Chaos Engineering"](http://shop.oreilly.com/product/0636920251897.do) by Russ Miles and publicshed by O'Reilly Media also draws upon the samples in this repository, although the code here will likely continue to be evolved by the community beyond the publication of the book. +The book ["Learning Chaos Engineering"](http://shop.oreilly.com/product/0636920251897.do) by Russ Miles and published by O'Reilly Media also draws upon the samples in this repository, although the code here will likely continue to be evolved by the community beyond the publication of the book. ## Sample Application Index diff --git a/from-local-to-automated-chaostoolkit/README.md b/from-local-to-automated-chaostoolkit/README.md index 26ee912..7603311 100644 --- a/from-local-to-automated-chaostoolkit/README.md +++ b/from-local-to-automated-chaostoolkit/README.md @@ -27,7 +27,7 @@ payload: } ``` -The `count` value is an integer that is incremented by the service everytime +The `count` value is an integer that is incremented by the service every time you call the endpoint. Initially, the service, called `service1`, generates the value on its own. @@ -63,10 +63,10 @@ Both services expose as well: We use Kubernetes to manage our application's lifecycle. Both have their own deployment strategies. -When a new version is rolled out, Kubernetes waits up a certain amount of +When a new version is rolled out, Kubernetes waits up to a certain amount of time before accepting that the new version is allowed to take trafic in. -This allows us to reduce the impact on our users shoudld a new version breaks +This allows us to reduce the impact on our users should a new version break on deployment. This demo is going to focus on scenarios around rollouts essentially. @@ -79,7 +79,7 @@ environments yet. So please report any issue you might encounter. ### Create a Kubernetes cluster You obviously need to start with running a Kubernetes cluster. It does not -have to very powerful as we will run a minimal set of pods in there. Our +have to be very powerful as we will run a minimal set of pods in there. Our applications have resource limits which are fairly low. The demo has been tested on Ubuntu 19.04 against a local Kubernetes cluster @@ -98,7 +98,7 @@ cluster from your local machine. ### Install system dependencies -This demo is concerned about showing you how Chaos Toolkit can integrates +This demo is concerned about showing you how Chaos Toolkit can integrate smoothly with your existing tooling (observability, CI/CD...). For the purpose of the demo, please install Jaeger and Prometheus in your cluster: @@ -123,7 +123,7 @@ export PROMETHEUS_URL="http://$(kubectl -n monitoring get svc prometheus-k8s -o= ``` In addition, the demo may send logs to a central logging service, such as -[Humio][]. Please set these two variables: +[Humio](https://www.humio.com/). Please set these two variables: ``` export HUMIO_INGEST_TOKEN= @@ -141,7 +141,7 @@ your `/etc/hosts` file. 127.0.0.1 counter.dev ``` -Then add export the following variable: +Then export the following variable: ``` export COUNTER_URL=http://counter.dev/ diff --git a/google-cloud-function/main.py b/google-cloud-function/main.py index 6aa37b0..1b2290a 100644 --- a/google-cloud-function/main.py +++ b/google-cloud-function/main.py @@ -12,7 +12,7 @@

This is a google cloud function that can be used for safeguards with ChaosIQ

-

Please add parameters giving lowerand upper bounds:

+

Please add parameters giving lower and upper bounds:

hours in range link """ @@ -22,11 +22,11 @@ def hour_is_in_range(lower, upper): """returns a boolean indicating if the current hour is within bounds Parameters: - lower (int): lowerbound of range + lower (int): lower bound of range upper (int): upper bound of range Returns: - bool:True if the current our is between lower and upper, otherwise false + bool:True if the current hour is between lower and upper, otherwise false """ print(f'hourInRange with lower: {lower} and upper: {upper}') diff --git a/interactive-controls/README.md b/interactive-controls/README.md index a4f609e..db7ad1c 100644 --- a/interactive-controls/README.md +++ b/interactive-controls/README.md @@ -1,3 +1,3 @@ # Chaos Engineering with Users in the Loop Code -This playground contains the code to support the [Chaos Engineering with Users in the Loop Code article. +This playground contains the code to support the [Chaos Engineering with Users in the Loop](https://medium.com/chaos-toolkit/chaos-engineering-with-humans-in-the-loop-f4854900b1eb) Code article. diff --git a/interactive-controls/sources/simple/README.md b/interactive-controls/sources/simple/README.md index 3c1d28e..563f322 100644 --- a/interactive-controls/sources/simple/README.md +++ b/interactive-controls/sources/simple/README.md @@ -22,7 +22,7 @@ Then, point your environment to this directory: $ python setup.py develop ``` -Now, you can edit the files and they will be automatically be seen by your +Now, you can edit the files and they will automatically be seen by your environment, even when running from the `chaos` command locally. ### Test @@ -31,4 +31,4 @@ To run the tests for the project execute the following: ``` $ python setup.py test -``` \ No newline at end of file +``` diff --git a/interactive-controls/sources/yesorno/README.md b/interactive-controls/sources/yesorno/README.md index 6e07f8e..b132517 100644 --- a/interactive-controls/sources/yesorno/README.md +++ b/interactive-controls/sources/yesorno/README.md @@ -22,7 +22,7 @@ Then, point your environment to this directory: $ python setup.py develop ``` -Now, you can edit the files and they will be automatically be seen by your +Now, you can edit the files and they will automatically be seen by your environment, even when running from the `chaos` command locally. ### Test @@ -31,4 +31,4 @@ To run the tests for the project execute the following: ```bash $ python setup.py test -``` \ No newline at end of file +``` diff --git a/interactive-controls/sources/yesorno/chaosyorn/control.py b/interactive-controls/sources/yesorno/chaosyorn/control.py index cfef7b9..0c6d647 100644 --- a/interactive-controls/sources/yesorno/chaosyorn/control.py +++ b/interactive-controls/sources/yesorno/chaosyorn/control.py @@ -12,7 +12,7 @@ def before_activity_control(context: Activity, **kwargs): """ - Prompt for Yes or No to executing an activity. + Prompt for Yes or No to execute an activity. """ logger.info("About to execute activity: " + context.get("name")) if click.confirm('Do you want to continue?'): diff --git a/superpower/README.md b/superpower/README.md index 87aa7da..f2226c3 100644 --- a/superpower/README.md +++ b/superpower/README.md @@ -25,7 +25,7 @@ and the talk [here](https://skillsmatter.com/skillscasts/12908-distributed-syste Our application makes two promises to users: -* each time you come back to it, you will get the same superpower (you can turn from hero to vilain suddenly) +* each time you come back to it, you will get the same superpower (you can turn from hero to villain suddenly) * the latency to receive your superpower should be under a second Our experiments will keep those promises in mind to understand how failures @@ -66,7 +66,7 @@ Be aware, this will take a few minutes to complete so go grab a coffee :) ## Deploying the application -You can deploy and run the application using one of the followings: +You can deploy and run the application using one of the following: * [Local](https://github.com/chaosiq/superpower-demo/blob/master/docs/local.md): Run natively on your local machine * [Kubernetes (minikube)](https://github.com/chaosiq/superpower-demo/blob/master/docs/minikube.md): Run in Kubernetes in a VM on your local machine @@ -94,7 +94,7 @@ Before you run them, please source the following script: $ . scripts/prepare-experiments-env.sh ``` -Note that this is indeed source this script, not running it. +Note that this is indeed just sourcing this script, not running it. You should also install [vegeta][]. diff --git a/yummynoodle/flask-menu-service/README.md b/yummynoodle/flask-menu-service/README.md index 44fdee3..d45219e 100644 --- a/yummynoodle/flask-menu-service/README.md +++ b/yummynoodle/flask-menu-service/README.md @@ -2,7 +2,7 @@ This is a first version of the menu service in Python Flask, it is currently using static data but it will evolve to use some form of document -database probsbly firebase. +database probably firebase. To run locally run