Skip to content

Commit

Permalink
Docs reorg
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 8ac32b7 commit 783ee20
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions docs/configuration.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
# Configuration

All the magic `kube-burner` does is described in the configuration file. As previously mentioned the location of this configuration file is provided by the flag `-c`. This file is written in YAML format and consists of several sections.
It's possible to use `go-template` syntax within this configuration file, also it's important to note that every environment variable is passed to this template, so we can reference them using the syntax `{{ .MY_ENV_VAR}}`. For example, we could define the indexerConfig section of our configuration file like:
Expand Down Expand Up @@ -49,7 +50,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 the [examples](examples) folder.
A valid example of a configuration file can be found at the [examples](https://github.com/cloud-bulldozer/kube-burner/tree/master/examples) folder.

## Objects

Expand All @@ -64,7 +65,7 @@ Each object element supports the following parameters:



## Default labels
### Default labels

All objects created by kube-burner are labeled with. `kube-burner-uuid=<UUID>,kube-burner-job=<jobName>,kube-burner-index=<objectIndex>`, these labels are appended to the actual object labels described at the template. They are used for internal purposes but they can also be used by the users.

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@ docs_dir: docs/
repo_url: https://github.com/cloud-bulldozer/kube-burner
nav:
- Home: index.md
- Configuration:
- From scratch:
- CLI: cli.md
- General: configuration.md
- Configuration: configuration.md
- Measurements: measurements.md
- Metrics: metrics.md
- Indexers: indexers.md
Expand Down

0 comments on commit 783ee20

Please sign in to comment.