Add a documentation item about $ resoltion in configs (#17621)

* init commit, try to add asciidoc with link * fix misc errors * add extra newline to fix asciidoc Co-Authored-By: DeDe Morton <[email protected]> * Fix conditional section Co-authored-by: DeDe Morton <[email protected]>
elastic · Apr 13, 2020 · 0e3d439 · 0e3d439
1 parent fd3a26c
commit 0e3d439
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 0 deletions.
diff --git a/libbeat/docs/index.asciidoc b/libbeat/docs/index.asciidoc
@@ -15,6 +15,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :discuss_forum: beats/{beatname_lc}
 :beat_default_index_prefix: {beatname_lc}
 :has_ml_jobs:
+:no_keystore:
 
 include::{libbeat-dir}/shared-beats-attributes.asciidoc[]
 

diff --git a/libbeat/docs/yaml.asciidoc b/libbeat/docs/yaml.asciidoc
@@ -94,3 +94,21 @@ to an integer. If not, it's converted to a float.
 To prevent unwanted type conversions, avoid using leading zeros in field values,
 or wrap the values in single quotation marks.
 
+[float]
+[[dollar-sign-strings]]
+=== Avoid accidental template variable resolution
+
+The templating engine that allows the config to resolve data from environment 
+variables can result in errors in strings with `$` characters. For example, if a 
+password field contains `$$`, the engine will resolve this to `$`.
+
+To work around this,
+either use the
+ifdef::no_keystore[]
+{filebeat-ref}/keystore.html[keystore]
+endif::[]
+ifndef::no_keystore[]
+<<keystore>>
+endif::[]
+or escape all instances of
+`$` with `$$`.
diff --git a/x-pack/functionbeat/docs/index.asciidoc b/x-pack/functionbeat/docs/index.asciidoc
@@ -33,6 +33,7 @@ include::{asciidoc-dir}/../../shared/attributes.asciidoc[]
 :no_decode_csv_fields_processor:
 :no_script_processor:
 :no_timestamp_processor:
+:no_keystore:
 
 include::{libbeat-dir}/shared-beats-attributes.asciidoc[]