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