chore: add exec.kdl docs

Signed-off-by: Aisha M <[email protected]>

site/content/docs/guide/cli/general-flags.md

@@ -49,7 +49,7 @@ data, and caching repositories locally. The current flags are:
   use.
 - `-d <DATA>`/`--data <DATA>`: the path to the data folder to use.
 - `-C <CACHE>`/`--cache <CACHE>`: the path to the cache folder to use.
-- `-e <EXEC>`/`--exec <EXEC>`: the path to the execution config file.
+- `-e <EXEC>`/`--exec <EXEC>`: the path to the execution configuration file.
 
 Each of these is inferred by default based on the user's platform. They can
 also be set with environment variables:

site/content/docs/guide/config/exec-file.md

@@ -0,0 +1,67 @@
+---
+title: Execution Configuration
+weight: 1
+---
+
+# Execution Configuration Files
+
+As part of Hipcheck's goal to make Hipcheck flexible for all users, the 
+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
+plugin start-up process.
+
+Here's what the default Execution Configuration file looks like:
+
+```
+plugin {
+    backoff-interval 100000
+    max-spawn-attempts 3
+    max-conn-attempts 5
+    jitter-percent 10
+    grpc-msg-buffer-size 10
+}
+```
+
+## The `plugin` Section
+
+During the Hipcheck plugin start-up process, certain values are hardcoded for
+the gRPC channel connection. However, depending on system requirements, these
+values may need to be adjusted. The `plugin` section contains the variables 
+required for the `PluginExecutor` module to make the gRPC connection. The configurable 
+variables are as follows:
+
+| Variable              | Default    | Description      |
+| :-------------------- | :---------:| :--------------- |
+| `backoff-interval`    | 100000     | (Microseconds) System wait time between connection attempts. |
+| `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. |
+| `jitter-percent`      | 10         | Percentage used with the `backoff-interval` and `max-conn-attempts` to calculate the sleep duration between connection attempts|
+| `grpc-msg-buffer-size` | 10        | The size of the gRPC buffer |
+
+## How It Works
+
+The values in the Execution Configuration file are made available to Hipcheck
+in three ways, listed in order of priority:
+
+### Execution Configuration through CLI
+
+To provide a custom Execution Configuration file for your Hipcheck execution,
+there's a sample `Exec.kdl` file in `./config/`. You can use it by copying the 
+file to your desired location, making and saving your changes while maintaining
+KDL format. Use the optional CLI flag `-e <EXEC>`/`--exec <EXEC>` to specify the
+file path for your Execution Configuration file.
+
+### Exec.kdl in Hipcheck Binary
+
+Alternatively, you can copy your custom Execution Configuration file
+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
+and recursively all parent directories to the user's home directory, similar to
+[Cargo's configuration system](https://doc.rust-lang.org/cargo/reference/config.html).
+
+### Default
+
+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.