Skip to content

Commit

Permalink
chore: update experiment docs (#4641)
Browse files Browse the repository at this point in the history
* chore: update docs

Signed-off-by: namkyu1999 <[email protected]>

* fix: update link

Signed-off-by: namkyu1999 <[email protected]>

---------

Signed-off-by: namkyu1999 <[email protected]>
  • Loading branch information
namkyu1999 committed Jun 7, 2024
1 parent 719d783 commit 92dc14c
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions mkdocs/docs/experiments/categories/load/k6-loadgen.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,11 @@ Support [various types](https://grafana.com/docs/k6/latest/testing-guides/test-t
!!! tip "Scenario: Load generating with k6"
![k6-loadgen](../../images/k6-loadgen.png)

## Uses

??? info "View the uses of the experiment"
[Introduction to k6 Load Chaos in LitmusChaos](https://dev.to/litmus-chaos/introduction-to-k6-load-chaos-in-litmuschaos-4l2k)

## Prerequisites

??? info "Verify the prerequisites"
Expand All @@ -16,7 +21,7 @@ Support [various types](https://grafana.com/docs/k6/latest/testing-guides/test-t
- Ensure to create a Kubernetes secret having the JS script file in the `Chaos Infrastructure`'s namespace (`litmus` by default). The simplest way to create a secret object looks like this:
```bash
kubectl create secret generic k6-script \
--from-file=script.js=<<script-path>> -n <<chaos_infrastructure_namespace>>
--from-file=<<script-path>> -n <<chaos_infrastructure_namespace>>
```

## Minimal RBAC configuration example (optional)
Expand Down Expand Up @@ -148,7 +153,7 @@ Then create a secret with the above script.

```bash
kubectl create secret generic custom-k6-script \
--from-file=script.js=custom-script.js -n <<chaos_infrastructure_namespace>>
--from-file=custom-script.js -n <<chaos_infrastructure_namespace>>
```
And If we want to use `custom-k6-script` secret and `custom-script.js` as the secret key, then the experiment tunable will look like this:
Expand Down

0 comments on commit 92dc14c

Please sign in to comment.