fix json snippets in config docs (#2509)

metalbear-co · Jun 12, 2024 · 4d2e6b8 · 4d2e6b8
1 parent 45fdeb9
commit 4d2e6b8
Show file tree

Hide file tree

Showing 12 changed files with 64 additions and 59 deletions.
diff --git a/changelog.d/+fix-json-in-docs.fixed.md b/changelog.d/+fix-json-in-docs.fixed.md
@@ -0,0 +1 @@
+Fix json snippets in configuration docs by escaping backslashes and removing trailing commas.
diff --git a/mirrord-schema.json b/mirrord-schema.json
diff --git a/mirrord/config/configuration.md b/mirrord/config/configuration.md
@@ -81,15 +81,15 @@ configuration file containing all fields.
     },
     "fs": {
       "mode": "write",
-      "read_write": ".+\.json" ,
-      "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-      "local": [ ".+\.js", ".+\.mjs" ]
+      "read_write": ".+\\.json" ,
+      "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+      "local": [ ".+\\.js", ".+\\.mjs" ]
     },
     "network": {
       "incoming": {
         "mode": "steal",
         "http_filter": {
-          "header_filter": "host: api\..+"
+          "header_filter": "host: api\\..+"
         },
         "port_mapping": [[ 7777, 8888 ]],
         "ignore_localhost": false,
@@ -108,7 +108,7 @@ configuration file containing all fields.
       "copy_target": {
         "scale_down": false
       }
-    },
+    }
   },
   "operator": true,
   "kubeconfig": "~/.kube/config",
@@ -239,7 +239,7 @@ We provide sane defaults for this option, so you don't have to set up anything h
     "communication_timeout": 30,
     "startup_timeout": 360,
     "network_interface": "eth0",
-    "flush_connections": false,
+    "flush_connections": false
   }
 }
 ```
@@ -435,7 +435,7 @@ Complete setup:
 {
   "image": {
     "registry": "internal.repo/images/mirrord",
-    "tag": "latest",
+    "tag": "latest"
   }
 }
 ```
