Docs feedback: "GitLab Runner – Advanced configuration" is missing information on mandatory or default parameter values
Problem to solve
Currently, the documentation page GitLab Runner – Advanced Configuration doesn't provide information about whether a parameter is mandatory or – if not – what its default value is.
Example
Setting | Description |
---|---|
concurrent | Limits how many jobs can run concurrently, across all registered runners. Each [[runners]] section can define its own limit, but this value sets a maximum for all of those values combined. For example, a value of 10 means no more than 10 jobs can run concurrently. 0 is forbidden. If you use this value, the runner process exits with a critical error. View how this setting works with the Docker Machine executor (for autoscaling). |
log_level | Defines the log level. Options are debug , info , warn , error , fatal , and panic . This setting has lower priority than the level set by the command-line arguments --debug , -l , or --log-level . |
Proposal
I suggest to add two additional columns to each parameter description:
- a Boolean "
Mandatory
" column - a textual "
Default Value
" column
Example
Setting | Description | Mandatory | Default Value |
---|---|---|---|
concurrent | Limits how many jobs can run concurrently, across all registered runners. Each [[runners]] section can define its own limit, but this value sets a maximum for all of those values combined. For example, a value of 10 means no more than 10 jobs can run concurrently. 0 is forbidden. If you use this value, the runner process exits with a critical error. View how this setting works with the Docker Machine executor (for autoscaling). |
☒ | |
log_level | Defines the log level. Options are debug , info , warn , error , fatal , and panic . This setting has lower priority than the level set by the command-line arguments --debug , -l , or --log-level . |
☐ | warn |
Other links/references
https://docs.gitlab.com/runner/configuration/advanced-configuration.html
Edited by A. D.