From cb329089a423d04f77675023eec3b0fd4e13c1ff Mon Sep 17 00:00:00 2001 From: Hannah Oppenheimer Date: Wed, 5 Dec 2018 14:40:48 -0600 Subject: [PATCH] Docs: clarify output vs notes fixup --- website/source/docs/agent/checks.html.md | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/website/source/docs/agent/checks.html.md b/website/source/docs/agent/checks.html.md index 45a546b832..19199e83a3 100644 --- a/website/source/docs/agent/checks.html.md +++ b/website/source/docs/agent/checks.html.md @@ -234,9 +234,8 @@ generated. Otherwise, `id` will be set to `name`. If names might conflict, unique IDs should be provided. The `notes` field is opaque to Consul but can be used to provide a human-readable -description of the current state of the check. With a script check, the field is -set to any output generated by the script. Similarly, an external process updating -a TTL check via the HTTP interface can set the `notes` value. +description of the current state of the check. Similarly, an external process +updating a TTL check via the HTTP interface can set the `notes` value. Checks may also contain a `token` field to provide an ACL token. This token is used for any interaction with the catalog for the check, including @@ -278,8 +277,7 @@ this convention: * Any other code - Check is failing This is the only convention that Consul depends on. Any output of the script -will be captured and stored in the `notes` field so that it can be viewed -by human operators. +will be captured and stored in the `output` field. In Consul 0.9.0 and later, the agent must be configured with [`enable_script_checks`](/docs/agent/options.html#_enable_script_checks) set to `true`