@@ -534,15 +534,15 @@ have support for a shortened version, that you can see [here](#root-shortened).
     },
     "fs": {
       "mode": "write",
-      "read_write": ".+\.json" ,
-      "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-      "local": [ ".+\.js", ".+\.mjs" ]
+      "read_write": ".+\\.json" ,
+      "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+      "local": [ ".+\\.js", ".+\\.mjs" ]
     },
     "network": {
       "incoming": {
         "mode": "steal",
         "http_filter": {
-          "header_filter": "host: api\..+"
+          "header_filter": "host: api\\..+"
         },
         "port_mapping": [[ 7777, 8888 ]],
         "ignore_localhost": false,
@@ -623,10 +623,10 @@ For more information, check the file operations
   "feature": {
     "fs": {
       "mode": "write",
-      "read_write": ".+\.json" ,
-      "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-      "local": [ ".+\.js", ".+\.mjs" ],
-      "not_found": [ "\.config/gcloud" ]
+      "read_write": ".+\\.json" ,
+      "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+      "local": [ ".+\\.js", ".+\\.mjs" ],
+      "not_found": [ "\\.config/gcloud" ]
     }
   }
 }
@@ -746,7 +746,7 @@ for more details.
       "incoming": {
         "mode": "steal",
         "http_filter": {
-          "header_filter": "host: api\..+"
+          "header_filter": "host: api\\..+"
         },
         "port_mapping": [[ 7777, 8888 ]],
         "ignore_localhost": false,
@@ -837,7 +837,7 @@ Steal only traffic that matches the
       "incoming": {
         "mode": "steal",
         "http_filter": {
-          "header_filter": "host: api\..+"
+          "header_filter": "host: api\\..+"
         },
         "port_mapping": [[ 7777, 8888 ]],
         "ignore_localhost": false,
@@ -932,7 +932,7 @@ set as `"steal"`, ignored otherwise.
 For example, to filter based on header:
 ```json
 {
-  "header_filter": "host: api\..+",
+  "header_filter": "host: api\\..+"
 }
 ```
 Setting that filter will make mirrord only steal requests with the `host` header set to hosts
@@ -941,7 +941,7 @@ that start with "api", followed by a dot, and then at least one more character.
 For example, to filter based on path:
 ```json
 {
-  "path_filter": "^/api/",
+  "path_filter": "^/api/"
 }
 ```
 Setting this filter will make mirrord only steal requests to URIs starting with "/api/".
@@ -951,7 +951,7 @@ This can be useful for filtering out Kubernetes liveness, readiness and startup
 For example, for avoiding stealing any probe sent by kubernetes, you can set this filter:
 ```json
 {
-  "header_filter": "^User-Agent: (?!kube-probe)",
+  "header_filter": "^User-Agent: (?!kube-probe)"
 }
 ```
 Setting this filter will make mirrord only steal requests that **do** have a user agent that
@@ -960,7 +960,7 @@ Setting this filter will make mirrord only steal requests that **do** have a use
 Similarly, you can exclude certain paths using a negative look-ahead:
 ```json
 {
-  "path_filter": "^(?!/health/)",
+  "path_filter": "^(?!/health/)"
 }
 ```
 Setting this filter will make mirrord only steal requests to URIs that do not start with
@@ -1135,7 +1135,11 @@ This option is compatible only with deployment targets.
 mirrord Experimental features.
 This shouldn't be used unless someone from MetalBear/mirrord tells you to.
 
-## experimental {#fexperimental-tcp_ping4_mock}
+## _experimental_ readlink {#fexperimental-readlink}
+
+Enables the `readlink` hook.
+
+## _experimental_ tcp_ping4_mock {#fexperimental-tcp_ping4_mock}
 
 <https://github.com/metalbear-co/mirrord/issues/2421#issuecomment-2093200904>
 
@@ -1150,7 +1154,7 @@ want to increase the timeouts a bit.
 {
   "internal_proxy": {
     "start_idle_timeout": 30,
-    "idle_timeout": 5,
+    "idle_timeout": 5
   }
 }
 ```

diff --git a/mirrord/config/src/agent.rs b/mirrord/config/src/agent.rs
@@ -63,7 +63,7 @@ impl fmt::Display for LinuxCapability {
 ///     "communication_timeout": 30,
 ///     "startup_timeout": 360,
 ///     "network_interface": "eth0",
-///     "flush_connections": false,
+///     "flush_connections": false
 ///   }
 /// }
 /// ```
@@ -132,7 +132,7 @@ pub struct AgentConfig {
     /// {
     ///   "image": {
     ///     "registry": "internal.repo/images/mirrord",
-    ///     "tag": "latest",
+    ///     "tag": "latest"
     ///   }
     /// }
     /// ```

diff --git a/mirrord/config/src/feature.rs b/mirrord/config/src/feature.rs
@@ -32,15 +32,15 @@ pub mod network;
 ///     },
 ///     "fs": {
 ///       "mode": "write",
-///       "read_write": ".+\.json" ,
-///       "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-///       "local": [ ".+\.js", ".+\.mjs" ]
+///       "read_write": ".+\\.json" ,
+///       "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+///       "local": [ ".+\\.js", ".+\\.mjs" ]
 ///     },
 ///     "network": {
 ///       "incoming": {
 ///         "mode": "steal",
 ///         "http_filter": {
-///           "header_filter": "host: api\..+"
+///           "header_filter": "host: api\\..+"
 ///         },
 ///         "port_mapping": [[ 7777, 8888 ]],
 ///         "ignore_localhost": false,

diff --git a/mirrord/config/src/feature/fs.rs b/mirrord/config/src/feature/fs.rs
@@ -46,9 +46,9 @@ pub mod mode;
 ///   "feature": {
 ///     "fs": {
 ///       "mode": "write",
-///       "read_write": ".+\.json" ,
-///       "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-///       "local": [ ".+\.js", ".+\.mjs" ]
+///       "read_write": ".+\\.json" ,
+///       "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+///       "local": [ ".+\\.js", ".+\\.mjs" ]
 ///     }
 ///   }
 /// }

diff --git a/mirrord/config/src/feature/fs/advanced.rs b/mirrord/config/src/feature/fs/advanced.rs
@@ -65,10 +65,10 @@ use crate::{
 ///   "feature": {
 ///     "fs": {
 ///       "mode": "write",
-///       "read_write": ".+\.json" ,
-///       "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-///       "local": [ ".+\.js", ".+\.mjs" ],
-///       "not_found": [ "\.config/gcloud" ]
+///       "read_write": ".+\\.json" ,
+///       "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+///       "local": [ ".+\\.js", ".+\\.mjs" ],
+///       "not_found": [ "\\.config/gcloud" ]
 ///     }
 ///   }
 /// }

diff --git a/mirrord/config/src/feature/network.rs b/mirrord/config/src/feature/network.rs
@@ -23,7 +23,7 @@ pub mod outgoing;
 ///       "incoming": {
 ///         "mode": "steal",
 ///         "http_filter": {
-///           "header_filter": "host: api\..+"
+///           "header_filter": "host: api\\..+"
 ///         },
 ///         "port_mapping": [[ 7777, 8888 ]],
 ///         "ignore_localhost": false,

diff --git a/mirrord/config/src/feature/network/incoming.rs b/mirrord/config/src/feature/network/incoming.rs
@@ -54,7 +54,7 @@ use http_filter::*;
 ///       "incoming": {
 ///         "mode": "steal",
 ///         "http_filter": {
-///           "header_filter": "host: api\..+"
+///           "header_filter": "host: api\\..+"
 ///         },
 ///         "port_mapping": [[ 7777, 8888 ]],
 ///         "ignore_localhost": false,
@@ -293,7 +293,7 @@ pub struct IncomingAdvancedFileConfig {
 ///       "incoming": {
 ///         "mode": "steal",
 ///         "http_filter": {
-///           "header_filter": "host: api\..+"
+///           "header_filter": "host: api\\..+"
 ///         },
 ///         "port_mapping": [[ 7777, 8888 ]],
 ///         "ignore_localhost": false,

diff --git a/mirrord/config/src/feature/network/incoming/http_filter.rs b/mirrord/config/src/feature/network/incoming/http_filter.rs
@@ -22,7 +22,7 @@ use crate::{
 /// For example, to filter based on header:
 /// ```json
 /// {
-///   "header_filter": "host: api\..+",
+///   "header_filter": "host: api\\..+"
 /// }
 /// ```
 /// Setting that filter will make mirrord only steal requests with the `host` header set to hosts
@@ -31,7 +31,7 @@ use crate::{
 /// For example, to filter based on path:
 /// ```json
 /// {
-///   "path_filter": "^/api/",
+///   "path_filter": "^/api/"
 /// }
 /// ```
 /// Setting this filter will make mirrord only steal requests to URIs starting with "/api/".
@@ -41,7 +41,7 @@ use crate::{
 /// For example, for avoiding stealing any probe sent by kubernetes, you can set this filter:
 /// ```json
 /// {
-///   "header_filter": "^User-Agent: (?!kube-probe)",
+///   "header_filter": "^User-Agent: (?!kube-probe)"
 /// }
 /// ```
 /// Setting this filter will make mirrord only steal requests that **do** have a user agent that
@@ -50,7 +50,7 @@ use crate::{
 /// Similarly, you can exclude certain paths using a negative look-ahead:
 /// ```json
 /// {
-///   "path_filter": "^(?!/health/)",
+///   "path_filter": "^(?!/health/)"
 /// }
 /// ```
 /// Setting this filter will make mirrord only steal requests to URIs that do not start with

diff --git a/mirrord/config/src/internal_proxy.rs b/mirrord/config/src/internal_proxy.rs
@@ -13,7 +13,7 @@ use crate::config::source::MirrordConfigSource;
 /// {
 ///   "internal_proxy": {
 ///     "start_idle_timeout": 30,
-///     "idle_timeout": 5,
+///     "idle_timeout": 5
 ///   }
 /// }
 /// ```

diff --git a/mirrord/config/src/lib.rs b/mirrord/config/src/lib.rs
@@ -113,15 +113,15 @@ use crate::{
 ///     },
 ///     "fs": {
 ///       "mode": "write",
-///       "read_write": ".+\.json" ,
-///       "read_only": [ ".+\.yaml", ".+important-file\.txt" ],
-///       "local": [ ".+\.js", ".+\.mjs" ]
+///       "read_write": ".+\\.json" ,
+///       "read_only": [ ".+\\.yaml", ".+important-file\\.txt" ],
+///       "local": [ ".+\\.js", ".+\\.mjs" ]
 ///     },
 ///     "network": {
 ///       "incoming": {
 ///         "mode": "steal",
 ///         "http_filter": {
-///           "header_filter": "host: api\..+"
+///           "header_filter": "host: api\\..+"
 ///         },
 ///         "port_mapping": [[ 7777, 8888 ]],
 ///         "ignore_localhost": false,
@@ -140,7 +140,7 @@ use crate::{
 ///       "copy_target": {
 ///         "scale_down": false
 ///       }
-///     },
+///     }
 ///   },
 ///   "operator": true,
 ///   "kubeconfig": "~/.kube/config",