Skip to content

Commit

Permalink
[ClusterLoader2] Add information about environment variables to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
jprzychodzen committed Jan 29, 2020
1 parent f9d7968 commit 147f3f3
Showing 1 changed file with 19 additions and 0 deletions.
19 changes: 19 additions & 0 deletions clusterloader2/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,25 @@ each reference has to be opaqued with ```DefaultParam``` function that will
handle case if given variable doesn't exist. \
Example of overrides can be found here: [overrides]

#### Passing environment variables

Instead of using overrides in file, it is possible to depend on environment
variables. Only variables that start with `CL2_` prefix will be parsed and
available in script.

Environment variables can be used with `DefaultParam` function to provide sane
default values.

##### Setting variables in shell
```shell
export CL2_ACCESS_TOKENS_QPS=5
```

##### Usage from test definition
```yaml
{{$qpsPerToken := DefaultParam .CL2_ACCESS_TOKENS_QPS 0.1}}
```

## Measurement

Currently available measurements are:
Expand Down

0 comments on commit 147f3f3

Please sign in to comment.