From 58ba650cb0545a8e58fdac70d2919bbb79b76100 Mon Sep 17 00:00:00 2001 From: Ryan Uber Date: Tue, 25 Nov 2014 19:03:14 -0800 Subject: [PATCH] website: Improve docs for reloading config. Fixes #407 --- website/source/docs/agent/options.html.markdown | 17 +++++++++++++++-- .../source/docs/commands/reload.html.markdown | 6 ++++++ 2 files changed, 21 insertions(+), 2 deletions(-) diff --git a/website/source/docs/agent/options.html.markdown b/website/source/docs/agent/options.html.markdown index ece3157a3..980d3cd90 100644 --- a/website/source/docs/agent/options.html.markdown +++ b/website/source/docs/agent/options.html.markdown @@ -22,8 +22,10 @@ The exact merging behavior will be specified. Consul also supports reloading of configuration when it receives the SIGHUP signal. Not all changes are respected, but those that are -are documented below. The [reload command](/docs/commands/reload.html) -can also be used to trigger a configuration reload. +are documented below in the +[Reloadable Configuration](#reloadable-configuration) section. The +[reload command](/docs/commands/reload.html) can also be used to trigger a +configuration reload. ## Command-line Options @@ -439,3 +441,14 @@ port. * DNS Interface (Default 8600). Used to resolve DNS queries. TCP and UDP. +## Reloadable Configuration + + +Reloading configuration does not reload all configuration items. The +items which are reloaded include: + +* Log level +* Checks +* Services +* Watches +* HTTP Client Address diff --git a/website/source/docs/commands/reload.html.markdown b/website/source/docs/commands/reload.html.markdown index ca1e5aa4d..b00a0120a 100644 --- a/website/source/docs/commands/reload.html.markdown +++ b/website/source/docs/commands/reload.html.markdown @@ -19,6 +19,12 @@ This command operates the same as the signal, meaning that it will trigger a reload, but does not wait for the reload to complete. Any errors with the reload will be present in the agent logs and not in the output of this command. +**NOTE** + +Not all configuration options are reloadable. See the +[Reloadable Configuration](/docs/agent/options.html#reloadable-configuration) +section on the agent options page for details on which options are supported. + ## Usage Usage: `consul reload`