Add a configuration file reference #1137
Conversation
With this commit we add reference docs for Rally's configuration file `rally.ini`. We also move one configuration property from the `system` to the `reporting` section as it is more appropriate there. We intentionally placed this information on the existing configuration page instead of creating a new one. We did this to provide continuity in the future because we intend to remove the dedicated `configure` subcommand and instead rely on users editing the configuration file directly. When we remove this functionality, we can also remove obsolete sections from this page and move it to the reference documentation. Closes elastic#991
danielmitterdorfer
added
enhancement
|
but there was no reason why it had failed. Also, as this is a docs PR this failure is definitely unrelated so I'm retriggering a build. @elasticmachine test this please |
docs/configuration.rst
Outdated
|
|
||
| * ``remote.repo.url`` (default: "https://github.com/elastic/elasticsearch.git"): The URL from which to checkout Elasticsearch. | ||
| * ``elasticsearch.src.subdir`` (default: "elasticsearch"): The local path, relative to ``src.root.dir``, of the Elasticsearch source tree. | ||
| * ``cache`` (default: true): Enables Rally's internal source artifact cache. Artifacts are cached based on their git revision. |
There was a problem hiding this comment.
We could give one or two examples in parens about what are source artifacts.
e.g.:
Enables Rally's internal source artifact (i.e. elasticsearch*.tar.gz and optionally repository-*zip files).
and provide a link to https://esrally.readthedocs.io/en/stable/pipelines.html?highlight=pipelines#from-sources
There was a problem hiding this comment.
addressed in 415c198
docs/configuration.rst
Outdated
| Configuration File Reference | ||
| ---------------------------- | ||
|
|
||
| Rally stores its configuration in the file ``~/.rally/rally.ini``. It contains of the following sections. |
There was a problem hiding this comment.
s/It contains of the following sections./It comprises the following sections:
There was a problem hiding this comment.
addressed in 415c198
With this commit we add reference docs for Rally's configuration file
rally.ini. We also move one configuration property from thesystemto the
reportingsection as it is more appropriate there.We intentionally placed this information on the existing configuration
page instead of creating a new one. We did this to provide continuity in
the future because we intend to remove the dedicated
configuresubcommand and instead rely on users editing the configuration file
directly. When we remove this functionality, we can also remove obsolete
sections from this page and move it to the reference documentation.
Closes #991