Doc: Environment variables cannot be in config.string comments due to…

… substitution logic.
elastic · Nov 18, 2024 · 6820d47 · 6820d47
1 parent a94659c
commit 6820d47
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 1 deletion.
diff --git a/docs/static/env-vars.asciidoc b/docs/static/env-vars.asciidoc
@@ -12,6 +12,7 @@ environment variable is undefined.
 * You can add environment variable references in any plugin option type: string, number, boolean, array, or hash.
 * Environment variables for list-type URI parameters can support lists of space-delimited values. Currently, other non-URI based options do not support lists of values. See <<plugin-concepts>>
 * Environment variables are immutable. If you update the environment variable, you'll have to restart Logstash to pick up the updated value.
+* Environment variables in `config.string` comments are not allowed. Remove the `$` sign to avoid pipeline config failures.
 
 ==== Examples
 

diff --git a/docs/static/pipeline-configuration.asciidoc b/docs/static/pipeline-configuration.asciidoc
@@ -310,7 +310,7 @@ input { # comments can appear at the end of a line, too
   # ...
 }
 ----------------------------------
-
+NOTE: Due to a substitution logic, commenting environment `${var}` in `config.string` is not allowed. Remove the `$` sign to avoid pipeline config failures.
 
 include::event-data.asciidoc[]
 include::env-vars.asciidoc[]
-Original file line number
+Diff line change
@@ Expand Up / @@ -310,7 +310,7 @@ input { # comments can appear at the end of a line, too @@
       # ...
     }
     ----------------------------------
+    NOTE: Due to a substitution logic, commenting environment `${var}` in `config.string` is not allowed. Remove the `$` sign to avoid pipeline config failures.
     include::event-data.asciidoc[]
     include::env-vars.asciidoc[]
@@ Expand Down @@