diff --git a/README.md b/README.md index 04493ca..da40ad3 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,30 @@ # Chaos-Charts This repository hosts the Litmus Chaos Charts. +## Installation Steps for Chart Releases + +*Note: Supported from release 1.1.0* + +- To install the chaos experiments from a specific chart for a given release, execute the following commands +with the desired ``, `` & `` + +```bash +## downloads and unzips the released source +tar -zxvf <(curl -sL https://github.com/litmuschaos/chaos-charts/archive/.tar.gz) + +## installs the chaosexperiment resources +find chaos-charts- -name experiments.yaml | grep | xargs kubectl apply -n -f +``` +- For example, to install the *generic* experiment chart bundle for release *1.1.0*, in the *sock-shop* namespace, run: + +```bash +tar -zxvf <(curl -sL https://github.com/litmuschaos/chaos-charts/archive/1.1.0.tar.gz) +find chaos-charts-1.1.0 -name experiments.yaml | grep generic | xargs kubectl apply -n sock-shop -f +``` + +- If you would like to install a specific experiment, replace the `experiments.yaml` in the above command with the relative +path of the experiment manifest within the parent chart. For example, to install only the *pod-delete* experiment, run: + +```bash +find chaos-charts-1.1.0 -name experiment.yaml | grep 'generic/pod-delete' | xargs kubectl apply -n sock-shop -f +```