Skip to content

Commit

Permalink
Add more examples locations and clarify documentation
Browse files Browse the repository at this point in the history
Signed-off-by: Raul Sevilla <rsevilla@redhat.com>
  • Loading branch information
rsevilla87 committed Jun 15, 2021
1 parent 236a817 commit 8ac32b7
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 3 deletions.
2 changes: 1 addition & 1 deletion docs/cli.md
Expand Up @@ -29,7 +29,7 @@ Use "kube-burner [command] --help" for more information about a command.

This option is meant to run Kube-burner benchmark, and it supports the these flags:

- uuid: Benchmark ID. This is esentially an arbitrary string that is used for different purposes along the benchmark. For example, label the objects created by kube-burner as mentioned in the [configuration chapter](/configuration/#Default-labels). You can generate a new uuid in linux with the commands `uuidgen` or `cat /proc/sys/kernel/random/uuid`.
- uuid: Benchmark ID. This is esentially an arbitrary string that is used for different purposes along the benchmark. For example, label the objects created by kube-burner as mentioned in the [configuration chapter](configuration/#Default-labels). You can generate a new uuid in linux with the commands `uuidgen` or `cat /proc/sys/kernel/random/uuid`.
- config: Path or URL to a valid configuration file.
- log-level: Logging level. Default `info`
- prometheus-url: Prometheus full URL. i.e. `https://prometheus-k8s-openshift-monitoring.apps.rsevilla.stress.mycluster.example.com`
Expand Down
2 changes: 1 addition & 1 deletion docs/configuration.md
Expand Up @@ -49,7 +49,7 @@ This section contains the list of jobs `kube-burner` will execute. Each job can
| errorOnVerify | Exit with rc 1 before indexing when objects verification fails | Boolean | true | false |


A valid example of a configuration file can be found at [./examples/cfg.yml](https://github.com/cloud-bulldozer/kube-burner/blob/master/examples/cfg.yml)
A valid example of a configuration file can be found at the [examples](examples) folder.

## Objects

Expand Down
2 changes: 1 addition & 1 deletion docs/index.md
Expand Up @@ -22,4 +22,4 @@ In case you want to start tinkering with Kube-burner now:

- You can find the binaries in the [releases section of the repository](https://github.com/cloud-bulldozer/kube-burner/releases).
- There's also a container image available at [quay](https://quay.io/repository/cloud-bulldozer/kube-burner?tab=tags).
- A valid example of a configuration file can be found at [examples/cfg.yml](https://github.com/cloud-bulldozer/kube-burner/blob/master/examples/cfg.yml)
- Some valid examples of configuration files can be found in examples [examples](https://github.com/cloud-bulldozer/kube-burner/tree/master/examples) folder of the repository and in a personal [repository](https://github.com/rsevilla87/kube-burner-workloads) which holds several useful workloads.

0 comments on commit 8ac32b7

Please sign in to comment.