Updated schema and configuration.md

metalbear-co · Jan 28, 2025 · 693dc5b · 693dc5b
1 parent be0797e
commit 693dc5b
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 2 deletions.
diff --git a/mirrord-schema.json b/mirrord-schema.json
@@ -284,7 +284,7 @@
         },
         "disabled_capabilities": {
           "title": "agent.disabled_capabilities {#agent-disabled_capabilities}",
-          "description": "Disables specified Linux capabilities for the agent container. If nothing is disabled here, agent uses `NET_ADMIN`, `NET_RAW`, `SYS_PTRACE` and `SYS_ADMIN`.",
+          "description": "Disables specified Linux capabilities for the agent container. If nothing is disabled here, agent uses `NET_ADMIN`, `NET_RAW`, `SYS_PTRACE` and `SYS_ADMIN`.\n\nHas no effect when using the targetless mode, as targetless agent containers have no capabilities.",
           "type": [
             "array",
             "null"
@@ -423,7 +423,7 @@
         },
         "privileged": {
           "title": "agent.privileged {#agent-privileged}",
-          "description": "Run the mirror agent as privileged container. Defaults to `false`.\n\nMight be needed in strict environments such as Bottlerocket.",
+          "description": "Run the mirror agent as privileged container. Defaults to `false`.\n\nMight be needed in strict environments such as Bottlerocket.\n\nHas no effect when using the targetless mode, as targetless agent containers are never privileged.",
           "type": [
             "boolean",
             "null"

diff --git a/mirrord/config/configuration.md b/mirrord/config/configuration.md
@@ -196,6 +196,9 @@ Disables specified Linux capabilities for the agent container.
 If nothing is disabled here, agent uses `NET_ADMIN`, `NET_RAW`, `SYS_PTRACE` and
 `SYS_ADMIN`.
 
+Has no effect when using the targetless mode,
+as targetless agent containers have no capabilities.
+
 ### agent.dns {#agent-dns}
 
 ### agent.ephemeral {#agent-ephemeral}
@@ -355,6 +358,9 @@ Defaults to `false`.
 
 Might be needed in strict environments such as Bottlerocket.
 
+Has no effect when using the targetless mode,
+as targetless agent containers are never privileged.
+
 ### agent.resources {#agent-resources}
 
 Set pod resource reqirements. (not with ephemeral agents)

diff --git a/mirrord/config/src/agent.rs b/mirrord/config/src/agent.rs
@@ -236,6 +236,9 @@ pub struct AgentConfig {
     /// Disables specified Linux capabilities for the agent container.
     /// If nothing is disabled here, agent uses `NET_ADMIN`, `NET_RAW`, `SYS_PTRACE` and
     /// `SYS_ADMIN`.
+    /// 
+    /// Has no effect when using the targetless mode,
+    /// as targetless agent containers have no capabilities.
     pub disabled_capabilities: Option<Vec<LinuxCapability>>,
 
     /// ### agent.tolerations {#agent-tolerations}
@@ -291,6 +294,9 @@ pub struct AgentConfig {
     /// Defaults to `false`.
     ///
     /// Might be needed in strict environments such as Bottlerocket.
+    /// 
+    /// Has no effect when using the targetless mode,
+    /// as targetless agent containers are never privileged.
     #[config(default = false)]
     pub privileged: bool,