search

open-chaos / experiment-catalog

A public and open source chaos engineering experiment catalog.
Apache License 2.0
55 stars 11 forks source link

Add validation sections to experiments #82

Closed russmiles closed 4 years ago

russmiles commented 4 years ago

I suggest we add chaos validate instructions alongside chaos run for each of the experiments, to aid in their further development. Sections such as:

Developing this experiment further

Validating the experiment from the catalog using HTTP

(chaostk) $ export APPLICATION_ENTRYPOINT_URL=http://192.168.99.100:32474; \
            export SERVICE_NAME=my-service; \
                   chaos validate https://raw.githubusercontent.com/open-chaos/experiment-catalog/master/kubernetes/kill_microservice/kill_microservice.json

Wdyt @gtfisher

This will be reliant on this PR being in a release of the chaos toolkit first: https://github.com/chaostoolkit/chaostoolkit/pull/130

russmiles commented 4 years ago

Intro to section something like:

Developing this experiment further

If you'd like to develop this experiment it's useful to be able to validate the experiment to ensure you have all the required variables being specified. the chaos validate command from the Chaos Toolkit is ideal for this purpose.

russmiles commented 4 years ago

I've now added this as an advisory note to the top level README. Closing this issue for now.