summaryrefslogtreecommitdiffstats
path: root/lib
diff options
context:
space:
mode:
authornfagerlund <nick.fagerlund@gmail.com>2011-08-10 17:22:43 -0700
committernfagerlund <nick.fagerlund@gmail.com>2011-08-10 17:27:44 -0700
commit39da99ddd734e405aa91cede01bade9395767f5f (patch)
treea914b527c070b8254c4f706a7afb8f053f734311 /lib
parent4146a33c3f04f5e3783931e1aa36d1f1ab5c22e6 (diff)
downloadpuppet-39da99ddd734e405aa91cede01bade9395767f5f.tar.gz
puppet-39da99ddd734e405aa91cede01bade9395767f5f.tar.xz
puppet-39da99ddd734e405aa91cede01bade9395767f5f.zip
(#4411) Explain that runinterval = 0 does not mean "never run"
Unlike several other tools that accept a number of seconds between runs, puppet agent doesn't use 0 as a special value representing "never;" instead, it takes this as an instruction to run continuously. As this has caused some user confusion, this commit updates runinterval's description to explain this, and points to the correct method to make puppet agent do nothing.
Diffstat (limited to 'lib')
-rw-r--r--lib/puppet/defaults.rb5
1 files changed, 4 insertions, 1 deletions
diff --git a/lib/puppet/defaults.rb b/lib/puppet/defaults.rb
index 2247634b3..d714305b3 100644
--- a/lib/puppet/defaults.rb
+++ b/lib/puppet/defaults.rb
@@ -545,7 +545,10 @@ module Puppet
:puppetport => [8139, "Which port puppet agent listens on."],
:noop => [false, "Whether puppet agent should be run in noop mode."],
:runinterval => [1800, # 30 minutes
- "How often puppet agent applies the client configuration; in seconds."],
+ "How often puppet agent applies the client configuration; in seconds.
+ Note that a runinterval of 0 means \"run continuously\" rather than
+ \"never run.\" If you want puppet agent to never run, you should start
+ it with the `--no-client` option."],
:listen => [false, "Whether puppet agent should listen for
connections. If this is true, then puppet agent will accept incoming
REST API requests, subject to the default ACLs and the ACLs set in