Skip to content

Commit

Permalink
Updating README.md for churn usage (kube-burner#610)
Browse files Browse the repository at this point in the history
## Type of change

- [ ] Refactor
- [ ] New feature
- [ ] Bug fix
- [ ] Optimization
- [x] Documentation Update

## Description

As a result of this slack
[thread](https://redhat-internal.slack.com/archives/C05CDC19ZKJ/p1710510088455179),
updating README.md for churn usage.

Signed-off-by: Vishnu Challa <[email protected]>
Co-authored-by: Vishnu Challa <[email protected]>
  • Loading branch information
vishnuchalla and Vishnu Challa authored Mar 19, 2024
1 parent 87e77cb commit 20073fa
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,9 @@ This section contains the list of jobs `kube-burner` will execute. Each job can
| `churnDelay` | Length of time to wait between each churn period | Duration | 5m |
| `churnDeletionStrategy` | Churn deletion strategy to apply, "default" or "gvr" (where `default` churns namespaces and `gvr` churns objects within namespaces) | String | default |

!!! note
Both `churnCycles` and `churnDuration` serve as termination conditions, with the churn process halting when either condition is met first. If someone wishes to exclusively utilize `churnDuration` to control churn, they can achieve this by setting `churnCycles` to `0`. Conversely, to prioritize `churnCycles`, one should set a longer `churnDuration` accordingly.

Our configuration files strictly follow YAML syntax. To clarify on List and Object types usage, they are nothing but the [`Lists and Dictionaries`](https://gettaurus.org/docs/YAMLTutorial/#Lists-and-Dictionaries) in YAML syntax.

Examples of valid configuration files can be found in the [examples folder](https://github.com/kube-burner/kube-burner/tree/master/examples).
Expand Down

0 comments on commit 20073fa

Please sign in to comment.