defaults.rb in puppet-3.2.3.rc1

- old
+ new

@@ -6,10 +6,13 @@
   ############################################################################################
   # NOTE: For information about the available values for the ":type" property of settings,
   #   see the docs for Settings.define_settings
   ############################################################################################
 
+  AS_DURATION = %q{This setting can be a time interval in seconds (30 or 30s), minutes (30m), hours (6h), days (2d), or years (5y).}
+  STORECONFIGS_ONLY = %q{This setting is only used by the ActiveRecord storeconfigs and inventory backends, which are deprecated.}
+
   define_settings(:main,
     :confdir  => {
         :default  => nil,
         :type     => :directory,
         :desc     =>
@@ -289,11 +292,11 @@
     :filetimeout => {
       :default    => "15s",
       :type       => :duration,
       :desc       => "The minimum time to wait between checking for updates in
       configuration files.  This timeout determines how quickly Puppet checks whether
-      a file (such as manifests or templates) has changed on disk. Can be specified as a duration.",
+      a file (such as manifests or templates) has changed on disk. #{AS_DURATION}",
     },
     :queue_type => {
       :default    => "stomp",
       :desc       => "Which type of queue to use for asynchronous processing.",
     },
@@ -576,11 +579,11 @@
     },
     :certificate_expire_warning => {
       :default  => "60d",
       :type     => :duration,
       :desc     => "The window of time leading up to a certificate's expiration that a notification
-        will be logged. This applies to CA, master, and agent certificates. Can be specified as a duration."
+        will be logged. This applies to CA, master, and agent certificates. #{AS_DURATION}"
     }
   )
 
     define_settings(
     :ca,
@@ -683,11 +686,11 @@
     },
     :ca_ttl => {
       :default    => "5y",
       :type       => :duration,
       :desc       => "The default TTL for new certificates. If this setting is set, ca_days is ignored.
-      Can be specified as a duration."
+      #{AS_DURATION}"
     },
     :req_bits => {
       :default    => 4096,
       :desc       => "The bit length of the certificates.",
     },
