From 0a19fdd10adbb9a7df383330df97a19720dc828d Mon Sep 17 00:00:00 2001 From: Armon Dadgar Date: Sat, 22 Feb 2014 18:53:31 -0800 Subject: [PATCH] website: document registering checks and services better. Fixes #6 --- website/source/docs/agent/checks.html.markdown | 6 ++++++ website/source/docs/agent/options.html.markdown | 3 ++- website/source/docs/agent/services.html.markdown | 6 ++++++ 3 files changed, 14 insertions(+), 1 deletion(-) diff --git a/website/source/docs/agent/checks.html.markdown b/website/source/docs/agent/checks.html.markdown index 64547fc278..4110c75237 100644 --- a/website/source/docs/agent/checks.html.markdown +++ b/website/source/docs/agent/checks.html.markdown @@ -60,6 +60,12 @@ readable descriptions. The field is set to any output that a script generates, and similarly the TTL update hooks can update the `notes` as well. +To configure a check, either provide it as a `-config-file` option to the +agent, or place it inside the `-config-dir` of the agent. The file must +end in the ".json" extension to be loaded by Consul. Check definitions can +also be updated by sending a `SIGHUP` to the agent. Alternatively, the +check can be registered dynamically using the [HTTP API](/docs/agent/http.html). + ## Check Scripts A check script is generally free to do anything to determine the status diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index 654219007f..099d0ce90e 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -132,7 +132,8 @@ Configuration files are used for more than just setting up the agent, they are also used to provide check and service definitions. These are used to announce the availability of system servers to the rest of the cluster. They are documented seperately under [check configuration](/docs/agent/checks.html) and -[service configuration](/docs/agent/services.html) respectively. +[service configuration](/docs/agent/services.html) respectively. The service and check +definitions support being updated during a reload. #### Example Configuration File diff --git a/website/source/docs/agent/services.html.markdown b/website/source/docs/agent/services.html.markdown index c61fb63cc2..19d8cbed09 100644 --- a/website/source/docs/agent/services.html.markdown +++ b/website/source/docs/agent/services.html.markdown @@ -52,3 +52,9 @@ check must be of the script or TTL type. If it is a script type, `script` and `interval` must be provided. If it is a TTL type, then only `ttl` must be provided. The check name is automatically generated as "service:". +To configure a service, either provide it as a `-config-file` option to the +agent, or place it inside the `-config-dir` of the agent. The file must +end in the ".json" extension to be loaded by Consul. Check definitions can +also be updated by sending a `SIGHUP` to the agent. Alternatively, the +service can be registered dynamically using the [HTTP API](/docs/agent/http.html). +