Added docs

Razz4780 · Nov 20, 2024 · fef5ade · fef5ade
1 parent 8faab73
commit fef5ade
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/mirrord-schema.json b/mirrord-schema.json
@@ -703,7 +703,8 @@
       "type": "object",
       "properties": {
         "env_file": {
-          "description": "TODO doc",
+          "title": "feature.env_file {#feature-env-file}",
+          "description": "Allows for passing environment variables from an env file.\n\nThese variables will override environment fetched from the remote target.",
           "type": [
             "string",
             "null"
@@ -743,7 +744,7 @@
         },
         "override": {
           "title": "feature.env.override {#feature-env-override}",
-          "description": "Allows setting or overriding environment variables (locally) with a custom value.\n\nFor example, if the remote pod has an environment variable `REGION=1`, but this is an undesirable value, it's possible to use `override` to set `REGION=2` (locally) instead.",
+          "description": "Allows setting or overriding environment variables (locally) with a custom value.\n\nFor example, if the remote pod has an environment variable `REGION=1`, but this is an undesirable value, it's possible to use `override` to set `REGION=2` (locally) instead.\n\nEnvironment specified here will also override variables passed via the env file.",
           "type": [
             "object",
             "null"

diff --git a/mirrord/cli/src/config.rs b/mirrord/cli/src/config.rs
@@ -207,7 +207,7 @@ pub(super) struct ExecParams {
     #[arg(long)]
     pub context: Option<String>,
 
-    /// TODO doc
+    /// Path to env file that should be used for the execution.
     #[arg(long, value_hint = ValueHint::FilePath)]
     pub env_file: Option<PathBuf>,
 }

diff --git a/mirrord/config/configuration.md b/mirrord/config/configuration.md
@@ -649,7 +649,11 @@ See the environment variables [reference](https://mirrord.dev/docs/reference/env
 }
 ```
 
-TODO doc
+### feature.env_file {#feature-env-file}
+
+Allows for passing environment variables from an env file.
+
+These variables will override environment fetched from the remote target.
 
 ### feature.env.exclude {#feature-env-exclude}
 
@@ -689,6 +693,8 @@ Allows setting or overriding environment variables (locally) with a custom value
 For example, if the remote pod has an environment variable `REGION=1`, but this is an
 undesirable value, it's possible to use `override` to set `REGION=2` (locally) instead.
 
+Environment specified here will also override variables passed via the env file.
+
 ### feature.env.unset {#feature-env-unset}
 
 Allows unsetting environment variables in the executed process.

diff --git a/mirrord/config/src/feature/env.rs b/mirrord/config/src/feature/env.rs
@@ -73,6 +73,8 @@ pub struct EnvConfig {
     ///
     /// For example, if the remote pod has an environment variable `REGION=1`, but this is an
     /// undesirable value, it's possible to use `override` to set `REGION=2` (locally) instead.
+    ///
+    /// Environment specified here will also override variables passed via the env file.
     pub r#override: Option<HashMap<String, String>>, // `r#`: `override` is a Rust keyword.
 
     /// ### feature.env.load_from_process {#feature-env-load_from_process}
@@ -96,7 +98,11 @@ pub struct EnvConfig {
     /// and `Aws_Profile` and other variations.
     pub unset: Option<VecOrSingle<String>>,
 
-    /// TODO doc
+    /// ### feature.env_file {#feature-env-file}
+    ///
+    /// Allows for passing environment variables from an env file.
+    ///
+    /// These variables will override environment fetched from the remote target.
     #[config(env = MIRRORD_OVERRIDE_ENV_FILE_ENV)]
     pub env_file: Option<PathBuf>,
 }