Skip to content

Commit

Permalink
Docs update in reference chapter url under init. (kube-burner#681)
Browse files Browse the repository at this point in the history
## Type of change

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

## Description

<!--- Describe your changes in detail -->
Kube-burner docs fix. under init reference chapter URL is not working.
https://kube-burner.github.io/kube-burner/latest/cli/#init

## Related Tickets & Documents

- Related Issue #
- Closes #

Signed-off-by: Supraja Manda <[email protected]>
  • Loading branch information
smandaRH authored Aug 16, 2024
1 parent 61a9590 commit 55afea6
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,8 +35,8 @@ Use "kube-burner [command] --help" for more information about a command.

This is the main subcommand; it triggers a new kube-burner benchmark and it supports the these flags:

- `uuid`: Benchmark ID. This is essentially an arbitrary string that is used for different purposes along the benchmark. For example, to label the objects created by kube-burner as mentioned in the [reference chapter](/kube-burner/configuration/#default-labels). By default, it is auto-generated.
- `config`: Path or URL to a valid configuration file. See details about the configuration schema in the [reference chapter](/kube-burner/configuration/).
- `uuid`: Benchmark ID. This is essentially an arbitrary string that is used for different purposes along the benchmark. For example, to label the objects created by kube-burner as mentioned in the [reference chapter](/docs/reference/configuration.md#default-labels). By default, it is auto-generated.
- `config`: Path or URL to a valid configuration file. See details about the configuration schema in the [reference chapter](/docs/observability/alerting.md#configuration).
- `log-level`: Logging level, one of: `debug`, `error`, `info` or `fatal`. Default `info`.
- `prometheus-url`: Prometheus endpoint, required for metrics collection. For example: `https://prometheus-k8s-openshift-monitoring.apps.rsevilla.stress.mycluster.example.com`
- `metrics-profile`: Path to a valid metrics profile file. The default is `metrics.yml`.
Expand Down Expand Up @@ -125,4 +125,4 @@ Or permanently imported with:
`kube-burner completion > /etc/bash_completion.d/kube-burner`

!!! note
the `bash-completion` utils must be installed for the kube-burner completion script to work.
the `bash-completion` utils must be installed for the kube-burner completion script to work.

0 comments on commit 55afea6

Please sign in to comment.