@@ -902,11 +905,11 @@
     },
     :rrdinterval => {
       :default  => "$runinterval",
       :type     => :duration,
       :desc     => "How often RRD should expect data.
-            This should match how often the hosts report back to the server. Can be specified as a duration.",
+            This should match how often the hosts report back to the server. #{AS_DURATION}",
     }
   )
 
   define_settings(:device,
     :devicedir =>  {
@@ -1023,14 +1026,14 @@
       :desc       => "Whether puppet agent should be run in noop mode.",
     },
     :runinterval => {
       :default  => "30m",
       :type     => :duration,
-      :desc     => "How often puppet agent applies the client configuration; in seconds.
+      :desc     => "How often puppet agent applies the catalog.
           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. Can be specified as a duration.",
+          it with the `--no-client` option. #{AS_DURATION}",
     },
     :listen => {
       :default    => false,
       :type       => :boolean,
       :desc       => "Whether puppet agent should listen for
@@ -1123,11 +1126,11 @@
     },
     :splaylimit => {
       :default    => "$runinterval",
       :type       => :duration,
       :desc       => "The maximum time to delay before runs.  Defaults to being the same as the
-      run interval. Can be specified as a duration.",
+      run interval. #{AS_DURATION}",
     },
     :splay => {
       :default    => false,
       :type       => :boolean,
       :desc       => "Whether to sleep for a pseudo-random (but consistent) amount of time before
@@ -1142,11 +1145,11 @@
     :configtimeout => {
       :default  => "2m",
       :type     => :duration,
       :desc     => "How long the client should wait for the configuration to be retrieved
       before considering it a failure.  This can help reduce flapping if too
-      many clients contact the server at one time. Can be specified as a duration.",
+      many clients contact the server at one time. #{AS_DURATION}",
     },
     :report_server => {
       :default  => "$server",
       :desc     => "The server to send transaction reports to.",
     },
@@ -1202,14 +1205,23 @@
       compression, but if it supports it, this setting might reduce performance on high-speed LANs.",
     },
     :waitforcert => {
       :default  => "2m",
       :type     => :duration,
-      :desc     => "The time interval 'puppet agent' should connect to the server
-      and ask it to sign a certificate request. This is useful for the initial setup of a
-      puppet client. You can turn off waiting for certificates by specifying a time of 0.
-      Can be specified as a duration.",
+      :desc     => "How frequently puppet agent should ask for a signed certificate.
+
+      When starting for the first time, puppet agent will submit a certificate
+      signing request (CSR) to the server named in the `ca_server` setting
+      (usually the puppet master); this may be autosigned, or may need to be
+      approved by a human, depending on the CA server's configuration.
+
+      Puppet agent cannot apply configurations until its approved certificate is
+      available. Since the certificate may or may not be available immediately,
+      puppet agent will repeatedly try to fetch it at this interval. You can
+      turn off waiting for certificates by specifying a time of 0, in which case
+      puppet agent will exit if it cannot get a cert.
+      #{AS_DURATION}",
     }
   )
 
   define_settings(:inspect,
     :archive_files => {
@@ -1294,79 +1306,79 @@
       :default  => "$statedir/clientconfigs.sqlite3",
       :type     => :file,
       :mode     => 0660,
       :owner    => "service",
       :group    => "service",
-      :desc     => "The database cache for client configurations.  Used for
-        querying within the language."
+      :desc     => "The sqlite database file. #{STORECONFIGS_ONLY}"
     },
     :dbadapter => {
       :default  => "sqlite3",
-      :desc     => "The type of database to use.",
+      :desc     => "The type of database to use. #{STORECONFIGS_ONLY}",
     },
     :dbmigrate => {
       :default  => false,
       :type     => :boolean,
-      :desc     => "Whether to automatically migrate the database.",
+      :desc     => "Whether to automatically migrate the database. #{STORECONFIGS_ONLY}",
     },
     :dbname => {
       :default  => "puppet",
-      :desc     => "The name of the database to use.",
+      :desc     => "The name of the database to use. #{STORECONFIGS_ONLY}",
     },
     :dbserver => {
       :default  => "localhost",
       :desc     => "The database server for caching. Only
       used when networked databases are used.",
     },
     :dbport => {
       :default  => "",
       :desc     => "The database password for caching. Only
-      used when networked databases are used.",
+      used when networked databases are used. #{STORECONFIGS_ONLY}",
     },
     :dbuser => {
       :default  => "puppet",
       :desc     => "The database user for caching. Only
-      used when networked databases are used.",
+      used when networked databases are used. #{STORECONFIGS_ONLY}",
     },
     :dbpassword => {
       :default  => "puppet",
       :desc     => "The database password for caching. Only
-      used when networked databases are used.",
+      used when networked databases are used. #{STORECONFIGS_ONLY}",
     },
     :dbconnections => {
       :default  => '',
       :desc     => "The number of database connections for networked
-      databases.  Will be ignored unless the value is a positive integer.",
+      databases.  Will be ignored unless the value is a positive integer. #{STORECONFIGS_ONLY}",
     },
     :dbsocket => {
       :default  => "",
       :desc     => "The database socket location. Only used when networked
-      databases are used.  Will be ignored if the value is an empty string.",
+      databases are used.  Will be ignored if the value is an empty string. #{STORECONFIGS_ONLY}",
     },
     :railslog => {
       :default  => "$logdir/rails.log",
       :type     => :file,
       :mode     => 0600,
       :owner    => "service",
       :group    => "service",
-      :desc     => "Where Rails-specific logs are sent"
+      :desc     => "Where Rails-specific logs are sent. #{STORECONFIGS_ONLY}"
     },
 
     :rails_loglevel => {
         :default  => "info",
         :desc     => "The log level for Rails connections.  The value must be
             a valid log level within Rails.  Production environments normally use `info`
-            and other environments normally use `debug`.",
+            and other environments normally use `debug`. #{STORECONFIGS_ONLY}",
     }
   )
 
     define_settings(
     :couchdb,
 
     :couchdb_url => {
         :default  => "http://127.0.0.1:5984/puppet",
-        :desc     => "The url where the puppet couchdb database will be created",
+        :desc     => "The url where the puppet couchdb database will be created.
+        Only used when `facts_terminus` is set to `couch`.",
     }
   )
 
     define_settings(
     :transaction,
@@ -1572,9 +1584,10 @@
   )
   define_settings(:puppetdoc,
     :document_all => {
         :default  => false,
         :type     => :boolean,
-        :desc     => "Document all resources",
+        :desc     => "Whether to document all resources when using `puppet doc` to
+        generate manifest documentation.",
     }
   )
 end