chore: add exec.kdl docs #803
Conversation
| `Exec.kdl` file has been provided in `./config/`. You can use it by copying | ||
| the file to the root directory of Hipcheck. Any changes saved to the relocated | ||
| `./Exec.kdl` will override the default Execution Configuration values, whether | ||
| the file is stored at `hipcheck/Exec.kdl` or `.hipcheck/Exec.kdl`. | ||
|
|
There was a problem hiding this comment.
This description isn't clear enough. Firstly, we should only be looking for ./hipcheck/Exec.kdl, not also hipcheck. This also doesn't address the recursive parent dir searching. Can reference https://doc.rust-lang.org/cargo/reference/config.html for inspiration
|
|
||
| As part of the Hipcheck plugin start-up process, there are specific values | ||
| that are hardcoded during the connection to the gRPC channel, such as the | ||
| `backoff-interval` to indicate a wait time between connections. However, | ||
| depending on system requirements, for example, these values may need to be | ||
| updated.The Execution Configuration file is a [KDL](https://kdl.dev/) language | ||
| configuration file that provides custom values for the plugin start-up process. | ||
|
|
||
| Here's what the default Execution Configuration file looks like: |
There was a problem hiding this comment.
The point of the Exec.kdl is to support any Hipcheck exec configuration, not just the plugin startup. That's all we have currently, but we may add other sections in the future. I would move most of this description to "## The plugin Section", and provide a more general explanation in this overview section
|
|
||
| The values in the Execution Configuration file are made available to | ||
| Hipcheck through three ways: | ||
|
|
There was a problem hiding this comment.
This section overview should state they are listed in order of priority, and reverse the order of the sections, so --exec is first.
| Hipcheck can run just fine without explicitly making changes to any of these | ||
| variables. The default values are hardcoded to be provided to the |
There was a problem hiding this comment.
--> "In the case that an "Exec.kdl" file was not resolved using the above methods, Hipcheck will use in-memory defaults for the values in this file.
aamohd
force-pushed
the
aamohd/exec-docs
branch
from
f7ce5d9 to
ba8ef59
Compare
Signed-off-by: Aisha M <[email protected]>
aamohd
force-pushed
the
aamohd/exec-docs
branch
from
ba8ef59 to
7d294ea
Compare
| During the Hipcheck plugin start-up process, certain values are hardcoded for | ||
| the gRPC channel connection. However, depending on system requirements, these |
There was a problem hiding this comment.
--> During the plugin start-up process, certain parameters are used for plugin initialization and gRPC connection establishment
| Execution Configuration file allows you to configure the Hipcheck execution | ||
| to support various needs, such as system requirements. The Execution |
There was a problem hiding this comment.
configure the Hipcheck execution to support various needs, such as system requirements --> configure parameters of Hipcheck's execution in the case that the defaults are inappropriate for your system or use-case.
| Execution Configuration file allows you to configure the Hipcheck execution | ||
| to support various needs, such as system requirements. The Execution | ||
| Configuration file is a [KDL](https://kdl.dev/) configuration file | ||
| that provides custom values required for Hipcheck's execution, including the |
There was a problem hiding this comment.
required by --> used during.
| | `max-spawn-attempts` | 3 | Maximum number of attempts to spawn a gRPC channel. | | ||
| | `max-conn-attempts` | 5 | Maximum number of attempts to make a plugin connection. | |
There was a problem hiding this comment.
max-spawn-attempts: Maximum number of attempts to spawn a plugin subprocess.
max-conn-attempts: Maximum number of attempts to establish a gRPC connection.
| to the root directory of Hipcheck. When Hipcheck runs, it will find the file | ||
| in `.hipcheck/Exec.kdl`. This search process starts in the current directory |
There was a problem hiding this comment.
It will first try Exec.kdl, then look for .hipcheck/Exec.kdl starting from the current directory and recursing upwards.
Resolves #734.