add installation steps to readme (#155)
Signed-off-by: ksatchit <ksatchit@mayadata.io>
This commit is contained in:
committed by
GitHub
parent
2d0cdd07e8
commit
9531c82296
27
README.md
27
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 `<release_version>`, `<chart_name>` & `<namespace>`
|
||||
|
||||
```bash
|
||||
## downloads and unzips the released source
|
||||
tar -zxvf <(curl -sL https://github.com/litmuschaos/chaos-charts/archive/<release_version>.tar.gz)
|
||||
|
||||
## installs the chaosexperiment resources
|
||||
find chaos-charts-<release_version> -name experiments.yaml | grep <chart-name> | xargs kubectl apply -n <namespace> -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
|
||||
```
|
||||
|
Reference in New Issue
Block a user